underscore_params 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b3becd47ba00ca0a65525b288f3f21389cefaff0
+  data.tar.gz: ef05bc94877a0c4d2d49cbd3721b0d996e1c0fa0
+SHA512:
+  metadata.gz: 3604b1c20038bb6edf1eda8e9a1d0b9ba8d93cfa88dcc9331d7536977afe6d68a6d80909b9163d62443b987bac0e7991212bbb48adcbf04dd79385253199c06f
+  data.tar.gz: 006bbcd6135419e32b5cef91bee0a481db49ac3aac71573be930f616d045e764d20b330f6502938f397c50aa9a30f4df64212c0fd34c57bb81552aa3ae0c4460

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "bundler", "~> 1.5"
+gem "rake"
+# Specify your gem's dependencies in underscore_params.gemspec
+gemspec

data/README.md

@@ -0,0 +1,40 @@
+# Underscore Params
+
+Forces all param keys in Rails to be underscored. eg
+
+    {'anObject' => 'value'} turns into {'an_object' => 'value'}
+
+Will underscore all param keys including deeply nested ones.
+
+Helpful if you do not have control over the view layer / what params are being sent to the application and don't want to complicate controllers / models with conversion logic.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'underscore_params'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install underscore_params
+
+## Usage
+
+* Just reference in Gemfile
+* Works for Rails 4+ (not tested on earlier versions)
+
+## Contributing
+
+1. Fork it ( http://github.com/ansonK/underscore_params/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Underscore Params is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/underscore_params/action_dispatch/http/underscore_params.rb

@@ -0,0 +1,43 @@
+module ActionDispatch
+  module Http
+
+    #
+    # Overrides the default params method on ActionDispatch::Request to underscore all keys
+    # (request.params is aliased to parameters)
+    #
+    # Should be included into ActionDispatch::Request after the standard Rails modules
+    #
+    module UnderscoreParams
+
+      #
+      # Processes parameters by underscoring all hash keys
+      #
+      def parameters
+        underscore_keys super
+      end
+
+      private
+        
+      #
+      # Underscores all key values in both Hashes and Hashes in arrays.
+      # Other values are not modified
+      #
+      # @param value [Object] The value to be processed
+      #
+      def underscore_keys(value)
+        case value
+          when Array
+            value.map { |v| underscore_keys(v) }
+          when Hash
+            Hash[value.map { |k, v| [underscore_key(k), underscore_keys(v)] }]
+          else
+            value
+        end
+      end
+
+      def underscore_key(val)
+        val.to_s.underscore
+      end
+    end
+  end
+end

data/lib/underscore_params/railtie.rb

@@ -0,0 +1,9 @@
+module UnderscoreParams
+  class Railtie < Rails::Railtie
+    initializer "underscore_params.configure_controller" do |app|
+      ActiveSupport.on_load :action_controller do
+        ActionDispatch::Request.send :include, ActionDispatch::Http::UnderscoreParams
+      end
+    end
+  end
+end

data/lib/underscore_params/version.rb

@@ -0,0 +1,3 @@
+module UnderscoreParams
+  VERSION = "0.0.1"
+end

data/lib/underscore_params.rb

@@ -0,0 +1,8 @@
+require 'active_support/core_ext/string/inflections'
+require "underscore_params/version"
+require "underscore_params/action_dispatch/http/underscore_params"
+require 'underscore_params/railtie' if defined?(Rails)
+
+module UnderscoreParams
+  # Your code goes here...
+end

data/test/underscore_params_test.rb

@@ -0,0 +1,58 @@
+require 'minitest'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'underscore_params'
+
+#
+# Mymics the setup of how ActionDispatch::Request has a Parameters module included
+#
+module UnderscoreTest
+  module Parameters
+    def parameters
+      parameter_values
+    end
+  end
+
+  class TestController
+    attr_accessor :parameter_values
+    include Parameters
+    include ActionDispatch::Http::UnderscoreParams
+  end
+end
+
+describe ActionDispatch::Http::UnderscoreParams do
+  before do
+    @controller = UnderscoreTest::TestController.new
+  end
+
+  it 'underscores camelCase keys' do
+    @controller.parameter_values = {'firstName' => 'Bob'}
+    @controller.parameters.must_equal({'first_name' => 'Bob'})
+  end
+
+  it 'underscores camelCase keys in nested objects' do
+    @controller.parameter_values = {'objName' => {'firstName' => 'Bob'} }
+    @controller.parameters.must_equal({'obj_name' => {'first_name' => 'Bob'}})
+  end
+
+  it 'underscores camelCase keys in deeply nested objects' do
+   @controller.parameter_values = {"type"=>"Birth",
+       "text"=>"This is when I was born",
+       "date"=>"1980-01-01",
+       "locations"=>{},
+       "persons"=>
+        {"person"=>
+          {"firstName"=>"Bob",
+           "middleNames"=>"Billy Joe"
+          }
+        }
+      }
+    
+    @controller.parameters['persons']['person'].must_equal({'first_name' => 'Bob', 'middle_names' => 'Billy Joe'})
+  end
+
+  it 'underscores keys nested in arrays' do
+    @controller.parameter_values = {'objName' => [{'firstName' => 'Bob'}] }
+    @controller.parameters.must_equal({'obj_name' => [{'first_name' => 'Bob'}]})
+  end
+end

data/underscore_params.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'underscore_params/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "underscore_params"
+  spec.version       = UnderscoreParams::VERSION
+  spec.authors       = ["Anson Kelly"]
+  spec.email         = ["ansonkelly@gmail.com"]
+  spec.summary       = %q{Forces all rails request params to be underscored.}
+  spec.description   = %q{Forces all rails request params (both GET and POST) to be underscored.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", '>= 3'
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: underscore_params
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anson Kelly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Forces all rails request params (both GET and POST) to be underscored.
+email:
+- ansonkelly@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/underscore_params.rb
+- lib/underscore_params/action_dispatch/http/underscore_params.rb
+- lib/underscore_params/railtie.rb
+- lib/underscore_params/version.rb
+- test/underscore_params_test.rb
+- underscore_params.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Forces all rails request params to be underscored.
+test_files:
+- test/underscore_params_test.rb