gyro 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e5f08df0670a25b7dc526fa689e6c92ae3e510f
-  data.tar.gz: f46dabd9dc80b7eb665af3cf3b732c3d647784c0
+  metadata.gz: 0bf0426491e18b9a47860737ea3d6dc2747f9873
+  data.tar.gz: 076fc086a2c155072ef315cf2eacbe9618dd8c4c
 SHA512:
-  metadata.gz: c73b447c3038e8c3a3b949984e6bb600519c2fe2dbbb44b9a989d4e31ce61bb384a594a68e1ebac0d2a149af557c7e482d9d70ac574d4ab25e37e891b6c2f2db
-  data.tar.gz: 8f16dae895a213e8e637ded30569eff086e2ce7d33cf88ddebd02dc34cad3fd27d729c9fbfa1bcb5581baa477725460c0f1d172c0e7764bf8fce47d900e062ec
+  metadata.gz: ffac77775f2eb5aabe39c3b59a9e7c895fdcc936945652e48f2c8c7f3a8fc4f780b430a302dd9e47541e5ebef8bdad4e983a1af71df60e2f51fae3c8af97a047
+  data.tar.gz: 30b87e1da934dbbf2f297962013eac1d384d8424ca5cb65f61d988c4663d5f0775cdcf605a1a1486be43a47c9fe7904a860bda396efd71661650f218a97c08da

data/bin/gyro

@@ -76,6 +76,7 @@ rescue OptionParser::ParseError => e
   exit 1
 end
 
+# Model directory parsing
 if options[:model].nil?
   Gyro::Log.info('No model provided, trying to find one in the local directory…')
   options[:model] = Gyro::Parser::XCDataModel.find_in_dir(dir)
@@ -90,6 +91,8 @@ else
   Gyro::Log.success("Using #{basename} in #{dirname}")
 end
 
+xcdatamodel_dir = Pathname.new(options[:model])
+
 # Liquid Templates
 if options[:template].nil?
   # Generate JSON if no -t is specified
@@ -114,12 +117,13 @@ end
 puts <<-INFO.gsub(/  \|/, '')
   |
   |#===================================
+  |# Model       : #{xcdatamodel_dir}
   |# Template    : #{template_dir}
   |# Output Dir  : #{output_dir}
   |# Params      : #{options[:params].inspect}
   |#===================================
 INFO
 
-xcdatamodel = Gyro::Parser::XCDataModel::XCDataModel.new(options[:model])
+xcdatamodel = Gyro::Parser::XCDataModel::XCDataModel.new(xcdatamodel_dir)
 gen = Gyro::Generator::Liquid.new(template_dir, output_dir, options[:params])
 gen.generate(xcdatamodel)

data/lib/gyro/log.rb

@@ -16,30 +16,30 @@ module Gyro
   # Print nice and colored output for various error/success/title messages of Gyro
   #
   module Log
-    @quiet = false
-    def self.quiet=(value)
-      @quiet = value
+    @in_test_context = false
+    def self.in_test_context=(value)
+      @in_test_context = value
     end
 
     def self.title(str) # bg yellow
-      puts "\n#{str.colorize(:gray, :blue)}" unless @quiet
+      puts "\n#{str.colorize(:gray, :blue)}" unless @in_test_context
     end
 
     def self.error(str)
-      puts "! #{str}".colorize(:red, :bold) unless @quiet
+      puts "! #{str}".colorize(:red, :bold) unless @in_test_context
     end
 
     def self.info(str)
-      puts "> #{str}".colorize(:yellow, :bold) unless @quiet
+      puts "> #{str}".colorize(:yellow, :bold) unless @in_test_context
     end
 
     def self.success(str)
-      puts "√ #{str}".colorize(:green, :bold) unless @quiet
+      puts "√ #{str}".colorize(:green, :bold) unless @in_test_context
     end
 
-    def self.fail!(message, stacktrace: false)
+    def self.fail!(message)
       Gyro::Log.error message
