gyro 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fc533a0c50dcdf240cbd07626f0ea83dbaea4f3
-  data.tar.gz: 0ac64d46fb1bd357f964396e3961359231ba62cc
+  metadata.gz: 8e5f08df0670a25b7dc526fa689e6c92ae3e510f
+  data.tar.gz: f46dabd9dc80b7eb665af3cf3b732c3d647784c0
 SHA512:
-  metadata.gz: fc2256f1fefc840d738345bfa2dfecd61020c0f3795c937f1a0bbcd458c7b2348e54df5f99e0b1e524aaa8f0400d14abddf7b105d4079a7fa8c8c3ba5bd97693
-  data.tar.gz: 3705920540f76e3d0c53fb2c311d500b95f412de79370ec40212d7fe32d9f6f8e6dad410524f1db411d991727a532273dc82186621d9399efbbf22b523bcdec0
+  metadata.gz: c73b447c3038e8c3a3b949984e6bb600519c2fe2dbbb44b9a989d4e31ce61bb384a594a68e1ebac0d2a149af557c7e482d9d70ac574d4ab25e37e891b6c2f2db
+  data.tar.gz: 8f16dae895a213e8e637ded30569eff086e2ce7d33cf88ddebd02dc34cad3fd27d729c9fbfa1bcb5581baa477725460c0f1d172c0e7764bf8fce47d900e062ec

data/README.md

