gyro 0.4.0

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

@@ -0,0 +1,172 @@
+=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 ObjC
+      module JSONCategoryGenerator
+
+        # INCLUDES #############################################################
+
+        include Templates
+
+        # PUBLIC METHODS #######################################################
+
+        def generate_objc_categories(path, xcdatamodel, framework = false)
+          json_path = File.join(path, 'JSON')
+          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 #################################################################
+
+        def generate_json_category_file(path, entity, framework)
+          if !entity.attributes.empty? || !entity.relationships.empty?
+            source_file = generate_source_category_file(entity)
+            header_file = generate_header_category_file(entity, framework)
+            file_name = JSON_CATEGORY_NAME%[entity.name]
+            Gyro.write_file_with_name(path, HEADER_TEMPLATE%[file_name], header_file) unless header_file.empty?
+            Gyro.write_file_with_name(path, SOURCE_TEMPLATE%[file_name], source_file) unless source_file.empty?
+          end
+        end
+
+        def generate_header_category_file(entity, framework)
+          header_file = String.new
+          header_file << GENERATED_MESSAGE + "\n"
+          header_file << "\n" + SEPARATOR + "\n\n"
+          header_file << PRAGMA_MARK_IMPORTS + "\n\n"
+          header_file << (framework ? IMPORT_REALM_JSON_FRAMEWORK : IMPORT_REALM_JSON_LIBRARY) + "\n"
+          header_file << IMPORT_HEADER%[entity.name] + "\n"
+          header_file << "\n" + SEPARATOR + "\n\n"
+          header_file << PRAGMA_MARK_INTERFACE + "\n\n"
+          header_file << JSON_CATEGORY_INTERFACE%[entity.name] + "\n\n"
+          header_file << END_CODE + "\n"
+          header_file
+        end
+
+        def generate_source_category_file(entity)
+          source_file = String.new
+          source_file << GENERATED_MESSAGE + "\n"
+          source_file << "\n" + SEPARATOR + "\n\n"
+          source_file << PRAGMA_MARK_IMPORTS + "\n\n"
+          source_file << IMPORT_HEADER%[JSON_CATEGORY_NAME%[entity.name]] + "\n"
+          source_file << IMPORT_HEADER%[ENUM_FILE_NAME] + "\n" if entity.has_enum_attributes?
+          entity.transformers.each do |name|
+            source_file << IMPORT_HEADER%[name]+"\n"
+          end
+          source_file << "\n" + SEPARATOR + "\n\n"
+          source_file << PRAGMA_MARK_IMPLEMENTATION + "\n\n"
+          source_file << JSON_CATEGORY_IMPLEMENTATION%[entity.name] + "\n\n"
+          source_file << generate_mapping(entity)
+          source_file << "\n" + generate_json_transformers(entity) if entity.need_transformer?
+          source_file << "\n" + END_CODE + "\n"
+          source_file
+        end
+
+        def generate_mapping(entity)
+          inbound_mapping_string = '+ (NSDictionary *)JSONInboundMappingDictionary' + "\n"
+          inbound_mapping_string << '{' + "\n"
+          inbound_mapping_string << '    ' + 'return @{' + "\n"
+          outbound_mapping_string = '+ (NSDictionary *)JSONOutboundMappingDictionary' + "\n"
+          outbound_mapping_string << '{' + "\n"
+          outbound_mapping_string << '    '+ 'return @{' + "\n"
+
+          entity.attributes.each do |_, attribute|
+            json_value = attribute.json_key_path.empty? ? attribute.name.add_quotes : attribute.json_key_path.add_quotes
+            inbound_mapping_string << '        ' + DICTIONARY_JSON%[json_value, attribute.name.add_quotes] + "\n"
+            outbound_mapping_string << '        ' + DICTIONARY_JSON%[attribute.name.add_quotes, json_value] + "\n"
+          end
+
+          entity.relationships.each do |_, relationship|
+            json_value = relationship.json_key_path.empty? ? relationship.name.add_quotes : relationship.json_key_path.add_quotes
+            inbound_mapping_string << '        ' + DICTIONARY_JSON%[json_value, relationship.name.add_quotes] + "\n"
+            outbound_mapping_string << '        ' + DICTIONARY_JSON%[relationship.name.add_quotes, json_value] + "\n"
+          end
+
+          #delete last coma
+          inbound_mapping_string = inbound_mapping_string[0..inbound_mapping_string.length - 3] + "\n"
+          inbound_mapping_string << '    ' +'};' + "\n"
+          inbound_mapping_string << '}' + "\n\n"
+          outbound_mapping_string = outbound_mapping_string[0..outbound_mapping_string.length - 3] + "\n"
+          outbound_mapping_string << '    ' + '};' + "\n"
+          outbound_mapping_string << '}' + "\n"
+          inbound_mapping_string + outbound_mapping_string
+        end
+
+        def generate_json_transformers(entity)
+          json_transformer_string = String.new
+          first_transformer = true
+          entity.attributes.each do |(_, attribute)|
+            if attribute.need_transformer?
+              json_transformer_string << "\n" unless first_transformer
+              first_transformer = false
+              json_transformer_string << JSON_TRANSFORMER_DEF%[attribute.name] + "\n"
+              json_transformer_string << '{'+ "\n"
+              if !attribute.enum_type.empty? or attribute.type == :boolean # Enum | Boolean
+                json_transformer_string << '    ' + 'return [MCJSONValueTransformer valueTransformerWithMappingDictionary:@{' + "\n"
+                if attribute.type == :boolean
+                  json_values = TRANSFORMER_BOOL_JSON
+                  model_values = TRANSFORMER_BOOL_MODEL
+                else
+                  if attribute.json_values.empty?
+                    Raise::error("The attribute \"%s\" from \"%s\" is enum without JSONValues - please fix it"%[attribute.name, attribute.entity_name])
+                  end
+                  json_values = TRANSFORMER_ENUM_JSON + attribute.json_values.map { |enum| '@' + enum.add_quotes }
+                  enums = attribute.enum_values
+                  if attribute.optional?
+                    default = attribute.enum_type + 'None'
+                  else
+                    default = enums[attribute.default.to_i]
+                  end
+                  model_values = [default, default, default] + enums
+                  model_values = [default, default, default, default] + enums
+                end
+                json_transformer_string << format_json_transformers(json_values, model_values)
+
+                # delete last coma
+                json_transformer_string = json_transformer_string[0..json_transformer_string.length - 3] + "\n"
+                json_transformer_string << '    ' + '}];' + "\n"
+              else # custom transformer, or a default one
+                transformer = attribute.transformer
+                transformer = 'ISO8601DateTransform' if transformer.empty? && attribute.type == :date # default one for dates if none provided
+                json_transformer_string << '    ' + TRANSFORMER%[transformer] + "\n" unless transformer.empty?
+              end
+              json_transformer_string << '}' + "\n"
+            end
+          end
+          json_transformer_string
+        end
+
+        def format_json_transformers(json_values, model_values)
+          json_transformer_string = String.new
+          (0..model_values.length - 1).each { |enum|
+            json_value = json_values[enum]
+            enum_value = model_values[enum].add_parentheses
+            json_transformer_string << '        ' + DICTIONARY_JSON_CATEGORY%[json_value, enum_value] + "\n"
+          }
+          json_transformer_string
+        end
+
+      end
+    end
+  end
+end

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

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

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

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

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