-      raise message if stacktrace
+      raise message if @in_test_context
       exit 1
     end
   end
@@ -51,8 +51,9 @@ 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)
+  def colorize(fg = :normal, *options)
+    fg_idx = ANSI_COLORS.index(fg)
+    fg_code = fg_idx.nil? ? ANSI_MODES.index(fg_idx) : 30 + fg_idx
     other_codes = options.map do |opt|
       bg = ANSI_COLORS.index(opt)
       bg.nil? ? ANSI_MODES.index(opt) : 40 + bg

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

@@ -116,13 +116,13 @@ module Gyro
           # rubocop:disable Style/GuardClause
           if @type == :undefined || @type.empty?
             msg = %(The attribute "#{@name}" from "#{@entity_name}" has no type - please fix it)
-            Gyro::Log.fail!(msg, stacktrace: true)
+            Gyro::Log.fail!(msg)
           end
           if !@json_key_path.empty? && !@enum_values.empty? && (@enum_values.size != @json_values.size)
             message = %(The attribute "#{@name}" from "#{@entity_name}" is wrongly annotated:) +
                       %(when declaring an type with enum and JSONKeyPath, you must have the same number of items) +
                       %(in the 'enumValues' and 'JSONValues' annotations.)
-            Gyro::Log.fail!(message, stacktrace: true)
+            Gyro::Log.fail!(message)
           end
           # rubocop:enable Style/GuardClause
         end

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

@@ -18,7 +18,7 @@ module Gyro
       # One Relationship between attributes in the xcdatamodel
       #
       class Relationship
-        attr_accessor :entity_name, :name, :type, :optional, :deletion_rule
+        attr_accessor :entity_name, :name, :type, :optional, :deletion_rule, :comment
         attr_accessor :inverse_name, :inverse_type, :json_key_path, :support_annotation, :json_ignored
         attr_accessor :realm_ignored
         attr_accessor :destination
@@ -38,6 +38,7 @@ module Gyro
           @realm_ignored = Gyro::Parser::XCDataModel.user_info(relationship_xml, 'realmIgnored').empty? ? false : true
           @json_ignored = Gyro::Parser::XCDataModel.user_info(relationship_xml, 'JSONIgnored').empty? ? false : true
           @support_annotation = Gyro::Parser::XCDataModel.user_info(relationship_xml, 'supportAnnotation')
+          @comment = Gyro::Parser::XCDataModel.user_info(relationship_xml, 'comment')
           load_type(relationship_xml)
           @destination = Gyro::Parser::XCDataModel.user_info(relationship_xml, 'destination')
           search_for_error
