Merge pull request #71 from NijiDigital/feature/decodable-rename

Renamed decodable template to anviking-decodable
NijiDigital · Jul 24, 2018 · 25eba9f · 25eba9f
2 parents 745d6ff + 962b205
commit 25eba9f
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,12 +16,15 @@
 * Improve error and warning messages when targetting an xcdatamodeld.  
   [Steven Watremez](https://github.com/StevenWatremez)
   [#53](https://github.com/NijiDigital/gyro/pull/53)
-- Fix nullable enum methods in android-kotlin.  
+* Fix nullable enum methods in android-kotlin.  
   [Xavier F. Gouchet](https://github.com/xgouchet)
   [#68](https://github.com/NijiDigital/gyro/pull/68)
-- Add a `--param public:true` param on `swift3`/`swift4` template to make generated code `public` instead of `internal`.  
+* Add a `--param public:true` param on `swift3`/`swift4` template to make generated code `public` instead of `internal`.  
   [Olivier Halligon](https://github.com/AliSoftware)
   [#70](https://github.com/NijiDigital/gyro/pull/70)
+* Renamed template `decodable` to `anviking-decodable` to avoid confusion with Swift 4's Codable (for which we don't have a template… yet).  
+  [Olivier Halligon](https://github.com/AliSoftware)
+  [#71](https://github.com/NijiDigital/gyro/pull/71)
 
 
 ## 1.4.0

diff --git a/lib/templates/decodable/README.md → lib/templates/anviking-decodable/README.md b/lib/templates/decodable/README.md → lib/templates/anviking-decodable/README.md
diff --git a/lib/templates/decodable/entity.liquid → ...emplates/anviking-decodable/entity.liquid b/lib/templates/decodable/entity.liquid → ...emplates/anviking-decodable/entity.liquid
diff --git a/...emplates/decodable/entity_filename.liquid → ...anviking-decodable/entity_filename.liquid b/...emplates/decodable/entity_filename.liquid → ...anviking-decodable/entity_filename.liquid
diff --git a/lib/templates/decodable/enum.liquid → lib/templates/anviking-decodable/enum.liquid b/lib/templates/decodable/enum.liquid → lib/templates/anviking-decodable/enum.liquid
diff --git a/lib/templates/decodable/enum_filename.liquid → ...s/anviking-decodable/enum_filename.liquid b/lib/templates/decodable/enum_filename.liquid → ...s/anviking-decodable/enum_filename.liquid
diff --git a/lib/templates/config.yml b/lib/templates/config.yml
@@ -6,11 +6,20 @@ alias:
   #   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
+  - android   # renamed android-java
+  - decodable # renamed anviking-decodable
 
diff --git a/spec/gyro/liquid_generator_swift_spec.rb b/spec/gyro/liquid_generator_swift_spec.rb
@@ -14,7 +14,7 @@
 
 SWIFT3_TEMPLATE_DIR = 'lib/templates/swift3'.freeze
 OBJMAPPER_TEMPLATE_DIR = 'lib/templates/object-mapper'.freeze
-DECODABLE_TEMPLATE_DIR = 'lib/templates/decodable'.freeze
+DECODABLE_TEMPLATE_DIR = 'lib/templates/anviking-decodable'.freeze
 
 module Gyro
   describe 'Liquid' do