gyro 0.4.0

data/lib/gyro/realm/swift/generator.rb

@@ -0,0 +1,265 @@
+=begin
+Copyright 2016 - Niji
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+require File.expand_path('../../utils/log', File.dirname(__FILE__))
+require File.expand_path('../../utils/string_xcdatamodel', File.dirname(__FILE__))
+require File.expand_path('../../utils/file_utils', File.dirname(__FILE__))
+require File.expand_path('../../xcdatamodel/parser/relationship', File.dirname(__FILE__))
+require File.expand_path('converter', File.dirname(__FILE__))
+require File.expand_path('enum_generator', File.dirname(__FILE__))
+require File.expand_path('templates', File.dirname(__FILE__))
+require File.expand_path('object_mapper_generator', File.dirname(__FILE__))
+
+module Gyro
+  module Realm
+    module Swift
+
+      class Generator
+
+        # INCLUDES #############################################################
+
+        include Gyro::XCDataModel::Parser
+        include Converter
+        include EnumGenerator
+        include Templates
+        include ObjectMapperGenerator
+
+        # PUBLIC METHODS #######################################################
+
+        def initialize(path, xcdatamodel, json = false)
+          puts "\n"
+          Gyro::Log::title('Swift Realm')
+          xcdatamodel.entities.each do |_, entity|
+            unless entity.abstract?
+              Gyro::Log::success("Generating entity #{entity.name}...")
+              generate_class(path, entity, json)
+              generate_object_mapper_categories(path, xcdatamodel) if json
+            end
+          end
+        end
+
+        private ################################################################
+
+        def generate_class(path, entity, json)
+          class_file = String.new
+          entity.name = entity.name.delete_objc_prefix
+          class_file << generate_header(entity)
+          class_file << generate_attributes(entity.attributes, entity.relationships, json)
+          class_file << generate_inverse_properties(entity)
+          class_file << generate_primary_key(entity)
+          class_file << generate_indexed_properties(entity)
+          class_file << generate_ignored_properties(entity)
+          class_file << '}' + "\n"
+          Gyro.write_file_with_name(path, SWIFT_FILE_TEMPLATE%[entity.name], class_file)
+          generate_enums(path, entity.attributes)
+        end
+
+        def generate_header(entity)
+          class_file = String.new
+          class_file << GENERATED_MESSAGE + "\n\n"
+          class_file << IMPORT_REALM + "\n\n"
+          class_file << CLASS_COMMENT_TEMPLATE%[entity.comment] + "\n" unless entity.comment.empty?
+          class_file << CLASS_TEMPLATE%[entity.name] + "\n\n"
+          class_file << generate_constants(entity)
+        end
+
+        def generate_constants(entity)
+          attribute_constants = String.new
+          unless entity.attributes.empty?
+            attribute_constants << '    ' + ENUM_STRING_DEF_TEMPLATE%['Attributes'] + "\n"
+            entity.attributes.each do |_, attribute|
+              unless attribute.realm_ignored? or attribute.read_only?
+                attribute_constants << '        ' + ATTRIBUTE_COMMENT_TEMPLATE%[attribute.comment] + "\n" unless attribute.comment.empty?
+                attribute_constants << '        ' + ENUM_STRING_CASE_TEMPLATE%[attribute.name.capitalize_first_letter, attribute.name] + "\n"
+              end
+            end
+            attribute_constants << '    ' + '}'+ "\n\n"
+          end
+          relationship_constants = String.new
+          if not entity.relationships.empty? and not entity.has_only_inverse?
+            relationship_constants << '    ' + ENUM_STRING_DEF_TEMPLATE%['Relationships'] + "\n"
+            entity.relationships.each do |_, relationship|
+              relationship_constants << '        ' + ENUM_STRING_CASE_TEMPLATE%[relationship.name.capitalize_first_letter, relationship.name] + "\n" if not relationship.inverse?
+            end
+            relationship_constants << '    ' + '}'+ "\n\n"
+          end
+          attribute_constants + relationship_constants
+        end
+
+        def generate_attributes(attributes, relationships, json)
+          # "NORMAL" ATTRIBUTES
+          attributes_string = write_attributes(attributes, json)
+          # "RELATIONSHIP" ATTRIBUTES
+          relationships.each do |_, relationship|
+            unless relationship.inverse?
+              is_list = relationship.type == :to_many
+              name = relationship.name
+              type = relationship.inverse_type.delete_objc_prefix
+              if is_list
+                if json
+                  attributes_string << '    ' + PROPERTY_LIST_VAR_TEMPLATE%[name, type] + "\n"
+                else
+                  attributes_string << '    ' + PROPERTY_LIST_TEMPLATE%[name, type] + "\n"
+                end
+              else
+                attributes_string << '    ' + PROPERTY_OBJECT_TEMPLATE%[name, type] + "\n"
+              end
+            end
+          end
+          attributes_string + "\n"
+        end
+
+        def write_attributes(attributes, json)
+          attributes_string = String.new
+          attributes.each_with_index do |(_, attribute)|
+            unless attribute.read_only?
+              if attribute.enum?
+                attributes_string << write_enum_attribute(attribute, json)
+              else
+                if attribute.optional?
+                  attributes_string << write_optional_attribute(attribute, json) + "\n"
+                else
+                  default_value = convert_default(attribute.type, attribute.has_default? ? attribute.default : nil)
+                  attributes_string << '    ' + PROPERTY_DEFAULT_TEMPLATE%[attribute.name, convert_type(attribute.type), default_value] + "\n"
+                end
+              end
+            end
+          end
+          attributes_string
+        end
+
+        def write_optional_attribute(attribute, json)
+          optional_string = String.new
+          type = convert_type(attribute.type)
+          if attribute.is_number? or attribute.is_bool?
+            if json
+              optional_string << '    ' + PROPERTY_OPTIONAL_NUMBER_VAR_TEMPLATE%[attribute.name, type]
+            else
+              optional_string << '    ' + PROPERTY_OPTIONAL_NUMBER_TEMPLATE%[attribute.name, type]
+            end
+          else
+            optional_string << '    ' + PROPERTY_OPTIONAL_NON_NUMBER_TEMPLATE%[attribute.name, type]
+          end
+          optional_string
+        end
+
+        def write_enum_attribute(attribute, json)
+          enum_string = String.new
+          if attribute.optional?
+            enum_string << '    ' + PROPERTY_OPTIONAL_ENUM_TEMPLATE%[attribute.name] + "\n"
+          else
+            enum_string << '    ' + PROPERTY_ENUM_TEMPLATE%[attribute.name] + "\n"
+          end
+          enum_type = attribute.enum_type.delete_objc_prefix
+          enum_name = attribute.name + 'Enum'
+
+          enum_string << '    ' + PROPERTY_OPTIONAL_COMPUTED_TEMPLATE%[enum_name, enum_type] + "\n"
+          enum_string << '        ' + 'get {' + "\n"
+          if attribute.optional?
+            enum_string << '            ' + "guard let #{attribute.name} = #{attribute.name},\n"
+            enum_string << '            ' + "  let enumValue = #{enum_type}(rawValue: #{attribute.name})\n"
+            enum_string << '            ' + "  else { return nil }" + "\n"
+          else
+            enum_string << '            ' + "guard let enumValue = #{enum_type}(rawValue: #{attribute.name}) else { return nil }" + "\n"
+          end
+          enum_string << '            ' + "return enumValue" + "\n"
+          enum_string << '        ' + '}' + "\n"
+
+          if attribute.optional?
+            enum_string << '        ' + "set { #{attribute.name} = newValue?.rawValue ?? nil }" + "\n"
+          else 
+            enum_string << '        ' + "set { #{attribute.name} = newValue?.rawValue ?? \"\" }" + "\n"
+          end
+          enum_string << '    ' + '}' + "\n\n"
+        end
+
+        def generate_primary_key(entity)
+          primary_key = String.new
+          if entity.has_primary_key?
+            primary_key << '    ' + 'override static func primaryKey() -> String? {' + "\n"
+            primary_key << '        ' + "return #{entity.identity_attribute.add_quotes}" + "\n"
+            primary_key << '    ' + '}' + "\n\n"
+          end
+          primary_key
+        end
+
+        def generate_ignored_properties(entity)
+          ignored_properties = String.new
+          if entity.has_ignored?
+            ignored_properties << '    ' + "// Specify properties to ignore (Realm won't persist these)" + "\n"
+            ignored_properties << '    ' +'override static func ignoredProperties() -> [String] {' + "\n"
+            ignored_properties << '        ' + 'return ['
+            entity.attributes.each do |_, attribute|
+              ignored_properties << ARRAY_TEMPLATE%[attribute.name.add_quotes] if attribute.realm_ignored?
+            end
+            entity.relationships.each do |_, relationship|
+              ignored_properties << ARRAY_TEMPLATE%[relationship.name.add_quotes] if relationship.realm_ignored?
+            end
+            ignored_properties = ignored_properties[0..ignored_properties.length - 3] # delete last coma
+            ignored_properties << ']' + "\n"
+            ignored_properties << '    ' + '}' + "\n\n"
+          end
+          ignored_properties
+        end
+
+        def generate_inverse_properties(entity)
+          inverse_properties = []
+          entity.relationships.each do |_, relationship|
+            if relationship.inverse?
+              if relationship.type == :to_many
+                inverse_properties << PROPERTY_INVERSE_MANY_TEMPLATE%[
+                  relationship.name.delete_inverse_suffix,
+                  relationship.inverse_type.delete_objc_prefix,
+                  relationship.inverse_name
+                ]
+              else
+                inverse_properties << PROPERTY_INVERSE_MANY_TEMPLATE%[
+                  relationship.name.delete_inverse_suffix + 's', # 's' for plural form
+                  relationship.inverse_type.delete_objc_prefix,
+                  relationship.inverse_name
+                ]
+                inverse_properties << PROPERTY_INVERSE_ONE_TEMPLATE%[
+                  relationship.name.delete_inverse_suffix,
+                  relationship.inverse_type.delete_objc_prefix,
+                  relationship.name.delete_inverse_suffix + 's' # 's' for plural form
+                ]
+              end
+            end
+          end
+          return '' if inverse_properties.empty?
+          inverse_properties.map { |value| "    #{value}\n" }.join + "\n"
+        end
+
+        def generate_indexed_properties(entity)
+          indexed_properties = String.new
+          if entity.has_indexed_attributes?
+            indexed_properties << '    ' + '// Specify properties to index' + "\n"
+            indexed_properties << '    ' +'override static func indexedProperties() -> [String] {' + "\n"
+            indexed_properties << '        ' + 'return ['
+            entity.attributes.each do |_, attribute|
+              indexed_properties << ARRAY_TEMPLATE%[attribute.name.add_quotes] if attribute.indexed?
+            end
+            indexed_properties = indexed_properties[0..indexed_properties.length - 3] # delete last coma
+            indexed_properties << ']' + "\n"
+            indexed_properties << '}' + "\n\n"
+          end
+          indexed_properties
+        end
+
+      end
+    end
+  end
+end

