gyro 0.4.0 → 1.0.0

data/lib/gyro/realm/objc/protocol_generator.rb

@@ -1,59 +0,0 @@
-=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('converter', File.dirname(__FILE__))
-require File.expand_path('../../utils/string_xcdatamodel', File.dirname(__FILE__))
-require File.expand_path('../../utils/file_utils', File.dirname(__FILE__))
-
-module Gyro
-  module Realm
-    module ObjC
-      module ProtocolGenerator
-
-        # INCLUDES #############################################################
-
-        include Templates
-        include Converter
-
-        # PUBLIC METHODS #######################################################
-
-        def generate_protocol_file(path, xcdatamodel)
-          content = String.new
-          xcdatamodel.entities.each do |_, entity|
-            unless entity.abstract?
-              if entity.used_as_list_by_other?(xcdatamodel.entities)
-                content << protocol_file_template if content.empty?
-                content << REALM_LIST_TYPE_TEMPLATE%[entity.name, entity.name] + "\n"
-              end
-            end
-          end
-          Gyro.write_file_with_name(path, HEADER_TEMPLATE%[PROTOCOL_FILE_NAME], content) unless content.empty?
-        end
-
-        private ################################################################
-
-        def protocol_file_template
-          content = String.new
-          content << GENERATED_MESSAGE + "\n"
-          content << "\n" + SEPARATOR + "\n\n"
-          content << PRAGMA_MARK_PROTOCOLS + "\n\n"
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,100 +0,0 @@
-=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 ObjC
-      module Templates
-
-        # IMPORTS
-        IMPORT_REALM = '#import <Realm/Realm.h>'
-        IMPORT_HEADER = '#import "%s.h"'
-        IMPORT_REALM_JSON_LIBRARY = '#import <Realm+JSON/RLMObject+JSON.h>'
-        IMPORT_REALM_JSON_FRAMEWORK = '#import "RLMObject+JSON.h"'
-
-
-        # PRAGMA
-        PRAGMA_MARK_IMPORTS = '#pragma mark - Imports'
-        PRAGMA_MARK_TYPES = '#pragma mark - Types'
-        PRAGMA_MARK_CONSTANTS = '#pragma mark - Defines & Constants'
-        PRAGMA_MARK_INTERFACE = '#pragma mark - Interface'
-        PRAGMA_MARK_PROPERTIES = '#pragma mark - Properties'
-        PRAGMA_MARK_PROTOCOLS = '#pragma mark - Protocols'
-        PRAGMA_MARK_IMPLEMENTATION = '#pragma mark - Implementation'
-        PRAGMA_MARK_NUMBER_ACCESSORS = '#pragma mark - NSNumber Convenience Accessors'
-        PRAGMA_MARK_SUPER = '#pragma mark - Superclass Overrides'
-
-        # COMMONS
-        GENERATED_MESSAGE = '// DO NOT EDIT | Generated by gyro'
-        END_CODE = '@end'
-        SEPARATOR = '////////////////////////////////////////////////////////////////////////////////'
-        DICTIONARY_JSON = '@%s : @%s,'
-        DICTIONARY_DEFAULT = '@%s : %s,'
-        DICTIONARY_JSON_CATEGORY = '%s : @%s,'
-
-        # HEADER
-        HEADER_TEMPLATE = '%s.h'
-        NUMBER_TRANSFORMER_FILE_NAME = 'NFNumberTransformer'
-        CLASS_COMMENT_TEMPLATE = "/**\n * %s\n */"
-        CLASS_TEMPLATE = '@class %s;'
-        INTERFACE_TEMPLATE = '@interface %s : RLMObject'
-        PROPERTY_COMMENT_TEMPLATE = '/** %s */'
-        SIMPLE_PROPERTY_TEMPLATE = '@property %s%s;'
-        OBJECT_PROPERTY_TEMPLATE = '@property %s *%s;'
-        NUMBER_ACCESSOR_DECL_TEMPLATES = "-(%s)%sValue;\n-(void)set%sValue:(%s)value;\n"
-        LIST_TEMPLATE = 'NSArray<%s>'
-        REALM_LIST_TYPE_TEMPLATE = "// This protocol enables typed collections. i.e.: RLMArray<%s>\nRLM_ARRAY_TYPE(%s)"
-        REALM_LIST_TEMPLATE = 'RLMArray<%s>'
-
-        # COMMONS
-        CONSTANT_ATTRIBUTES_NAME = '%sAttributes'
-        CONSTANT_RELATIONSHIPS_NAME = '%sRelationships'
-        CONSTANT_HEADER_ATTRIBUTES = 'extern const struct %s {'
-        CONSTANT_HEADER_RELATIONSHIPS = 'extern const struct %s {'
-        CONSTANT_HEADER_ITEM = '__unsafe_unretained NSString *%s;'
-        CONSTANT_SOURCE_ATTRIBUTES = 'const struct %s %s = {'
-        CONSTANT_SOURCE_RELATIONSHIPS = 'const struct %s %s = {'
-        CONSTANT_SOURCE_ITEM = '.%s = @"%s"'
-
-        # ENUM
-        ENUM_TYPEDEF_TEMPLATE = 'typedef NS_ENUM(%s, %s) {'
-        ENUM_FILE_NAME = 'RLMTypes'
-        PROTOCOL_FILE_NAME = 'RLMProtocols'
-
-        # SOURCE
-        SOURCE_TEMPLATE = '%s.m'
-        IMPLEMENTATION_TEMPLATE = '@implementation %s'
-        ARRAY_TEMPLATE ='@%s, '
-        READ_ONLY_DEF_TEMPLATE = '- (%s)%s'
-        NUMBER_ACCESSOR_SOURCE_TEMPLATES = "-(%s)%sValue\n{\n    return [self.%s %s];\n}\n-(void)set%sValue:(%s)value\n{\n    self.%s = @(value);\n}"
-        INVERSE_DEF_TEMPLATE = '- (%s *)%s'
-        INVERSE_MANY_TEMPLATE = 'return [self linkingObjectsOfClass:@"%s" forProperty:@"%s"];'
-        INVERSE_ONE_TEMPLATE = 'return [[self linkingObjectsOfClass:@"%s" forProperty:@"%s"] objectAtIndex:0];'
-
-        # JSON_CATEGORY
-        JSON_CATEGORY_NAME = '%s+JSON'
-        JSON_TRANSFORMER_DEF = '+ (NSValueTransformer *)%sJSONTransformer'
-        JSON_CATEGORY_IMPLEMENTATION = '@implementation %s (JSON)'
-        JSON_CATEGORY_INTERFACE = '@interface %s (JSON)'
-        TRANSFORMER_BOOL_JSON = ['@"null"', '[NSNull null]', '@"<null>"', '@"false"', '@"true"', '@(NO)', '@(YES)']
-        TRANSFORMER_BOOL_MODEL = %w(NO NO NO NO YES NO YES)
-        TRANSFORMER_ENUM_JSON = ['@"null"', '[NSNull null]', '@"<null>"', '@""']
-        TRANSFORMER = 'return [[%s alloc] init];'
-
-      end
-    end
-  end
-end

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