@@ -5,7 +5,7 @@
 [![build circle ci](https://img.shields.io/circleci/project/github/NijiDigital/gyro.svg?style=flat-square)](https://circleci.com/gh/NijiDigital/gyro)
 [![Twitter](https://img.shields.io/badge/twitter-@Niji_Digital-blue.svg?style=flat-square)](http://twitter.com/Niji_Digital)
 
-Gyro is a tool to generate [Realm](https://realm.io) model classes, for both Android (Java) and iOS/macOS (Swift), from an `.xcdatamodel` file.
+Gyro is a tool to generate [Realm](https://realm.io) model classes, for both Android (Java & Kotlin) and iOS/macOS (Swift), from an `.xcdatamodel` file.
 
 ---
 <center><table><tr>
@@ -42,7 +42,7 @@ _Alternativly, you could also clone this repository anywhere you want on your ma
 
 ```bash
 gem build gyro.gemspec
-gem install gyro-1.0.0.gem
+gem install gyro-*.gem
 ```
 
 ## Usage
@@ -58,13 +58,21 @@ gyro --model <model> --template <template-name> --output <output-dir> --param <k
 
 `<template-name>` is the name of the template. Below you have the list of templates.
 
-If you want additional information about templates you can go to the documentation for each :
 
-- [android](lib/templates/android/README.md)
-- [swift3](lib/templates/swift3/README.md)
-- [decodable](lib/templates/decodable/README.md)
-- [swift3-variant](lib/templates/swift3-variant/README.md)
-- [object-mapper](lib/templates/object-mapper/README.md)
+## Templates
+
+You can use `gyro -l` to list the names of all the bundled templates available.
+
+If you want additional information about a specific template, you can use `gyro -i <template_name>` to print its README documentation, which is also directly accessible on GitHub via the following links:
+
+- [android-java](lib/templates/android-java/README.md) (Java)
+- _Note: `android` is an alias name for the [android-java](lib/templates/android-java/README.md) template_
+- [android-kotlin](lib/templates/android-kotlin/README.md) (Kotlin)
+- [swift3](lib/templates/swift3/README.md) (Swift 3 & 4)
+- _Note: `swift4` is an alias name for the [swift3](lib/templates/swift3/README.md) template_
+- [decodable](lib/templates/decodable/README.md) (for Anviking's `Decodable` pod)
+- [swift3-variant](lib/templates/swift3-variant/README.md) _(Deprecated, only for use with the `object-mapper` template)_
+- [object-mapper](lib/templates/object-mapper/README.md) _(Deprecated)_
 
 ## Annotating your `xcdatamodel`
 
@@ -76,7 +84,9 @@ _To define a User Info key in Xcode's xcdatamodel editor, select the entity or a
 
 With the help of these "user infos", you will be able to give Gyro extra information about your model classes. For example, you can tell which attribute is the primary key, the attributes to ignore, the JSON mappings, …
 
-**For more information about "user infos", you can see the dedicated documentation [here](UserInfoKeys.md).**
+### 📖  Documentation of User Info Keys
+
+For more information about each "user infos" keys supported, you can see the 📖 [dedicated documentation here](UserInfoKeys.md).
 
 ## License
 

data/lib/gyro/generator/liquid/liquid.rb

@@ -21,7 +21,6 @@ module Gyro
 
       # PUBLIC METHODS #######################################################
 
-      # rubocop:disable Metrics/AbcSize
       def initialize(template_dir, output_dir, params)
         Gyro::Log.title('Generating Model')
 
@@ -38,7 +37,6 @@ module Gyro
         enum_fn_tpl = template_dir + 'filename.liquid' unless enum_fn_tpl.exist?
         @enum_filename_template = load_template(enum_fn_tpl, true)
       end
-      # rubocop:enable Metrics/AbcSize
 
       def generate(xcdatamodel)
         generate_entities(xcdatamodel)

data/lib/gyro/log.rb

@@ -22,19 +22,19 @@ module Gyro
     end
 
     def self.title(str) # bg yellow
-      puts "\n\e[44;37m#{str}\e[0m" unless @quiet
+      puts "\n#{str.colorize(:gray, :blue)}" unless @quiet
     end
 
     def self.error(str)
-      puts "\e[1;31m! #{str}\e[0m" unless @quiet
+      puts "! #{str}".colorize(:red, :bold) unless @quiet
     end
 
     def self.info(str)
-      puts "\e[1;33m> #{str}\e[0m" unless @quiet
+      puts "> #{str}".colorize(:yellow, :bold) unless @quiet
     end
 
     def self.success(str)
-      puts "\e[1;32m√ #{str}\e[0m" unless @quiet
+      puts "√ #{str}".colorize(:green, :bold) unless @quiet
     end
 
     def self.fail!(message, stacktrace: false)
@@ -44,3 +44,20 @@ module Gyro
     end
   end
 end
+
+# Extending Ruby's String type to allow colorization via ANSI control codes
+#
+class String
+  ANSI_COLORS = %i[black red green yellow blue magenta cyan gray white].freeze
+  ANSI_MODES = %i[normal bold faint italic underline blink].freeze
+
+  def colorize(fg = :white, *options)
+    fg_code = 30 + (ANSI_COLORS.index(fg) || 7)
+    other_codes = options.map do |opt|
+      bg = ANSI_COLORS.index(opt)
+      bg.nil? ? ANSI_MODES.index(opt) : 40 + bg
+    end
+    codes = [fg_code, *other_codes].compact.join(';')
+    "\e[#{codes}m#{self}\e[0m"
+  end
+end

data/lib/gyro/parser/xcdatamodel/entity.rb

@@ -36,7 +36,7 @@ module Gyro
 
         def to_h
           {
-            'attributes' => attributes.values.map(&:to_h),
+            'attributes' => attributes.values.sort_by { |a| a.name == identity_attribute ? '__' : a.name }.map(&:to_h),
             'relationships' => relationships.values.map(&:to_h),
             'name' => name,
             'parent' => parent,

data/lib/gyro/parser/xcdatamodel/relationship.rb

@@ -26,7 +26,7 @@ module Gyro
         alias realm_ignored? realm_ignored
         alias json_ignored? json_ignored
 
-        # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        # rubocop:disable Metrics/AbcSize
         def initialize(relationship_xml, entity_name)
           @entity_name = entity_name
           @name = relationship_xml.attributes['name'].to_s
@@ -51,7 +51,7 @@ module Gyro
             'support_annotation' => support_annotation,
             'realm_ignored' => realm_ignored, 'destination' => destination, 'inverse' => inverse? }
         end
-        # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+        # rubocop:enable Metrics/AbcSize
 
         def to_s
           "\tRelationship => name=#{@name} | type=#{@type} | optional=#{@optional} | deletion_rule=#{@deletion_rule}\n"

data/lib/gyro/template.rb

@@ -17,52 +17,100 @@ module Gyro
   #
   module Template
     def self.print_list
-      Gyro::Template.directory.children.select(&:directory?).each do |entry|
-        puts " - #{entry.basename}"
+      Gyro::Template.directory.children.sort_by(&:basename).each do |entry|
+        alias_name, target = Gyro::Template.resolve_alias(entry)
+        if alias_name
+          puts [
+            ' - '.colorize(:gray, :faint),
+            alias_name.colorize(:gray),
+            ' (alias for '.colorize(:gray, :faint),
+            target.colorize(:gray),
+            ')'.colorize(:gray, :faint)
+          ].join
+        elsif entry.directory?
+          puts ' - ' + entry.basename.to_s
+        end
       end
     end
 
     def self.print_infos(template)
-      readme = if template.include?('/')
-                 Pathname.new(template) + 'README.md'
-               else
-                 Gyro::Template.directory + template + 'README.md'
-               end
+      template_dir = Gyro::Template.find(template, false)
+      Gyro::Log.fail!("No template found at path or for name '#{template}'.") unless template_dir
+      readme = template_dir + 'README.md'
 
       Gyro::Log.fail!("No README.md found for template #{template}.") unless readme.exist?
       puts readme.read
     end
 
+    # Returns the Pathname representing the directory where all bundled templates are located
+    #
     def self.directory
       Pathname.new(File.dirname(__FILE__)) + '../templates'
     end
 
-    def self.find(template_param)
-      if template_param.include? '/'
-        find_by_path(template_param)
-      else
-        find_by_name(template_param)
+    # @param [Pathname] entry
+    #        The alias to resolve
+    # @return [(String, String)]
+    #         A 2-items array of [the alias name, the alias target name]
+    #         Or nil if the entry does not correspond to a valid template alias
+    #
+    def self.resolve_alias(entry)
+      return nil unless entry.exist?
+      return nil if entry.extname != '.alias'
+      base = entry.basename('.alias').to_s
+      target = entry.open(&:readline).chomp # Only read the first line of the file, the rest is ignored
+      return nil if File.basename(target) != target || target.include?('..') # Security measure
+      [base, target]
+    end
+
+    # Resolve alias by name
+    #
+    # @return [(String, String)]
+    #         A 2-items array of [the alias name, the alias target name]
+    #         Or nil if the name does not correspond to a valid template alias
+    #
+    def self.resolve_alias_name(name)
+      path = Gyro::Template.directory + (name + '.alias')
+      resolve_alias(path)
+    end
+
+    # @param [String] template_param
+    #        The name or path of the template to find
+    # @return [Pathname]
+    #         The path to the template corresponding to that name or path
+    #
+    def self.find(template_param, fail_on_error = true)
+      template = if template_param.include?('/')
+                   find_by_path(template_param)
+                 else
+                   find_by_name(template_param)
+                 end
+      if template.nil? && fail_on_error
+        Gyro::Log.fail!('You need to specify a valid template directory or name' \
+                        ' using the --template parameter (see --help for more info)')
       end
+      template
     end
 
+    # @param [String] path
+    #        The path to the template to find
+    # @return [Pathname]
+    #         The path to the template corresponding to that name or path
+    #
     def self.find_by_path(path)
       template_dir = Pathname.new(path)
-      unless template_dir.exist?
-        Gyro::Log.fail!('You need to specify existing template directory using --template option' \
-                        ' (see --help for more info)')
-      end
-
       return template_dir if template_dir.directory?
-      return template_dir.dirname if template_dir.file?
-      Gyro::Log.fail!('You need to specify right template directory using --template option' \
-                      ' (see --help for more info)')
     end
 
+    # @param [String] name
+    #        The name of the template to find among the templates bundled with gyro
+    # @return [Pathname]
+    #         The path to the template corresponding to that name or path
+    #
     def self.find_by_name(name)
-      template_dir = Gyro::Template.directory + name
-      return template_dir if template_dir.exist?
-      Gyro::Log.fail!('You need to specify existing default template name using --template option' \
-                      ' (see --help for more info)')
+      _, target = Gyro::Template.resolve_alias_name(name)
+      template_dir = Gyro::Template.directory + (target || name)
+      return template_dir if template_dir.directory?
     end
   end
 end

data/lib/gyro/version.rb

@@ -15,5 +15,5 @@
 # Gyro Version
 #
 module Gyro
-  VERSION = '1.3.0'.freeze
+  VERSION = '1.4.0'.freeze
 end

data/lib/templates/{android → android-java}/README.md

@@ -2,13 +2,13 @@
 
 | Name      | Description       |
 | --------- | ----------------- |
-| Folder name | templates/android |
-| Invocation example | `gyro -m <model> -t android …` |
+| Folder name | templates/android-java |
+| Invocation example | `gyro -m <model> -t android-java …` |
 | Language | Java |
 
 If you want to use this template you need to work with `Realm`.
 
-# Caracteristics
+# Characteristics
 
 In this template you have additional parameters to inject constants : 
 
@@ -22,25 +22,25 @@ In this template you have additional parameters to inject constants :
 Package exemple :
 
 ```bash
-gyro -m <model> -t android -o <output> --param package:com.gyro.model.realm
+gyro -m <model> -t android-java -o <output> --param package:com.gyro.model.realm
 ```
 
 Use wrappers exemple :
 
 ```bash
-gyro -m <model> -t android -o <output> --param use_wrappers:true
+gyro -m <model> -t android-java -o <output> --param use_wrappers:true
 ```
 
 Support annotations exemple :
 
 ```bash
-gyro -m <model> -t android -o <output> --param support_annotations:true
+gyro -m <model> -t android-java -o <output> --param support_annotations:true
 ```
 
 And you can combine options :
 
 ```bash
-gyro -m <model> -t android -o <output> --param package:com.gyro.model.realm --param support_annotations:true --param use_wrappers:true
+gyro -m <model> -t android-java -o <output> --param package:com.gyro.model.realm --param support_annotations:true --param use_wrappers:true
 ```
 
 

data/lib/templates/{android → android-java}/entity.liquid

@@ -30,6 +30,9 @@ import io.realm.annotations.Index;
 {%- if entity.has_primary_key == true %}
 import io.realm.annotations.PrimaryKey;
 {%- endif %}
+{%- if entity.has_required == true %}
+import io.realm.annotations.Required;
+{%- endif %}
 
 {% if entity.comment.size > 0 -%}
 /**

data/lib/templates/{android → android-java}/inc/_attributes_properties.liquid

@@ -25,9 +25,16 @@
         {%- endif %}
       {%- endcapture %}
 
+      {%- capture isPrimitives %}
+        {%- include 'inc/primitives' %}
+      {%- endcapture %}
+
       {%- assign name = attribute.name -%}
       {%- if name == primary_key %}
     @PrimaryKey
+      {%- endif -%}
+      {%- if attribute.optional == false and attribute.realm_ignored == false and name != primary_key and isPrimitives == "false" %}
+    @Required 
       {%- endif -%}
       {%- if attribute.indexed == true %}
     @Index

data/lib/templates/android-kotlin/README.md

@@ -8,7 +8,7 @@
 
 If you want to use this template you need to work with `Realm`.
 
-# Caracteristics
+# Characteristics
 
 In this template you have additional parameters to inject constants : 
 

data/lib/templates/android.alias

@@ -0,0 +1,10 @@
+android-java
+
+=== Note ===
+
+  The template named 'android-java' was originally just named `android`
+  and was written in Java before Kotlin even existed.
+
+  So this alias exists mainly for compatibility reasons, so that people
+  who used `-t android` in previous versions of `gyro` can still continue
+  to do so and that this new update of gyro doesn't break their setup.

data/lib/templates/swift3-variant/README.md

@@ -10,7 +10,7 @@
 
 When you need to work with `ObjectMapper` and `Realm` together
 
-# Caracteristics
+# Characteristics
 
 In this template optional Realm objects (Attributes - RealmOptional - or Relationships - List<> -) are var properties :
 
@@ -32,6 +32,8 @@ In this template optional Realm objects (Attributes - RealmOptional - or Relatio
 {%- endif %}
 ```
 
+This is not recommanded by Realm, and not conform to the Realm documentation (and can lead to bad behaviors with Realm if you happen to affect a new `List` or `RealmOptional` instance to those properties) but sadly this is required to work with the deprecated `ObjectMapper` template.
+
 # Generated Code
 
 `Product.swift`

data/lib/templates/swift3/README.md

@@ -11,7 +11,7 @@
 This template is the reference for swift 3 with Realm generation code. This template is compatible with swift 4.
 You can use it when you need to work with `Realm`
 
-# Caracteristics
+# Characteristics
 
 In this template optional Realm objects (Attributes - RealmOptional - or Relationships - List<> -) are `let` properties (conform to the Realm documentation) :
 

data/lib/templates/swift3/inc/_attributes_enum.liquid

@@ -6,7 +6,7 @@
             {%- if attribute.comment.size > 0 %}
     /** {{ attribute.comment }} **/
             {%- endif %}
-    case {{ attribute.name }} = "{{ attribute.name | escape_quotes }}"
+    case {{ attribute.name }} = "{{ attribute.name | escape_quotes }}"{% if attribute.name == entity.identity_attribute %} /* Primary Key */{% endif %}
         {%- endif %}
     {%- endfor %}
   }

data/lib/templates/swift3/inc/_attributes_properties.liquid

@@ -13,15 +13,13 @@
     {%- if attribute.enum_values.size > 0 -%}
       {%- comment -%} ******* GENERATE ENUM ATTRIBUTE PROPERTY ******* {% endcomment -%}
       {%- include 'inc/enum_attribute_property' -%}
-        {%- else -%}
-          {%- if attribute.optional == true -%}
-            {% comment -%} ******* GENERATE OPTIONAL ATTRIBUTE PROPERTY ******* {% endcomment -%}
-            {%- include 'inc/optional_attribute_property' -%}
-          {%- else -%}
-            {%- comment -%} ******* GENERATE DEFAULT ATTRIBUTE PROPERTY ******* {% endcomment %}
-  @objc dynamic var {{ attribute.name }}: {{ convert_type }} = {{ default_value }}
-          {%- endif -%}
-    {%- endif -%}
+    {%- else -%}{%- if attribute.optional == true -%}
+      {% comment -%} ******* GENERATE OPTIONAL ATTRIBUTE PROPERTY ******* {% endcomment -%}
+      {%- include 'inc/optional_attribute_property' -%}
+    {%- else -%}
+    {%- comment -%} ******* GENERATE DEFAULT ATTRIBUTE PROPERTY ******* {% endcomment %}
+  @objc dynamic var {{ attribute.name }}: {{ convert_type }} = {{ default_value }} {%- if attribute.name == entity.identity_attribute %} /* Primary Key */{% endif -%}
+    {%- endif -%}{%- endif -%}
   {%- endif -%}
 {%- endfor -%}
 

data/lib/templates/swift3/inc/_optional_attribute_property.liquid

@@ -1,5 +1,5 @@
 {%- if attribute.is_number == true or attribute.is_bool == true %}
-  let {{ attribute.name }} = RealmOptional<{{ convert_type }}>()
+  let {{ attribute.name }} = RealmOptional<{{ convert_type }}>(){%- if attribute.name == entity.identity_attribute %} /* Primary Key */{% endif -%}
 {%- else %}
-  @objc dynamic var {{ attribute.name }}: {{ convert_type }}?
+  @objc dynamic var {{ attribute.name }}: {{ convert_type }}?{%- if attribute.name == entity.identity_attribute %} /* Primary Key */{% endif -%}
 {%- endif -%}

data/lib/templates/swift4.alias

@@ -0,0 +1,6 @@
+swift3
+
+=== Note ===
+
+  It happens that the `swift3` template is also compatible with Swift 4 without any change.
+  So we can use the same template for both Swift 3 and Swift 4

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gyro
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - NijiDigital
@@ -80,6 +80,21 @@ files:
 - lib/gyro/parser/xcdatamodel/xcdatamodel.rb
 - lib/gyro/template.rb
 - lib/gyro/version.rb
+- lib/templates/android-java/README.md
+- lib/templates/android-java/entity.liquid
+- lib/templates/android-java/entity_filename.liquid
+- lib/templates/android-java/enum.liquid
+- lib/templates/android-java/enum_filename.liquid
+- lib/templates/android-java/inc/_attributes_enum.liquid
+- lib/templates/android-java/inc/_attributes_getter_setter.liquid
+- lib/templates/android-java/inc/_attributes_properties.liquid
+- lib/templates/android-java/inc/_enum_getter_setter.liquid
+- lib/templates/android-java/inc/_primitives.liquid
+- lib/templates/android-java/inc/_relationships_enum.liquid
+- lib/templates/android-java/inc/_relationships_getter_setter.liquid
+- lib/templates/android-java/inc/_relationships_properties.liquid
+- lib/templates/android-java/inc/_type_converter.liquid
+- lib/templates/android-java/inc/_wrapper_type_converter.liquid
 - lib/templates/android-kotlin/README.md
 - lib/templates/android-kotlin/entity.liquid
 - lib/templates/android-kotlin/entity_filename.liquid
@@ -94,21 +109,7 @@ files:
 - lib/templates/android-kotlin/inc/_type_converter.liquid
 - lib/templates/android-kotlin/inc/_type_defaults.liquid
 - lib/templates/android-kotlin/inc/_type_primitives.liquid
-- lib/templates/android/README.md
-- lib/templates/android/entity.liquid
-- lib/templates/android/entity_filename.liquid
-- lib/templates/android/enum.liquid
-- lib/templates/android/enum_filename.liquid
-- lib/templates/android/inc/_attributes_enum.liquid
-- lib/templates/android/inc/_attributes_getter_setter.liquid
-- lib/templates/android/inc/_attributes_properties.liquid
-- lib/templates/android/inc/_enum_getter_setter.liquid
-- lib/templates/android/inc/_primitives.liquid
-- lib/templates/android/inc/_relationships_enum.liquid
-- lib/templates/android/inc/_relationships_getter_setter.liquid
-- lib/templates/android/inc/_relationships_properties.liquid
-- lib/templates/android/inc/_type_converter.liquid
-- lib/templates/android/inc/_wrapper_type_converter.liquid
+- lib/templates/android.alias
 - lib/templates/decodable/README.md
 - lib/templates/decodable/entity.liquid
 - lib/templates/decodable/entity_filename.liquid
@@ -153,6 +154,7 @@ files:
 - lib/templates/swift3/inc/_relationship_properties.liquid
 - lib/templates/swift3/inc/_relationships_enum.liquid
 - lib/templates/swift3/inc/_type_converter.liquid
+- lib/templates/swift4.alias
 homepage: https://github.com/NijiDigital/gyro
 licenses:
 - Apache-2.0