data/lib/gyro/realm/swift/object_mapper_generator.rb

@@ -0,0 +1,124 @@
+=begin
+Copyright 2016 - Niji
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+require File.expand_path('templates', File.dirname(__FILE__))
+require File.expand_path('../../utils/file_utils', File.dirname(__FILE__))
+require File.expand_path('../../utils/string_xcdatamodel', File.dirname(__FILE__))
+
+module Gyro
+  module Realm
+    module Swift
+      module ObjectMapperGenerator
+
+      	# INCLUDES #############################################################
+
+        include Templates
+
+        # PUBLIC METHODS #######################################################
+
+        def generate_object_mapper_categories(path, xcdatamodel, framework = false)
+          json_path = File.join(path, 'ObjectMapper')
+          Dir.mkdir(json_path) unless Dir.exists?(json_path)
+          xcdatamodel.entities.each do |_, entity|
+            generate_json_category_file(json_path, entity, framework)
+          end
+        end
+
+        # PRIVATE METHODS #######################################################
+
+        def generate_json_category_file(path, entity, framework)
+          if !entity.attributes.empty? || !entity.relationships.empty?
+            source_file = generate_source_extension_file(entity)
+            file_name = EXTENSION_NAME%[entity.name]
+            Gyro.write_file_with_name(path, SOURCE_TEMPLATE%[file_name], source_file) unless source_file.empty?
+          end
+        end
+
+        def generate_source_extension_file(entity)
+          source_file = String.new
+          source_file << GENERATED_MESSAGE + "\n\n"
+          source_file << IMPORT_OBJECT_MAPPER + "\n\n"
+          source_file << EXTENSION_TEMPLATE%[entity.name, "Mappable"] + "\n\n"
+          source_file << generate_init
+          source_file << generate_mapping(entity)
+          source_file << "}\n"
+          source_file
+        end
+
+        def generate_mapping(entity)
+          source_file = String.new
+          source_file << "  // MARK: Mappable\n\n"
+          source_file << "  func mapping(map: Map) {\n"
+          source_file << generate_mapper_attributes(entity) if !entity.attributes.empty?
+          source_file << generate_mapper_relationships(entity) if !entity.relationships.empty?
+          source_file << "  }\n"
+          source_file
+		    end
+
+        def generate_init()
+          source_file = String.new
+          source_file << "  // MARK: Initializers\n\n"
+          source_file << "  convenience init?(_ map: Map) {\n"
+          source_file << "    self.init()\n"
+          source_file << "  }\n\n"
+          source_file
+        end
+
+        def generate_mapper_attributes(entity)
+          attributes = String.new
+          attributes << "\n    // MARK: Attributes\n"
+          entity.attributes.each do |_, attribute|
+            attrKey = attribute.json_key_path.empty? ? attribute.name : attribute.json_key_path
+            case 
+              when attribute.type == :date
+                transformer = attribute.transformer.empty? ? "ISO8601DateTransform" : attribute.transformer
+                attributes << "    self." + attribute.name + " <- (map[" + attrKey.add_quotes + "], " + transformer + "())\n"
+              when attribute.type == :integer_16 && attribute.optional && attribute.enum_type == ""
+                attributes << "    self." + attribute.name + " <- (map[" + attrKey.add_quotes + "], RealmOptionalInt16Transform())\n"
+              when attribute.type == :integer_32 && attribute.optional
+                attributes << "    self." + attribute.name + " <- (map[" + attrKey.add_quotes + "], RealmOptionalInt32Transform())\n"
+              when attribute.type == :integer_64 && attribute.optional
+                attributes << "    self." + attribute.name + " <- (map[" + attrKey.add_quotes + "], RealmOptionalInt64Transform())\n"
+              when attribute.type == :float && attribute.optional
+                attributes << "    self." + attribute.name + " <- (map[" + attrKey.add_quotes + "], RealmOptionalFloatTransform())\n"
+              when attribute.type == :double && attribute.optional
+                attributes << "    self." + attribute.name + " <- (map[" + attrKey.add_quotes + "], RealmOptionalDoubleTransform())\n"
+              when 
+                attributes << "    self." + attribute.name + " <- map[" + attrKey.add_quotes + "]\n"
+            end
+          end
+          attributes
+        end
+
+        def generate_mapper_relationships(entity)
+          relationships = String.new
+          relationships << "\n    // MARK: Relationships\n"
+          entity.relationships.each do |_, relationship|
+            next if relationship.inverse?
+            relationKey = relationship.json_key_path.empty? ? relationship.name : relationship.json_key_path
+            if relationship.type == :to_many
+              relationships << "    self." + relationship.name + " <- (map[" + relationKey.add_quotes + "], ListTransform<" + relationship.inverse_type + ">())\n"
+            else 
+              relationships << "    self." + relationship.name + " <- map[" + relationKey.add_quotes + "]\n"
+            end
+          end
+          relationships
+        end
+
+      end
+    end
+  end
+end