@@ -1,74 +0,0 @@
-=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 Converter
-
-        TYPES = {
-            :integer_16 => 'Int16',
-            :integer_32 => 'Int32',
-            :integer_64 => 'Int64',
-            :decimal => 'Double',
-            :double => 'Double',
-            :float => 'Float',
-            :string => 'String',
-            :boolean => 'Bool',
-            :date => 'NSDate',
-            :binary => 'NSData'
-        }
-
-        DEFAULTS = {
-            :integer_16 => '0',
-            :integer_32 => '0',
-            :integer_64 => '0',
-            :decimal => '0.0',
-            :double => '0.0',
-            :float => '0.0',
-            :string => '""',
-            :boolean => 'false',
-            :date => 'NSDate()',
-            :binary => 'NSData()'
-        }
-
-        def convert_type(type)
-          TYPES[type]
-        end
-
-        def convert_default(type, value = nil)
-          if value.nil?
-            return DEFAULTS[type]
-          end
-          # Do some conversions for some special types
-          case [type, value]
-            when [:boolean, 'YES']
-              return 'true'
-            when [:boolean, 'NO']
-              return 'false'
-            else
-              return value
-          end
-        end
-
-        def is_number?(type)
-          type != :string && type != :date && type != :binary
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,73 +0,0 @@
-=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/string_xcdatamodel', File.dirname(__FILE__))
-require File.expand_path('../../utils/file_utils', File.dirname(__FILE__))
-
-module Gyro
-  module Realm
-    module Swift
-      module EnumGenerator
-
-        # INCLUDES #############################################################
-
-        include Templates
-
-        # PUBLIC METHODS #######################################################
-
-        def generate_enums(path, attributes)
-          enums = Array.new
-          attributes.each do |_, attribute|
-            if attribute.enum? and !enums.include?(attribute.enum_type)
-              enum_type = attribute.enum_type.delete_objc_prefix
-              enums.push(enum_type)
-              generate_enum(path, enum_type, attribute.enum_values, attribute.json_values)
-            end
-          end
-        end
-
-        private ################################################################
-
-        def generate_enum(path, enum_name, enum_values, raw_values)
-          enum_file = String.new
-          enum_file << GENERATED_MESSAGE + "\n\n"
-          enum_file << ENUM_STRING_DEF_TEMPLATE%[enum_name] + "\n"
-          raw_values = raw_values(enum_values, raw_values)
-          if !enum_values.empty? and raw_values.length == enum_values.length
-            (0..enum_values.length - 1).each { |idx|
-              enum_value = enum_values[idx].delete_objc_prefix
-              raw_value = raw_values[idx]
-              enum_file << '    ' + ENUM_STRING_CASE_TEMPLATE%[enum_value, raw_value] + "\n"
-            }
-            enum_file << '}' + "\n"
-            Gyro.write_file_with_name(path, SWIFT_FILE_TEMPLATE%[enum_name], enum_file)
-          end
-        end
-
-        def raw_values(enum_values, raw_values)
-          if raw_values.empty?
-            raw_values = enum_values.map { |value|
-              value.delete_objc_prefix.underscore
-            }
-          end
-          raw_values
-        end
-
-      end
-    end
-  end
-end

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

@@ -1,265 +0,0 @@
-=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