snake_params 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9940687d4a6605fde359d7cd49ad28eab0dec5bf
+  data.tar.gz: 2a746732434d6837cba196315a1698500e8ae952
+SHA512:
+  metadata.gz: d9df509e9ea26dc14918482dd2672af3e22f1b72bb4b5bcdd4d0d50b6b2950e49d0fbe6af09fb6316b633c712c80d5bec7704de5afd84fdae5e13c33ba14d77c
+  data.tar.gz: 1fa55b50a5fc7135e6d47cd7cef80047a086fee1ee51dea16196e0d4cab693bb3556e894bbff12ad24268fa7f78e12ae7a1d20c5a0f8ac3e4eea9c308e0b2010

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.overcommit.yml

@@ -0,0 +1,7 @@
+PreCommit:
+  Brakeman:
+    enabled: false # Disable Brakeman since this isn't a Rails app.
+  RailsSchemaUpToDate:
+    enabled: false
+  Reek:
+    enabled: false

data/.rubocop.yml

@@ -0,0 +1,256 @@
+AccessorMethodName:
+  Enabled: false
+
+Alias:
+  Enabled: false
+
+AmbiguousOperator:
+  Enabled: false
+
+AmbiguousRegexpLiteral:
+  Enabled: false
+
+ArrayJoin:
+  Enabled: false
+
+AsciiComments:
+  Enabled: false
+
+AsciiIdentifiers:
+  Enabled: false
+
+AssignmentInCondition:
+  Enabled: true
+
+Attr:
+  Enabled: false
+
+BlockNesting:
+  Enabled: false
+
+BracesAroundHashParameters:
+  Enabled: false
+
+CaseEquality:
+  Enabled: false
+
+CharacterLiteral:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+ClassVars:
+  Enabled: false
+
+CollectionMethods:
+  PreferredMethods:
+    find: detect
+    reduce: inject
+    collect: map
+    find_all: select
+
+ColonMethodCall:
+  Enabled: false
+
+CommentAnnotation:
+  Enabled: false
+
+ConditionPosition:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false
+
+Delegate:
+  Enabled: false
+
+DeprecatedClassMethods:
+  Enabled: false
+
+DeprecatedHashMethods:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+DotPosition:
+  EnforcedStyle: trailing
+
+DoubleNegation:
+  Enabled: false
+
+ElseLayout:
+  Enabled: false
+
+EmptyLiteral:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+EvenOdd:
+  Enabled: false
+
+FileName:
+  Enabled: false
+
+FlipFlop:
+  Enabled: false
+
+FormatString:
+  Enabled: false
+
+GlobalVars:
+  Enabled: false
+
+HandleExceptions:
+  Enabled: false
+
+IfUnlessModifier:
+  Enabled: false
+
+IfWithSemicolon:
+  Enabled: false
+
+InvalidCharacterLiteral:
+  Enabled: false
+
+Lambda:
+  Enabled: false
+
+LambdaCall:
+  Enabled: false
+
+LineEndConcatenation:
+  Enabled: false
+
+LineLength:
+  Max: 80
+
+LiteralInCondition:
+  Enabled: false
+
+LiteralInInterpolation:
+  Enabled: false
+
+Loop:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+ModuleFunction:
+  Enabled: false
+
+NegatedIf:
+  Enabled: false
+
+NegatedWhile:
+  Enabled: false
+
+Next:
+  Enabled: false
+
+NilComparison:
+  Enabled: false
+
+Not:
+  Enabled: false
+
+NumericLiterals:
+  Enabled: false
+
+OneLineConditional:
+  Enabled: false
+
+OpMethod:
+  Enabled: false
+
+ParameterLists:
+  Enabled: false
+
+ParenthesesAsGroupedExpression:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%': '{}'
+
+PerlBackrefs:
+  Enabled: false
+
+PredicateName:
+  NamePrefixBlacklist:
+    - is_
+
+Proc:
+  Enabled: false
+
+RaiseArgs:
+  Enabled: false
+
+RedundantReturn:
+  AllowMultipleReturnValues: true
+
+RegexpLiteral:
+  Enabled: false
+
+RequireParentheses:
+  Enabled: false
+
+SelfAssignment:
+  Enabled: false
+
+SignalException:
+  EnforcedStyle: only_raise
+
+SingleLineBlockParams:
+  Enabled: false
+
+SingleLineMethods:
+  Enabled: false
+
+SpecialGlobalVars:
+  Enabled: false
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+VariableInterpolation:
+  Enabled: false
+
+TrailingComma:
+  Enabled: false
+
+TrivialAccessors:
+  Enabled: false
+
+UnderscorePrefixedVariableName:
+  Enabled: false
+
+VariableInterpolation:
+  Enabled: false
+
+Void:
+  Enabled: false
+
+WhenThen:
+  Enabled: false
+
+WhileUntilModifier:
+  Enabled: false
+
+WordArray:
+  Enabled: false
+
+GuardClause:
+  Enabled: false
+
+# Renaming `has_something?` to `something?` obfuscates whether it is a "is-a" or
+# # a "has-a" relationship.
+PredicateName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+- 2.0.0
+- 2.1.4
+script: bundle exec rspec
+addons:
+  code_climate:
+    repo_token: b8adadfd37374a0514104b47bf5f0bd5a0755dca59a1aa04bccccb4e1c358e7e
+notifications:
+  email: false
+  hipchat:
+    rooms:
+      secure: K4ZW9PvT8I/aCBqHUVZQUZszutVFQwcDqJ7h9Y8wQ7E9HGvVh31ZtqJGhtBZb0SQUVgeyZb22i1uD2ci+HtMVIBOXg7p1n358leWEib+L7QjvP+N/ICWO3l8U6sFLfEhH0KfP68hzlwB8nC5kLSyxLkDKf38amOSTLqKq2EPqcI=

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in snake_params.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Panorama Education
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+[![Code Climate](https://codeclimate.com/github/panorama-ed/snake_params/badges/gpa.svg)](https://codeclimate.com/github/panorama-ed/snake_params)
+[![Test Coverage](https://codeclimate.com/github/panorama-ed/snake_params/badges/coverage.svg)](https://codeclimate.com/github/panorama-ed/snake_params) [![Build Status](https://travis-ci.org/panorama-ed/snake_params.svg)](https://travis-ci.org/panorama-ed/snake_params) [![Inline docs](http://inch-ci.org/github/panorama-ed/snake_params.png)](http://inch-ci.org/github/panorama-ed/snake_params)
+
+# SnakeParams
+
+SnakeParams is a module that helps smoothing out the differences in naming
+conventions between the front-end (camelCase) and the back-end (snake_case) in
+Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'snake_params'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install snake_params
+
+## Usage
+
+To start using the camelCase to snake_case conversion, just include this module
+in your Rails controller:
+
+```ruby
+include ::SnakeParams
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/panorama-ed/snake_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 a new Pull Request
+
+**Make sure your changes have appropriate tests (`bundle exec rspec`)
+and conform to the Rubocop style specified.** We use
+[overcommit](https://github.com/causes/overcommit) to enforce good code.
+
+## Documentation
+For more information, check the project's [Ruby Docs](http://www.rubydoc.info/github/panorama-ed/snake_params/master).

data/lib/snake_params.rb

@@ -0,0 +1,40 @@
+require "snake_params/version"
+
+require "active_support/concern"
+require "active_support/inflector"
+
+# SnakeParams helps smooth out the differences in naming conventions between
+# the front-end (camelCase) and the back-end (snake_case). To use, just include
+# this module in your Rails controller classes like this:
+#
+# include SnakeParams
+module SnakeParams
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :deep_snake_case_params!
+
+    private
+
+    # A method that recursively snake cases the camel cased params we receive
+    # from the frontend.
+    # @param val [Array/Hash] the parameters as they come from the front-end
+    def deep_snake_case_params!(val = params)
+      case val
+      when Array
+        val.map { |v| deep_snake_case_params!(v) }
+      when Hash
+        # We iterate the keys and then get the value, as opposed to the usual
+        # val.each do |k,v| because otherwise we get an error during the
+        # iteration with updates: can't add a new key into hash during iteration
+        val.keys.each do |k, v = val[k]|
+          val.delete k
+          val[k.underscore] = deep_snake_case_params!(v)
+        end
+        val
+      else
+        val
+      end
+    end
+  end
+end

data/lib/snake_params/version.rb

@@ -0,0 +1,3 @@
+module SnakeParams
+  VERSION = "0.1.0"
+end

data/snake_params.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "snake_params/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "snake_params"
+  spec.version       = SnakeParams::VERSION
+  spec.authors       = ["David Lago"]
+  spec.email         = ["dlago@panoramaed.com"]
+  spec.summary       = "Convert parameters from camelCase to snake_case."
+  spec.description   = "Convert parameters from camelCase to snake_case. This "\
+    "bridges the gap between JavaScript and Ruby naming conventions."
+  spec.homepage      = "https://www.github.com/panorama-ed/snake_params"
+  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", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
+  spec.add_development_dependency "overcommit", "~> 0.21"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "rubocop", "~> 0.28"
+end

data/spec/snake_params_spec.rb

@@ -0,0 +1,62 @@
+require "spec_helper"
+
+RSpec.describe "Snake Params" do
+  it "recursively snake cases parameters" do
+    class ExampleController1
+      def self.before_action(_); end
+
+      def params
+        {
+          "thisIsA" => "test",
+          "ofParameters" => {
+            # Make sure we don't convert values, just keys:
+            "thatAre" => "camelCased",
+            "that" => {
+              "shouldBe" => "converted"
+            }
+          },
+          "to" => [
+            { "snakeCased" => "1" },
+            { "parameters" => "2" }
+          ]
+        }
+      end
+
+      include ::SnakeParams
+
+      def action
+        deep_snake_case_params!
+      end
+    end
+
+    controller = ExampleController1.new
+
+    expect(controller.action).to eq(
+      "this_is_a" => "test",
+      "of_parameters" => {
+        "that_are" => "camelCased",
+        "that" => {
+          "should_be" => "converted"
+        }
+      },
+      "to" => [
+        { "snake_cased" => "1" },
+        { "parameters" => "2" }
+      ]
+    )
+  end
+
+  it "attaches to before_action" do
+    class ExampleController2
+      def self.before_action(_); end
+    end
+
+    expect(ExampleController2).
+      to receive(:before_action).
+      with(:deep_snake_case_params!)
+
+    class ExampleController2
+      include ::SnakeParams
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require "snake_params"
+
+RSpec.configure do |config|
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: snake_params
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Lago
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+description: Convert parameters from camelCase to snake_case. This bridges the gap
+  between JavaScript and Ruby naming conventions.
+email:
+- dlago@panoramaed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".overcommit.yml"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/snake_params.rb
+- lib/snake_params/version.rb
+- snake_params.gemspec
+- spec/snake_params_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.github.com/panorama-ed/snake_params
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Convert parameters from camelCase to snake_case.
+test_files:
+- spec/snake_params_spec.rb
+- spec/spec_helper.rb