snake-eyes 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 762d71b565366e41521d8f983bcd79c8b59ac88f
-  data.tar.gz: 791a4488473c8d7f6c420f62535d66850d47062f
+  metadata.gz: 5fae63d42cba9d54bdc028a5faf8d63d7b48b238
+  data.tar.gz: b0abda0615edcd1d1b266755015e2e249c41950d
 SHA512:
-  metadata.gz: c92ef14af8e407beb2a802a35740d89f6e2f5455641d9c1e98680a82ee1af4f8119912c22fedf98845c018319ebc19fb8d0094ecb68e64f8517b85ec3bb8e693
-  data.tar.gz: 8298771aa45a3ed17ac71d5bc6a81a4ee54bc683d7a08977c36260e3b65efed8fb511417646da44f32c75df9b454e8154d91a78df7c21ca4bce68b5e33efe014
+  metadata.gz: 377e94c1eb0a2f12c477a89a661eeda7529f38d86147814c5ca412847b64bedca2d36b78e857d73104a9e7f6980f0ea050d1b689ff828ed2d10b8281152d4a44
+  data.tar.gz: 1f23f3f3a5661bb09b63c24f1b4ebaeb056884087fc666e93f805312450ba23c04c0f4dbca2976522ade9c17919b07dbe08f61c137d040284659d6d90bb6f6d9

data/README.md

@@ -20,18 +20,76 @@ And then execute:
 
 ## Usage
 
-To use SnakeEyes, simply add the following to the top of any controller in which you wish to have snake case parameters. All controllers that inherit from it shall also have the behaviour 
+To use SnakeEyes, simply add the following to the top of any controller in which you wish to have snake case parameters. All controllers that inherit from it shall also have the behaviour
 
 ```ruby
 class JsonController < ApplicationController
   snake_eyes_params
-  
+
   def show
-    #reference the params hash as normal  
+    #reference the params hash as normal
   end
 end
 ```
 
+### Dealing with nested params
+
+Once `snake_eyes_params` has been enabled for a controllor, `params` accepts an options hash, which can be used to specify which attributes should have the `_attributes` suffix appended.
+
+ ```ruby
+ class WithoutSnakeEyesController < ApplicationController
+
+    def show
+       params # results in:
+       # {
+       #    'user' => {
+       #      'name' => 'John Smith',
+       #      'favouriteColor' => 'blue',
+       #      'address' => { '123 street' },
+       #      'billingAddress' => { '456 road' }
+       #    }
+       #}
+    end
+ end
+
+ class WithSnakeEyesController < ApplicationController
+     snake_eyes_params
+
+     def show
+        params(nested_attributes: { user: [ :address, :billing_address ] }) # results in:
+        # {
+        #    'user_attributes' => {
+        #      'name' => 'John Smith',
+        #      'favourite_color' => 'blue',
+        #      'address_attributes' => { '123 street' },
+        #      'billing_address_attributes' => { '456 road' }
+        #    }
+        #}
+     end
+  end
+ ```
+
+To specify nested objects that should not have the `_attributes` suffix (but contain attributes that should), you can prefix them with an underscore:
+
+
+```ruby
+ class WithSnakeEyesController < ApplicationController
+     snake_eyes_params
+
+     def show
+        params(nested_attributes: { _user: [ :address, :billing_address ] }) # results in:
+        # {
+        #    'user' => {
+        #      'name' => 'John Smith',
+        #      'favourite_color' => 'blue',
+        #      'address_attributes' => { '123 street' },
+        #      'billing_address_attributes' => { '456 road' }
+        #    }
+        #}
+     end
+  end
+ ```
+
 ## 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

@@ -1,17 +1,89 @@
 module SnakeEyes
   module InterfaceChanges
-    def params
-      unless defined? @snake_eyes_params
-        @snake_eyes_params = ActionController::Parameters.new(super.deep_transform_keys(&:underscore))
-
-        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}"
+    def params(options = {})
+      validate_options(options)
+
+      untransformed_params = super()
+
+      traverse_positions = [
+          untransformed_params
+      ]
+
+      nested_attributes = nested_attributes_hash(options[:nested_attributes])
+
+      nested_attributes_positions = [
+          nested_attributes
+      ]
+
+      transformed_params = untransformed_params.deep_transform_keys do |key|
+        underscored_key = key.underscore
+
+        nested_attributes_position = nested_attributes_positions.last
+
+        transformed_key =
+            if nested_attributes_position[underscored_key]
+              underscored_key + '_attributes'
+            else
+              underscored_key
+            end
+
+        while traverse_positions.length > 1 && traverse_positions.last[key].nil?
+          traverse_positions.pop
+          nested_attributes_positions.pop
         end
+
+        current_position = traverse_positions.last[underscored_key]
+
+        if current_position.kind_of?(Hash)
+          traverse_positions.push(current_position)
+
+          nested_attributes_positions.push(
+              nested_attributes_position[underscored_key] || nested_attributes_position['_' + underscored_key] || {}
+          )
+        end
+
+        transformed_key
       end
 
+      @snake_eyes_params = ActionController::Parameters.new(transformed_params)
+
+      log_snakized_params
+
       @snake_eyes_params
     end
+
+    private
+
+    def validate_options(options)
+      options.keys.each do |key|
+        raise ArgumentError.new("SnakeEyes: params received unrecognised option '#{key}'") if key != :nested_attributes
+      end
+    end
+
+    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 = [])
+
+      if attributes_list.kind_of?(Array)
+        attributes_list.inject({}) do |memo, nested_attribute|
+          memo.merge(nested_attributes_hash(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
+        end
+      else
+        { attributes_list.to_s.underscore => {} }
+      end
+
+    end
   end
 end

data/lib/snake-eyes/version.rb

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

metadata

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