gyro 0.4.0

data/bin/gyro

@@ -0,0 +1,118 @@
+#!/usr/bin/env ruby
+
+=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
+
+if RUBY_VERSION < '2.0.0'
+  abort 'error: gyro requires Ruby 2 or higher.'
+end
+
+require 'gyro'
+require 'optparse'
+
+dir = Dir.pwd
+options = {
+    :model => nil,
+    :android_dir => nil,
+    :package => nil,
+    :ios_dir => nil,
+    :ios_json => false,
+    :ios_framework => false,
+    :ios_swift => false
+}
+
+OptionParser.new do |opts|
+  opts.banner = 'Usage: gyro [options]'
+  opts.on('-m PATH', '--model PATH', %q(Specify Interface Builder .xcdatamodel file)) do |path|
+    options[:model] = path
+  end
+  opts.on('-a PATH', '--android PATH', %q(Specify Android Realm model classes dir)) do |path|
+    options[:android_dir] = path
+  end
+  opts.on('-p PATH', '--package PATH', %q(Specify Android Realm model classes package name)) do |path|
+    options[:package] = path
+  end
+  opts.on('-i PATH', '--ios PATH', %q(Specify iOS Realm model classes dir)) do |path|
+    options[:ios_dir] = path
+  end
+  opts.on('-j', '--json', %q(Additionally generate Realm-JSON categories (Objective-C) or ObjectMapper artifacts (Swift))) do
+    options[:ios_json] = true
+  end
+  opts.on('-f', '--framework', %q(If you use CocoaPods Frameworks instead of static libraries)) do
+    options[:ios_framework] = true
+  end
+  opts.on('-s', '--swift', %q(If you use Swift as iOS language)) do
+    options[:ios_swift] = true
+  end
+  opts.on('-n', '--nsnumber', %q(To generate NSNumbers instead of Int/BOOL/Float types)) do
+    options[:wrappers] = true
+  end
+  opts.on('-w', '--wrappers', %q(To generate Java primitive wrappers for optional fields instead of primitive types)) do
+    options[:wrappers] = true
+  end
+  opts.on('-x', '--annotations', %q(To tag code with Android support annotations according to optional/non optional fields)) do
+    options[:annotations] = true
+  end
+  opts.on_tail('-h', '--help', %q(Show this message)) { puts opts; exit 1 }
+  opts.on_tail('-v', '--version', 'Show version') { puts Gyro::VERSION; exit }
+  opts.parse!
+end
+
+if options[:model].nil?
+  Gyro::Log::info('No model provided, trying to find one in the local directory…')
+  options[:model] = Gyro.find_xcdatamodel(dir)
+  Gyro::Log::info("Unable to find any .xcdatamodel in #{dir}") if options[:model].nil?
+end
+
+if options[:model].nil?
+  Gyro.exit_with_error('You need to specify .xcdatamodel path using --model option (see --help for more info)')
+else
+  basename = File.basename(options[:model])
+  dirname = File.dirname(options[:model])
+  Gyro::Log::success("Using #{basename} in #{dirname}")
+end
+
+# Android
+if options[:android_dir].nil?
+  Gyro::Log::info('You need to specify a dir using --android option to generate Android Realm model classes (see --help for more info)')
+else
+  if Dir.exist?(options[:android_dir])
+    if options[:package].nil?
+      Gyro::Log::info('You need to specify an Android package name using --package option (see --help for more info)')
+    else
+      xcdatamodel = Gyro::XCDataModel::Parser::XCDataModel.new(options[:model])
+      Gyro::Realm::Java::Generator.new(options[:android_dir], options[:package], xcdatamodel, options[:wrappers], options[:annotations])
+    end
+  else
+    Gyro::Log::info('You need to specify a valid Android Realm model classes dir')
+  end
+end
+
+# iOS
+if options[:ios_dir].nil?
+  Gyro::Log::info('You need to specify a dir using --ios option to generate iOS Realm model classes (see --help for more info)')
+else
+  if Dir.exist?(options[:ios_dir])
+    xcdatamodel = Gyro::XCDataModel::Parser::XCDataModel.new(options[:model])
+    if options[:ios_swift]
+      Gyro::Realm::Swift::Generator.new(options[:ios_dir], xcdatamodel, options[:ios_json])
+    else
+      Gyro::Realm::ObjC::Generator.new(options[:ios_dir], xcdatamodel, options[:ios_json], options[:ios_framework], options[:wrappers])
+    end
+  else
+    Gyro::Log::info('You need to specify a valid iOS Realm model classes dir')
+  end
+end

data/lib/gyro.rb