@@ -45,7 +46,7 @@ module Gyro
 
         def to_h
           { 'entity_name' => entity_name, 'name' => name, 'type' => type.to_s,
-            'optional' => optional, 'deletion_rule' => deletion_rule,
+            'optional' => optional, 'deletion_rule' => deletion_rule, 'comment' => comment,
             'inverse_name' => inverse_name, 'inverse_type' => inverse_type,
             'json_key_path' => json_key_path, 'json_ignored' => json_ignored,
             'support_annotation' => support_annotation,
@@ -72,12 +73,12 @@ module Gyro
           # rubocop:disable Style/GuardClause
           if inverse_type.empty? && destination.empty?
             message = %(The relationship "#{@name}" from "#{@entity_name}" is wrong - please fix it)
-            Gyro::Log.fail!(message, stacktrace: true)
+            Gyro::Log.fail!(message)
           end
           if !destination.empty? && type != :to_many
             message = %(The relationship "#{@name}" from "#{@entity_name}" is wrong - ) +
                       %(please set a 'No Value' relationship as 'To Many')
-            Gyro::Log.fail!(message, stacktrace: true)
+            Gyro::Log.fail!(message)
           end
           # rubocop:enable Style/GuardClause
         end

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

@@ -36,12 +36,18 @@ module Gyro
         attr_accessor :entities
 
         def initialize(xcdatamodel_dir)
-          contents_file = File.join(xcdatamodel_dir, 'contents')
-          Gyro::Log.fail!('Unable to find contents of xcdatamodel', stacktrace: true) unless File.exist?(contents_file)
+          is_xcdatamodeld = xcdatamodel_dir.extname != '.xcdatamodeld'
+          Gyro::Log.fail!(%(Please target an '.xcdatamodel' file inside your xcdatamodeld)) unless is_xcdatamodeld
+          if xcdatamodel_dir.parent.extname == '.xcdatamodeld'
+            xcdatamodeld_info_message = 'You are using an xcdatamodeld, ' \
+                                        'please be sure you target the correct version of your xcdatamodel.' \
+                                        ' Current version used by gyro is: ' + xcdatamodel_dir.basename.to_path
+            Gyro::Log.info(xcdatamodeld_info_message)
+          end
+          file_contents = xcdatamodel_dir + 'contents'
+          Gyro::Log.fail!('Unable to find contents of xcdatamodel') unless file_contents.exist?
           @entities = {}
-          file = File.open(contents_file)
-          document_xml = Document.new(file)
-          file.close
+          document_xml = File.open(file_contents) { |file| Document.new(file) }
           load_entities(document_xml)
         end
 

data/lib/gyro/template.rb

@@ -12,24 +12,56 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'yaml'
+
 module Gyro
   # Gyro Template Helper
   #
   module Template
+    # Print template list representation
+    #
     def self.print_list
-      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
+      directories = Gyro::Template.directory.children.select(&:directory?).map(&:basename).map(&:to_s)
+      deprecated = select_deprecated_templates(directories)
+      non_deprecated = select_non_deprecated_templates(directories)
+      print_templates(non_deprecated.sort + deprecated.sort)
+    end
+
+    # Select deprecated templates from the config file
+    #
+    # @param [Array<String>] directories
+    #        The array of directories name
+    # @return [Array<String>]
+    #         The array of deprecated templates
+    #
+    def self.select_deprecated_templates(directories)
+      config['deprecated'].select { |t| config['alias'].key?(t) || directories.include?(t) }
+    end
+
+    # Select non deprecated templates from the template directory and the config file
+    #
+    # @param [Array<String>] directories
+    #        The array of directories name
+    # @return [Array<String>]
+    #         The array of non deprecated templates
+    #
+    def self.select_non_deprecated_templates(directories)
+      (directories + config['alias'].keys).reject { |t| config['deprecated'].include?(t) }
+    end
+
+    def self.print_templates(array)
+      array.each do |name|
+        alias_target = Gyro::Template.resolve_alias(name)
+        is_deprecated = config['deprecated'].include?(name)
+        txt = [' - ']
+        txt << name.colorize(is_deprecated ? :gray : :normal)
+        if alias_target
+          txt << ' (alias for '.colorize(:gray, :faint)
+          txt << alias_target.colorize(:gray)
+          txt << ')'.colorize(:gray, :faint)
         end
+        txt << ' (deprecated)'.colorize(:yellow) if is_deprecated
+        puts txt.join
       end
     end
 
@@ -50,28 +82,14 @@ module Gyro
 
     # @param [Pathname] entry
     #        The alias to resolve
-    # @return [(String, String)]
-    #         A 2-items array of [the alias name, the alias target name]
+    # @return [String]
+    #         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)
+    def self.resolve_alias(name)
+      target = config['alias'][name]
+      return nil unless target
+      target
     end
 
     # @param [String] template_param
@@ -108,9 +126,15 @@ module Gyro
     #         The path to the template corresponding to that name or path
     #
     def self.find_by_name(name)
-      _, target = Gyro::Template.resolve_alias_name(name)
+      target = Gyro::Template.resolve_alias(name)
       template_dir = Gyro::Template.directory + (target || name)
       return template_dir if template_dir.directory?
     end
+
+    # Hash of Yaml config for templates
+    #
+    def self.config
+      @config ||= YAML.load_file(Gyro::Template.directory + 'config.yml')
+    end
   end
 end

data/lib/gyro/version.rb

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

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

@@ -8,13 +8,15 @@
 
 If you want to use this template you need to work with `Realm`.
 
-# Characteristics
+# Customization
 
-In this template you have additional parameters to inject constants : 
+You can use the following parameters to inject custom values to this template (using `--param KEY:VALUE` on the command line): 
 
-- package (ex : **com.gyro.model.realm**)
-- use_wrappers (define if you want to use wrapper types (ex Boolean) instead of primitive types (ex boolean) when you attribute is **optional** inside xcdatamodel)
-- support_annotations (you can define annotation for properties ex : **@android.support.annotation.IntRange(from=0,to=255)** or **@android.support.annotation.Nullable**)
+| Parameter Key | Description |
+|---------------|-------------|
+| `package`     | The Android package in which the generated files will be generated (e.g. "`com.gyro.model.realm`") |
+| `use_wrappers` | Define this to `true` if you want to use wrapper types (e.g. `Boolean`) instead of primitive types (e.g. `boolean`) when your attribute is **optional** inside xcdatamodel |
+| `support_annotations` | Define this to `true` to generate `@android.support.annotation`s for properties (e.g. `@android.support.annotation.IntRange(from=0,to=255)`, `@android.support.annotation.Nullable`, etc) |
 
 # Usage
 
@@ -161,4 +163,4 @@ public class Product extends RealmObject {
         this.price = price;
     }
 }