data/lib/gyro/realm/swift/templates.rb

@@ -0,0 +1,64 @@
+=begin
+Copyright 2016 - Niji
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+=end
+
+module Gyro
+  module Realm
+    module Swift
+      module Templates
+
+        # COMMONS
+        GENERATED_MESSAGE = '/* DO NOT EDIT | Generated by gyro */'
+
+        # IMPORTS
+        IMPORT_REALM = 'import RealmSwift'
+        SWIFT_FILE_TEMPLATE = '%s.swift'
+        IMPORT_OBJECT_MAPPER = 'import ObjectMapper'
+
+        # ENUM
+        ENUM_STRING_DEF_TEMPLATE = 'enum %s: String {'
+        ENUM_STRING_CASE_TEMPLATE = 'case %s = "%s"'
+
+        # CLASS
+        ARRAY_TEMPLATE ='%s, '
+        CLASS_TEMPLATE = 'final class %s: Object {'
+        PROPERTY_DEFAULT_TEMPLATE = 'dynamic var %s: %s = %s'
+        PROPERTY_OBJECT_TEMPLATE = 'dynamic var %s: %s?'
+        PROPERTY_LIST_TEMPLATE = 'let %s = List<%s>()'
+        PROPERTY_LIST_VAR_TEMPLATE = 'var %s = List<%s>()'
+        PROPERTY_PRIVATE_ENUM_TEMPLATE = 'private dynamic var %s: String?'
+        PROPERTY_ENUM_TEMPLATE = 'dynamic var %s: String = ""'
+        PROPERTY_OPTIONAL_ENUM_TEMPLATE = 'dynamic var %s: String? = nil'
+        PROPERTY_COMPUTED_TEMPLATE = 'var %s: %s {'
+        PROPERTY_OPTIONAL_COMPUTED_TEMPLATE = 'var %s: %s? {'
+        PROPERTY_INVERSE_ONE_TEMPLATE = 'var %s: %s? { return %s.first }'
+        PROPERTY_INVERSE_MANY_TEMPLATE = 'let %s = LinkingObjects(fromType: %s.self, property: "%s")'
+        PROPERTY_OPTIONAL_NON_NUMBER_TEMPLATE = 'dynamic var %s: %s? = nil'
+        PROPERTY_OPTIONAL_NUMBER_TEMPLATE = 'let %s = RealmOptional<%s>()'
+        PROPERTY_OPTIONAL_NUMBER_VAR_TEMPLATE = 'var %s = RealmOptional<%s>()'
+
+        # EXTENSION
+        EXTENSION_TEMPLATE = 'extension %s: %s {'
+        EXTENSION_NAME = '%sMapper'
+        SOURCE_TEMPLATE = '%s.swift'
+
+        # COMMENTS
+        CLASS_COMMENT_TEMPLATE = "/**\n * %s\n */"
+        ATTRIBUTE_COMMENT_TEMPLATE = '/** %s */'
+
+      end
+    end
+  end
+end