snake-eyes 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5fae63d42cba9d54bdc028a5faf8d63d7b48b238
-  data.tar.gz: b0abda0615edcd1d1b266755015e2e249c41950d
+  metadata.gz: e864c134f12799380649a3f8e1ac71078a5da5f0
+  data.tar.gz: eeaeffe93ed1ab87c316167986230f6ce3a66409
 SHA512:
-  metadata.gz: 377e94c1eb0a2f12c477a89a661eeda7529f38d86147814c5ca412847b64bedca2d36b78e857d73104a9e7f6980f0ea050d1b689ff828ed2d10b8281152d4a44
-  data.tar.gz: 1f23f3f3a5661bb09b63c24f1b4ebaeb056884087fc666e93f805312450ba23c04c0f4dbca2976522ade9c17919b07dbe08f61c137d040284659d6d90bb6f6d9
+  metadata.gz: 8ce2f7325ff93e48f4eddb75beee3515ec16a94e3fc944fcbcb53a6ddd44e12925d31bdf8c43e4133329a915d36aec461325dcac586b5d37c252b58c6dfbdda8
+  data.tar.gz: ae13b1c19fe7b78909336fe32733443ddc0f486aea27359a223dd366fd6143544a4380a663c784d91b3b0d5877e741379b6e86bd63a5e1c8a5026cc2325953fb

data/README.md

@@ -6,7 +6,7 @@ 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)  
+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
 
@@ -45,8 +45,8 @@ Once `snake_eyes_params` has been enabled for a controllor, `params` accepts an
        #    'user' => {
        #      'name' => 'John Smith',
        #      'favouriteColor' => 'blue',
-       #      'address' => { '123 street' },
-       #      'billingAddress' => { '456 road' }
+       #      'address' => { line1: '123 street' },
+       #      'billingAddress' => { line1: '456 road' }
        #    }
        #}
     end
@@ -61,8 +61,8 @@ Once `snake_eyes_params` has been enabled for a controllor, `params` accepts an
         #    'user_attributes' => {
         #      'name' => 'John Smith',
         #      'favourite_color' => 'blue',
-        #      'address_attributes' => { '123 street' },
-        #      'billing_address_attributes' => { '456 road' }
+        #      'address_attributes' => { line1: '123 street' },
+        #      'billing_address_attributes' => { line1: '456 road' }
         #    }
         #}
      end
@@ -82,8 +82,8 @@ To specify nested objects that should not have the `_attributes` suffix (but con
         #    'user' => {
         #      'name' => 'John Smith',
         #      'favourite_color' => 'blue',
-        #      'address_attributes' => { '123 street' },
-        #      'billing_address_attributes' => { '456 road' }
+        #      'address_attributes' => { 'line1: 123 street' },
+        #      'billing_address_attributes' => { line1: '456 road' }
         #    }
         #}
      end

data/lib/snake-eyes/interface_changes.rb

@@ -3,49 +3,82 @@ module SnakeEyes
     def params(options = {})
       validate_options(options)
 
-      untransformed_params = super()
+      original_params = super()
 
-      traverse_positions = [
-          untransformed_params
+      return original_params unless original_params.any?
+
+      # List of subtrees maintained to mark the depth-first traversal's position
+      # throughout the transformation of the original param's keys, whereby the
+      # last element is the traversal's current position and backtracking (going
+      # from child to parent) is achieved by popping off the last element.
+
+      original_params_sub_trees = [
+          original_params
       ]
 
-      nested_attributes = nested_attributes_hash(options[:nested_attributes])
+      # Convert the relatively flat format used to specify the nested attributes
+      # (easier for specification) into a series of nested objects (easier for
+      # look-ups)
+
+      nested_schema = build_nested_schema(options[:nested_attributes] || {})
+
+      @previous_params ||= { }
 
-      nested_attributes_positions = [
-          nested_attributes
+      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
+      # traversal of original_params, to ensure the correct leaf of
+      # nested_schema is checked at each point in the traversal of original_params
+
+      nested_schema_sub_trees = [
+        nested_schema
       ]
 
-      transformed_params = untransformed_params.deep_transform_keys do |key|
-        underscored_key = key.underscore
+      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
 
-        nested_attributes_position = nested_attributes_positions.last
+        # 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
+        # nested_attributes option
+
+        transformed_key_base = original_key.underscore
 
         transformed_key =
-            if nested_attributes_position[underscored_key]
-              underscored_key + '_attributes'
+            if nested_schema_sub_tree[transformed_key_base]
+              transformed_key_base + '_attributes'
             else
-              underscored_key
+              transformed_key_base
             end
 
-        while traverse_positions.length > 1 && traverse_positions.last[key].nil?
-          traverse_positions.pop
-          nested_attributes_positions.pop
+        # 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
 
-        current_position = traverse_positions.last[underscored_key]
+        original_params_sub_tree = original_params_sub_trees.last[transformed_key_base]
 
-        if current_position.kind_of?(Hash)
-          traverse_positions.push(current_position)
+        if original_params_sub_tree.kind_of?(Hash)
+          original_params_sub_trees.push(original_params_sub_tree)
 
-          nested_attributes_positions.push(
-              nested_attributes_position[underscored_key] || nested_attributes_position['_' + underscored_key] || {}
+          nested_schema_sub_trees.push(
+              nested_schema_sub_tree[transformed_key_base] ||
+                  nested_schema_sub_tree['_' + transformed_key_base] ||
+                  {}
           )
         end
 
         transformed_key
       end
 
-      @snake_eyes_params = ActionController::Parameters.new(transformed_params)
+      @previous_params[nested_schema] = @snake_eyes_params = ActionController::Parameters.new(transformed_params)
 
       log_snakized_params
 
@@ -62,26 +95,34 @@ module SnakeEyes
 
     def log_snakized_params
       if SnakeEyes.log_snake_eyes_parameters
+
         ignored_params = ActionController::LogSubscriber::INTERNAL_PARAMS
         filtered_params = request.send(:parameter_filter).filter(@snake_eyes_params.except(*ignored_params))
+
         logger.info "  SnakeEyes Parameters: #{filtered_params.inspect}"
       end
     end
 
-    def nested_attributes_hash(attributes_list = [])
+    def build_nested_schema(attributes_list = [])
 
       if attributes_list.kind_of?(Array)
+
         attributes_list.inject({}) do |memo, nested_attribute|
-          memo.merge(nested_attributes_hash(nested_attribute))
+          memo.merge(build_nested_schema(nested_attribute))
         end
+
       elsif attributes_list.kind_of?(Hash)
+
         attributes_list.inject({}) do |memo, key_and_value|
           key, value = key_and_value
-          memo[key.to_s] = nested_attributes_hash(value)
+          memo[key.to_s] = build_nested_schema(value)
           memo
         end
+
       else
+
         { attributes_list.to_s.underscore => {} }
+
       end
 
     end

data/lib/snake-eyes/version.rb

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

metadata

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