-```
+```

data/lib/templates/android-java/inc/_relationships_enum.liquid

@@ -3,6 +3,9 @@
     public static final class Relationships {
     {%- for relationship in entity.relationships -%}
       {%- if relationship.inverse == false %}
+        {%- if relationship.comment.size > 0 %}
+        // {{ relationship.comment }}
+        {%- endif %}
         public static final String {{ relationship.name | snake_case | upcase }} = "{{ relationship.name }}";
       {%- endif -%}
     {%- endfor  %}

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

@@ -8,11 +8,13 @@
 
 If you want to use this template you need to work with `Realm`.
 
-# Characteristics
+# Customization
 
-In this template you have additional parameters to inject constants : 
+You can use the following parameters to inject custom values to this template (using `--param KEY:VALUE` on the command line): 
 
-- package (ex : **com.gyro.model.realm**)
+| Parameter Key | Description |
+|---------------|-------------|
+| `package`     | The Android package in which the generated files will be generated (e.g. "`com.gyro.model.realm`") |
 
 # Usage
 
@@ -35,20 +37,20 @@ package com.gyro.model.realm
 
 import io.realm.RealmObject
 
-class FidelityCard: RealmObject() {
+open class FidelityCard: RealmObject() {
 
     object Attributes {
-        const val IDENTIFIER: String = "identifier";
-        const val POINTS: String = "points";
+        const val IDENTIFIER: String = "identifier"
+        const val POINTS: String = "points"
     }
 
     object Relationships {
-        const val USER: String = "user";
+        const val USER: String = "user"
     }
 
-    private var identifier: Short = 0;
-    private var points: Integer = 0;
-    private var user: User? = null;
+    private var identifier: Short = 0
+    private var points: Integer = 0
+    private var user: User? = null
 }
 ```
 

data/lib/templates/android-kotlin/enum.liquid

@@ -21,7 +21,7 @@ enum class {{ attribute.enum_type }}(val jsonValue: String) {
 
     companion object {
         @JvmStatic
-        fun get(jsonValue: String): {{ attribute.enum_type }}? {
+        fun get(jsonValue: String?): {{ attribute.enum_type }}? {
             return {{ attribute.enum_type }}.values().firstOrNull { it.jsonValue == jsonValue }
         }
     }

data/lib/templates/android-kotlin/inc/_relationships_enum.liquid

@@ -3,6 +3,9 @@
     object Relationships {
     {%- for relationship in entity.relationships -%}
       {%- if relationship.inverse == false %}
+        {%- if relationship.comment.size > 0 %}
+        // {{ relationship.comment }}
+        {%- endif %}
         const val {{ relationship.name | snake_case | upcase }}: String = "{{ relationship.name }}"
       {%- endif -%}
     {%- endfor  %}

data/lib/templates/config.yml

@@ -0,0 +1,25 @@
+alias:
+  #   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.
+  android: android-java
+  #   The template named 'anviking-decodable' was originally just named 'decodable'
+  #   as it was made to generate JSON parsing code using the Anviking/Decodable pod.
+  #
+  #   But now that Swift 4 has protocol Decodable, this template name is confusing,
+  #   so we decided to rename it anviking-decodable and deprecate the old name,
+  #   so that when we have time to create a template for Swift 4's Codable there
+  #   won't be any risk of confusion.
+  decodable: anviking-decodable
+  #   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
+  swift4: swift3
+deprecated:
+  - object-mapper
+  - swift3-variant
+  - android   # renamed android-java
+  - decodable # renamed anviking-decodable
+  

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

@@ -10,9 +10,11 @@
 
 When you need to work with `ObjectMapper` and `Realm` together
 
-# Characteristics
+# Description
 
-In this template optional Realm objects (Attributes - RealmOptional - or Relationships - List<> -) are var properties :
+In this template optional Realm objects (Attributes - RealmOptional - or Relationships - List<> -) are var properties.
+
+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.
 
 ```
 // Attribute generation
@@ -32,8 +34,6 @@ 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`
@@ -60,4 +60,4 @@ final class Product: Object {
   var users = List<Users>()
 }
 
-```
+```

data/lib/templates/swift3-variant/entity.liquid

@@ -3,6 +3,9 @@
 import RealmSwift
 import Foundation
 
+{% if entity.comment.size > 0 -%}
+/// {{ entity.comment }}
+{% endif -%}
 final class {{ entity.name }}: Object {
     {%- include 'inc/attributes_enum' -%}
     {% include 'inc/relationships_enum' -%}

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

@@ -4,7 +4,7 @@
     {%- for attribute in entity.attributes -%}
         {%- if attribute.realm_ignored or attribute.realm_read_only.size == 0 -%}
             {%- if attribute.comment.size > 0 %}
-    /** {{ attribute.comment }} **/
+    /// {{ attribute.comment }}
             {%- endif %}
     case {{ attribute.name }} = "{{ attribute.name | escape_quotes }}"
         {%- endif %}

data/lib/templates/swift3-variant/inc/_relationships_enum.liquid

@@ -11,6 +11,9 @@
         {%- endif -%}
 			{%- endcapture -%}
       {%- assign relationship_name = relationship_name %}
+        {%- if relationship.comment.size > 0 %}
+    /// {{ relationship.comment }}
+        {%- endif %}
     case {{ relationship_name | uncapitalize }} = "{{ relationship_name | escape_quotes }}"
     {%- endfor %}
   }

data/lib/templates/swift3/README.md

@@ -11,9 +11,17 @@
 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`
 
-# Characteristics
+# Customization
 
-In this template optional Realm objects (Attributes - RealmOptional - or Relationships - List<> -) are `let` properties (conform to the Realm documentation) :
+You can use the following parameters to inject custom values to this template (using `--param KEY:VALUE` on the command line): 
+
+| Parameter Key | Description |
+|---------------|-------------|
+| `public`       | If set to true, every generated model and properties will be declared `public`. Otherwise it will not be annotated with access scope keyword, so will default to `internal` |
+
+# Description
+
+In this template, optional Realm objects (Attributes - RealmOptional - or Relationships - List<> -) are `let` properties (which is conform to the Realm documentation). This is the template to use when you use RealmSwift.
 
 ```
 // Attribute generation

data/lib/templates/swift3/entity.liquid

@@ -3,7 +3,7 @@
 import RealmSwift
 import Foundation
 
-final class {{ entity.name }}: Object {
+{% if params.public %}public {% endif %}final class {{ entity.name }}: Object {
     {%- include 'inc/attributes_enum' -%}
     {% include 'inc/relationships_enum' -%}
     {% include 'inc/attributes_properties' %}

data/lib/templates/swift3/enum.liquid

@@ -1,7 +1,7 @@
 {%- if attribute.enum_type.size > 0 -%}
 /* DO NOT EDIT | Generated by gyro */
 
-enum {{ params.prefix }}{{ attribute.enum_type }}: String {
+{% if params.public %}public {% endif %}enum {{ params.prefix }}{{ attribute.enum_type }}: String {
 {%- for value in attribute.enum_values %}
   {%- if attribute.enum_values.size > 0 %}
   {% assign jsonKey = value -%}

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

@@ -1,6 +1,6 @@
 
 {% if entity.attributes.size > 0 %}
-  enum Attributes: String {
+  {% if params.public %}public {% endif %}enum Attributes: String {
     {%- for attribute in entity.attributes -%}
         {%- if attribute.realm_ignored or attribute.realm_read_only.size == 0 -%}
             {%- if attribute.comment.size > 0 %}

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

@@ -18,7 +18,7 @@
       {%- 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 -%}
+  @objc {% if params.public %}public {% endif %}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/_enum_attribute_property.liquid

@@ -1,13 +1,13 @@
   {%- if attribute.optional == true %}
 
-  @objc dynamic var {{ attribute.name }}: String?
+  @objc {% if params.public %}public {% endif %}dynamic var {{ attribute.name }}: String?
   {%- else %}
 
-  @objc dynamic var {{ attribute.name }}: String = ""
+  @objc {% if params.public %}public {% endif %}dynamic var {{ attribute.name }}: String = ""
   {%- endif %}
   {%- assign enum_type = attribute.enum_type %}
   {%- assign enum_name = attribute.name %}
-  var {{ enum_name }}Enum: {{ enum_type | delete_objc_prefix }}? {
+  {% if params.public %}public {% endif %}var {{ enum_name }}Enum: {{ enum_type | delete_objc_prefix }}? {
     get {
       {%- if attribute.optional == true %}
       guard let {{ attribute.name }} = {{ attribute.name }},

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

@@ -1,6 +1,6 @@
 {%- if entity.has_ignored == true %}
   // Specify properties to ignore (Realm won't persist these)
-  override static func ignoredProperties() -> [String] {
+  override {% if params.public %}public {% endif %}static func ignoredProperties() -> [String] {
     return [
     {%- capture enum_ignored_properties -%}
       {%- for attribute in entity.attributes -%}

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

@@ -1,6 +1,6 @@
 {%- if entity.has_indexed_attributes == true %}
 	// Specify properties to index
-	override static func indexedProperties() -> [String] {
+	override {% if params.public %}public {% endif %}static func indexedProperties() -> [String] {
 		return [
 			{%- capture enum_indexed_properties -%}
 				{%- for attribute in entity.attributes -%}

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

@@ -2,10 +2,10 @@
 	{%- if relationship.inverse == true %}
 	{% assign name_size = relationship.name | size | minus: 1 %}
 		{%- if relationship.type == "to_many" %}
-  let {{ relationship.name | truncate: name_size, '' }}s = LinkingObjects(fromType: {{ relationship.inverse_type }}.self, property: "{{ relationship.inverse_name }}")
+  {% if params.public %}public {% endif %}let {{ relationship.name | truncate: name_size, '' }}s = LinkingObjects(fromType: {{ relationship.inverse_type }}.self, property: "{{ relationship.inverse_name }}")
 		{%- else %}
-  let {{ relationship.name | truncate: name_size, '' }}s = LinkingObjects(fromType: {{ relationship.inverse_type }}.self, property: "{{ relationship.inverse_name }}")
-  var {{ relationship.name | truncate: name_size, '' }}: {{ relationship.inverse_type }}? { return {{ relationship.name | truncate: name_size, '' }}s.first }
+  {% if params.public %}public {% endif %}let {{ relationship.name | truncate: name_size, '' }}s = LinkingObjects(fromType: {{ relationship.inverse_type }}.self, property: "{{ relationship.inverse_name }}")
+  {% if params.public %}public {% endif %}var {{ relationship.name | truncate: name_size, '' }}: {{ relationship.inverse_type }}? { return {{ relationship.name | truncate: name_size, '' }}s.first }
 		{%- 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 }}>(){%- if attribute.name == entity.identity_attribute %} /* Primary Key */{% endif -%}
+  {% if params.public %}public {% endif %}let {{ attribute.name }} = RealmOptional<{{ convert_type }}>(){%- if attribute.name == entity.identity_attribute %} /* Primary Key */{% endif -%}
 {%- else %}
-  @objc dynamic var {{ attribute.name }}: {{ convert_type }}?{%- if attribute.name == entity.identity_attribute %} /* Primary Key */{% endif -%}
+  @objc {% if params.public %}public {% endif %}dynamic var {{ attribute.name }}: {{ convert_type }}?{%- if attribute.name == entity.identity_attribute %} /* Primary Key */{% endif -%}
 {%- endif -%}

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

@@ -1,5 +1,5 @@
 {%- if entity.has_primary_key == true %}
-  override static func primaryKey() -> String? {
+  override {% if params.public %}public {% endif %}static func primaryKey() -> String? {
     return "{{ entity.identity_attribute }}"
   }
 {% endif -%}

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

@@ -1,9 +1,9 @@
 {%- for relationship in entity.relationships -%}
 {%- if relationship.inverse == false %}
   {%- if relationship.type == "to_many" %}
-  let {{ relationship.name }} = List<{{ relationship.inverse_type }}>()
+  {% if params.public %}public {% endif %}let {{ relationship.name }} = List<{{ relationship.inverse_type }}>()
   {%- else %}
-  @objc dynamic var {{ relationship.name }}: {{ relationship.inverse_type }}?
+  @objc {% if params.public %}public {% endif %}dynamic var {{ relationship.name }}: {{ relationship.inverse_type }}?
   {%- endif %}
 {%- endif %}
 {%- endfor -%}

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

@@ -1,5 +1,5 @@
 {%- if entity.relationships.size > 0 and entity.has_only_inverse == false %}
-  enum Relationships: String {
+  {% if params.public %}public {% endif %}enum Relationships: String {
     {%- for relationship in entity.relationships %}
       {%- capture relationship_name -%}
         {%- if relationship.inverse == true -%}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gyro
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - NijiDigital
@@ -109,12 +109,12 @@ 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.alias
-- lib/templates/decodable/README.md
-- lib/templates/decodable/entity.liquid
-- lib/templates/decodable/entity_filename.liquid
-- lib/templates/decodable/enum.liquid
-- lib/templates/decodable/enum_filename.liquid
+- lib/templates/anviking-decodable/README.md
+- lib/templates/anviking-decodable/entity.liquid
+- lib/templates/anviking-decodable/entity_filename.liquid
+- lib/templates/anviking-decodable/enum.liquid
+- lib/templates/anviking-decodable/enum_filename.liquid
+- lib/templates/config.yml
 - lib/templates/object-mapper/README.md
 - lib/templates/object-mapper/entity.liquid
 - lib/templates/object-mapper/entity_filename.liquid
@@ -154,7 +154,6 @@ 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

data/lib/templates/android.alias

@@ -1,10 +0,0 @@
-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/swift4.alias

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