@@ -0,0 +1,32 @@
+=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('gyro/xcdatamodel/parser/xcdatamodel', File.dirname(__FILE__))
+require File.expand_path('gyro/realm/java/generator', File.dirname(__FILE__))
+require File.expand_path('gyro/realm/objc/generator', File.dirname(__FILE__))
+require File.expand_path('gyro/realm/swift/generator', File.dirname(__FILE__))
+require File.expand_path('gyro/utils/log', File.dirname(__FILE__))
+require File.expand_path('gyro/utils/file_utils', File.dirname(__FILE__))
+
+module Gyro
+  VERSION = '0.4.0'
+
+  def self.exit_with_error(message)
+    Gyro::Log::error message
+    exit 1
+  end
+
+end

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

@@ -0,0 +1,63 @@
+=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 Java
+      module Converter
+
+        TYPES = {
+            :integer_16 => 'short',
+            :integer_32 => 'int',
+            :integer_64 => 'long',
+            :decimal => 'double',
+            :double => 'double',
+            :float => 'float',
+            :string => 'String',
+            :boolean => 'boolean',
+            :date => 'Date',
+            :binary => 'byte[]'
+        }
+        
+        WRAPPER_TYPES = {
+            :integer_16 => 'Short',
+            :integer_32 => 'Integer',
+            :integer_64 => 'Long',
+            :decimal => 'Double',
+            :double => 'Double',
+            :float => 'Float',
+            :string => 'String',
+            :boolean => 'Boolean',
+            :date => 'Date',
+            :binary => 'Byte[]'
+        }
+
+        def convert_type(type, useWrapperClass)
+            if (useWrapperClass)
+                WRAPPER_TYPES[type]
+            else
+                TYPES[type]
+            end
+        end
+        
+        def is_primitive(type_str)
+            TYPES.has_value?(type_str) and type_str != "String" and type_str != "Date"
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,128 @@
+=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 Java
+      module EnumGenerator
+
+        # INCLUDES #############################################################
+        include Templates
+
+        # PUBLIC METHODS #######################################################
+
+        def generate_enums(path, package, attributes, support_annotations = false)
+          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, package, enum_type, attribute.enum_values, attribute.json_values, support_annotations)
+            end
+          end
+        end
+
+        def generate_enum_getter_and_setter(enum_type, attribute_name, support_annotations)
+          getter = String.new
+          setter = String.new
+          getter << '    ' + '@android.support.annotation.Nullable' + "\n" if support_annotations
+          getter << '    public ' + enum_type + ' get'+ attribute_name.capitalize_first_letter + 'Enum() {' + "\n" +
+              '        ' + 'return '+ enum_type + '.get(get' + attribute_name.capitalize_first_letter + '());' + "\n" +
+              '    ' + '}' + "\n"
+          setter << '    ' + 'public void set'+ attribute_name.capitalize_first_letter + 'Enum('
+          setter << '@android.support.annotation.NonNull ' if support_annotations
+          setter << 'final ' + enum_type + ' ' + attribute_name +') {' + "\n" +
+              '        ' + 'this.' + attribute_name + ' = ' + attribute_name + '.getJsonValue();' + "\n" +
+              '    ' + '}' + "\n"
+          getter + "\n" + setter
+        end
+
+        private #################################################################
+
+        def generate_enum(path, package, enum_name, enum_values, json_values, support_annotations)
+          enum_file = String.new
+          enum_file << PACKAGE_TEMPLATE%[package] + "\n\n"
+          enum_file << GENERATED_MESSAGE + "\n\n"
+          enum_file << ENUM_TEMPLATE%[enum_name] + "\n\n"
+          json_values = get_json_values(enum_values, json_values)
+          if enum_values.length != 0
+            (0..enum_values.length - 1).each { |idx|
+              gson_value = json_values[idx]
+              enum_value = generate_enum_string(enum_values[idx], gson_value)
+              enum_file << (idx != enum_values.length - 1 ? enum_value + ",\n" : enum_value + ";\n")
+            }
+            enum_file << "\n" '    ' + FINAL_ATTRIBUTE_TEMPLATE%%w(String jsonValue) + "\n\n"
+            enum_file << generate_enum_gson_constructor(enum_name) + "\n"
+            enum_file << generate_static_gson_getter(enum_name, support_annotations) + "\n"
+            enum_file << generate_gson_getter(support_annotations)
+            enum_file << '}' + "\n"
+            Gyro.write_file_with_name(path, JAVA_FILE_TEMPLATE%[enum_name], enum_file)
+          end
+        end
+
+        def generate_enum_string(enum_value, gson_value)
+          enum_value = enum_value.delete_objc_prefix.camel_case
+          gson_annotation = gson_value.empty? ? '' : ENUM_JSON_VALUE%[gson_value]
+          '    ' + enum_value + gson_annotation
+        end
+
+        def generate_enum_gson_constructor(enum_name)
+          '    ' + enum_name +'(final String jsonValue) {' + "\n" +
+              '        ' + 'this.jsonValue = jsonValue;' + "\n" +
+              '    ' + '}' + "\n"
+        end
+
+        # Methods to bypass enum restriction in Realm
+        def generate_static_gson_getter(enum_name, support_annotations)
+          getter = String.new
+          getter << '   @android.support.annotation.Nullable' + "\n" if support_annotations
+          getter << '    public static ' + enum_name + ' get(final String jsonValue) {' + "\n" +
+              '        ' + 'for (final ' + enum_name + ' type : ' + enum_name + '.values()) {' + "\n" +
+              '            ' + 'if (type.getJsonValue().equals(jsonValue)) {' + "\n" +
+              '                ' + 'return type;' + "\n" +
+              '            ' + '}'+ "\n" +
+              '        ' + '}' + "\n" +
+              '        ' + 'return null;' + "\n" +
+              '    ' + '}' + "\n"
+          getter
+        end
+
+        def generate_gson_getter(support_annotations)
+          getter = String.new
+          getter << '   @android.support.annotation.NonNull' + "\n" if support_annotations
+          getter << '    ' + 'public String getJsonValue() {' + "\n" +
+              '        ' + 'return jsonValue;' + "\n" +
+              '    ' + '}' + "\n"
+          getter
+        end
+
+        def get_json_values(enum_values, json_values)
+          if json_values.empty?
+            enum_values.each { |value|
+              json_values << value.delete_objc_prefix.underscore
+            }
+          end
+          json_values
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,183 @@
+=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__))
+
+module Gyro
+  module Realm
+    module Java
+
+      class Generator
+
+        # INCLUDES #############################################################
+
+        include Gyro::XCDataModel::Parser
+        include Converter
+        include EnumGenerator
+        include Templates
+
+        # PUBLIC METHODS #######################################################
+
+        def initialize(path, package_name, xcdatamodel, use_wrappers = false, support_annotations = false)
+          puts "\n"
+          Gyro::Log::title('Android Realm')
+          xcdatamodel.entities.each do |_, entity|
+            unless entity.abstract?
+              Gyro::Log::success("Generating entity #{entity.name}...")
+              generate_class(path, package_name, entity, use_wrappers, support_annotations)
+            end
+          end
+        end
+
+        private ################################################################
+
+        def generate_class(path, package, entity, use_wrappers, support_annotations)
+          class_file = String.new
+          entity.name = entity.name.delete_objc_prefix
+          generate_header(class_file, package, entity)
+          generate_attributes(class_file, entity.attributes, entity.relationships, entity.identity_attribute, use_wrappers, support_annotations)
+          generate_footer(class_file)
+          Gyro.write_file_with_name(path, JAVA_FILE_TEMPLATE%[entity.name], class_file)
+          generate_enums(path, package, entity.attributes, support_annotations)
+        end
+
+        def generate_header(class_file, package, entity)
+          class_file << PACKAGE_TEMPLATE%[package] + "\n\n"
+          class_file << IMPORT_GSON + "\n\n" if entity.has_json_key_path?
+          class_file << IMPORT_DATE + "\n" if entity.has_date_attribute?
+          class_file << IMPORT_LIST + "\n" if entity.has_list_relationship?
+          class_file << "\n" if entity.has_date_attribute? or entity.has_list_relationship?
+          class_file << IMPORT_REALM_LIST + "\n" if entity.has_list_attributes?
+          class_file << IMPORT_REALM_OBJECT + "\n"
+          class_file << IMPORT_REALM_IGNORE + "\n" if entity.has_ignored? or entity.has_enum_attributes?
+          class_file << IMPORT_REALM_INDEX + "\n" if entity.has_indexed_attributes?
+          class_file << IMPORT_REALM_PRIMARY_KEY + "\n" if entity.has_primary_key?
+          class_file << "\n" if class_file != PACKAGE_TEMPLATE%[package]
+          class_file << GENERATED_MESSAGE + "\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 << '    ' + ATTRIBUTE_CONSTANTS + "\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 << '        ' + CONSTANT_TEMPLATE%[attribute.name.underscore.upcase, 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 << '    ' + RELATIONSHIP_CONSTANTS + "\n"
+            entity.relationships.each do |_, relationship|
+              relationship_constants << '        ' + CONSTANT_TEMPLATE%[relationship.name.underscore.upcase, relationship.name] + "\n" unless relationship.inverse?
+            end
+            relationship_constants << '    ' + '}'+ "\n\n"
+          end
+          attribute_constants + relationship_constants
+        end
+
+        def generate_footer(class_file)
+          class_file << '}' + "\n"
+        end
+
+        def generate_attributes(class_file, attributes, relationships, primary_key, use_wrappers, support_annotations)
+          # "NORMAL" ATTRIBUTES
+          (attributes_string, getters_and_setters_string) = write_attributes(attributes, primary_key, use_wrappers, support_annotations)
+          # "RELATIONSHIP" ATTRIBUTES
+          relationships.each do |_, relationship|
+            unless relationship.inverse?
+              if relationship.destination.empty?
+                type_without_prefix = relationship.inverse_type.delete_objc_prefix
+                type = relationship.type == :to_many ? REALM_LIST_TEMPLATE%[type_without_prefix] : type_without_prefix
+                name = relationship.name
+              else
+                type = LIST_TEMPLATE%[relationship.destination]
+                name = relationship.name
+              end
+              attributes_string << '    ' + IGNORED_ANNOTATION + "\n" if relationship.realm_ignored?
+              attributes_string << '    ' + GSON_ANNOTATION%[relationship.json_key_path]+ "\n" unless relationship.json_key_path.empty?
+              attributes_string << '    ' + ATTRIBUTE_TEMPLATE%[type, name] + "\n"
+              getters_and_setters_string << "\n" unless getters_and_setters_string.empty?
+              getters_and_setters_string << generate_getter_and_setter(type, name, (support_annotations and relationship.optional), (support_annotations and !relationship.optional), relationship.support_annotation)
+            end
+          end
+          class_file << attributes_string + "\n" + getters_and_setters_string
+        end
+
+        def write_attributes(attributes, primary_key, use_wrappers, support_annotations)
+          attributes_string = String.new
+          getters_and_setters_string = String.new
+          attributes.each_with_index do |(_, attribute), idx|
+            unless attribute.read_only?
+              name = attribute.name
+              type = attribute.enum? ? 'String' : convert_type(attribute.type, (use_wrappers and attribute.optional))
+              if type
+                # Realm annotations
+                attributes_string << '    ' + PRIMARY_KEY_ANNOTATION + "\n" if name == primary_key
+                attributes_string << '    ' + INDEXED_ANNOTATION + "\n" if attribute.indexed
+                attributes_string << '    ' + IGNORED_ANNOTATION + "\n" if attribute.realm_ignored? or attribute.enum?
+                if attribute.enum?
+                  ignored_type = attribute.enum? ? attribute.enum_type.delete_objc_prefix : type
+                  ignored_name = attribute.enum? ? name + 'Enum' : name
+                  attributes_string << '    ' + ATTRIBUTE_TEMPLATE%[ignored_type, ignored_name] + "\n"
+                end
+                attributes_string << '    ' + GSON_ANNOTATION%[attribute.json_key_path]+ "\n" unless attribute.json_key_path.empty?
+                attributes_string << '    ' + SUPPORT_ANNOTATION%[attribute.support_annotation] + "\n" unless attribute.support_annotation.empty?
+                attributes_string << '    ' + ATTRIBUTE_TEMPLATE%[type, name] + "\n"
+              end
+              getters_and_setters_string << generate_getter_and_setter(type, name, (support_annotations and ((use_wrappers and attribute.optional) or (attribute.enum? and attribute.optional))), (support_annotations and ((!is_primitive(type) and !attribute.optional) or (attribute.enum? and !attribute.optional))), attribute.support_annotation)
+              getters_and_setters_string << "\n" + generate_enum_getter_and_setter(attribute.enum_type.delete_objc_prefix, name, support_annotations) if attribute.enum?
+              getters_and_setters_string << "\n" if idx != attributes.count - 1
+            end
+          end
+          return attributes_string, getters_and_setters_string
+        end
+
+        def generate_getter_and_setter(type, name, nullable, nonnull, support_annotation)
+          getter_setter = String.new
+          getter_setter << '    ' + SUPPORT_ANNOTATION%['Nullable'] + "\n" if nullable
+          getter_setter << '    ' + SUPPORT_ANNOTATION%['NonNull'] + "\n" if nonnull
+          getter_setter << '    ' + SUPPORT_ANNOTATION%[support_annotation] + "\n" unless support_annotation.empty?
+          getter_setter << '    ' + 'public ' + type + ' get' + name.capitalize_first_letter + '() {' + "\n"
+          getter_setter << '        ' + 'return '+ name + ';' + "\n"
+          getter_setter << '    ' + '}' + "\n\n"
+          getter_setter << '    ' + 'public void set' + name.capitalize_first_letter + '('
+          getter_setter << SUPPORT_ANNOTATION%['Nullable'] + ' ' if nullable
+          getter_setter << SUPPORT_ANNOTATION%['NonNull'] + ' ' if nonnull
+          getter_setter << SUPPORT_ANNOTATION%[support_annotation] + ' ' unless support_annotation.empty?
+          getter_setter << 'final ' + type + ' ' + name + ') {' + "\n"
+          getter_setter << '        ' + 'this.' + name + ' = ' + name + ';' + "\n"
+          getter_setter << '    ' + '}' + "\n"
+          getter_setter
+        end
+
+      end
+
+    end
+  end
+end