snake-eyes 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e864c134f12799380649a3f8e1ac71078a5da5f0
-  data.tar.gz: eeaeffe93ed1ab87c316167986230f6ce3a66409
+  metadata.gz: 608b97ebdffcc0a5e2c79262979b570ea455963f
+  data.tar.gz: 622937869fcafdccbf955b96d682b0472731c615
 SHA512:
-  metadata.gz: 8ce2f7325ff93e48f4eddb75beee3515ec16a94e3fc944fcbcb53a6ddd44e12925d31bdf8c43e4133329a915d36aec461325dcac586b5d37c252b58c6dfbdda8
-  data.tar.gz: ae13b1c19fe7b78909336fe32733443ddc0f486aea27359a223dd366fd6143544a4380a663c784d91b3b0d5877e741379b6e86bd63a5e1c8a5026cc2325953fb
+  metadata.gz: f1b4e57dbe7aa3fcb3c627bdd7792d9053661f19119773515cd0122eb3115dab84f6f17be9e53f89b52e379b329ce2511cc16dee63f1c8ede5434d8983db2bd8
+  data.tar.gz: 2d8da38d611a261a32011bf6a9d59de6e161fc4766e5c6acd6ddf0679e349e1ac1f7f44ba1ef83c9d8a2ce7bebb1656caecdb9a813e69981cb43f751fff0f3e3

data/README.md

@@ -8,6 +8,8 @@ Automatically convert between camel case APIs to snake case for your Rails code
 
 If you are using a version below `0.0.4`, please upgrade to avoid [potentially logging sensitive user information](https://github.com/greena13/snake-eyes/issues/1)
 
+🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧🚧
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -27,7 +29,7 @@ class JsonController < ApplicationController
   snake_eyes_params
 
   def show
-    #reference the params hash as normal
+    #reference the params method as normal
   end
 end
 ```
@@ -90,6 +92,24 @@ To specify nested objects that should not have the `_attributes` suffix (but con
   end
  ```
 
+## Limitations
+
+SnakeEyes does *not* currently handle the following aspects of converting a JSON API to a Rails-compatible one:
+
+**Converting arrays of objects to hashes, keyed by item indexes**
+
+Fox example:
+
+```JSON
+{
+    "a": [
+        { "b": 1 },
+        { "b": 2 },
+        { "b": 3 }
+    ]
+}
+```
+
 ## Configuration
 
 By default SnakeEyes logs the snake case parameters to the Rails console. You can prevent this behaviour by configuring the gem:

data/lib/snake-eyes/interface_changes.rb

@@ -24,7 +24,7 @@ module SnakeEyes
 
       @previous_params ||= { }
 
-      return @previous_params[nested_schema] if @previous_params[nested_schema]
+      # return @previous_params[nested_schema] if @previous_params[nested_schema]
 
       # Similar to original_params_sub_trees, a list of subtrees used to maintain
       # the traversal position of nested_schema. This is kept in sync with the
@@ -36,8 +36,18 @@ module SnakeEyes
       ]
 
       transformed_params = original_params.deep_transform_keys do |original_key|
-        # The matching leaf of nested_schema for this point in the traversal
-        nested_schema_sub_tree = nested_schema_sub_trees.last
+        # Synchronise the original params sub-tree with the current key being
+        # transformed. We can detect that the sub-tree is stale because the key
+        # being transformed does not appear amongst its own. When the sub-tree is
+        # indeed stale, move the position to its parent for the original params
+        # sub-tree and the nested schema sub-tree and repeat the check.
+
+        while original_params_sub_trees.length > 1 && original_params_sub_trees.last[original_key].nil?
+          original_params_sub_trees.pop
+          nested_schema_sub_trees.pop
+        end
+
+        original_params_sub_tree = original_params_sub_trees.last[original_key]
 
         # Append the '_attributes' suffix if the original params key has the
         # same name and is nested in the same place as one mentioned in the
@@ -46,31 +56,18 @@ module SnakeEyes
         transformed_key_base = original_key.underscore
 
         transformed_key =
-            if nested_schema_sub_tree[transformed_key_base]
+            if nested_schema_sub_trees.last[transformed_key_base]
               transformed_key_base + '_attributes'
             else
               transformed_key_base
             end
 
-        # Synchronise the original params sub-tree with the current key being
-        # transformed. We can detect that the sub-tree is stale because the key
-        # being transformed does not appear amongst its own. When the sub-tree is
-        # indeed stale, move the position to its parent for the original params
-        # sub-tree and the nested schema sub-tree and repeat the check.
-
-        while original_params_sub_trees.length > 1 && original_params_sub_trees.last[original_key].nil?
-          original_params_sub_trees.pop
-          nested_schema_sub_trees.pop
-        end
-
-        original_params_sub_tree = original_params_sub_trees.last[transformed_key_base]
-
         if original_params_sub_tree.kind_of?(Hash)
           original_params_sub_trees.push(original_params_sub_tree)
 
           nested_schema_sub_trees.push(
-              nested_schema_sub_tree[transformed_key_base] ||
-                  nested_schema_sub_tree['_' + transformed_key_base] ||
+              nested_schema_sub_trees.last[transformed_key_base] ||
+                  nested_schema_sub_trees.last['_' + transformed_key_base] ||
                   {}
           )
         end

data/lib/snake-eyes/version.rb

@@ -1,3 +1,3 @@
 module SnakeEyes
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snake-eyes
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Aleck Greenham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-26 00:00:00.000000000 Z
+date: 2017-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler