rails_conditional_params 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 701630303734a8185bfebf834b70e56806fa8f0a
+  data.tar.gz: b8990aa7db047fcce4ecbbb87c91581b794e05ad
+SHA512:
+  metadata.gz: a635d866592b429a4dbf80bba1f21893310d6b512ad665eec1a6ff2387ee1639b1516a34864e320081385069415c7e9cd03430b590c7e10fd989b71239a4c429
+  data.tar.gz: 633d39ca54c301341cb7d72c3d8dad8f37109798e65329ce4c74cd62887c89c15181cf997e79c6d7fa01ea21af99243cbf0e2f6e697f2a4b8f5d31160471a4f8

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brent Royal-Gordon
+
+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,36 @@
+# RailsConditionalParams
+
+This gem patches `ActionController::Parameters` to support conditional
+parameters—parameters that are permitted only if some condition is true.
+Basically, it ensures that any hash key passed to `permit()` with `true` as
+its value is made into a permitted key, while keys passed with `false` or `nil`
+are ignored.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_conditional_params'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_conditional_params
+
+## Usage
+
+    params.permit(:title, :body, published: admin?)
+		# published will only be permitted if admin? returns true
+
+## Contributing
+
+1. Fork it ( https://github.com/brentdax/rails_conditional_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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rails_conditional_params/patch.rb

@@ -0,0 +1,38 @@
+module RailsConditionalParams
+  module Patch
+    # Adds support for conditional params:
+    # 
+    #     params.permit(yes: true, no: false)
+    #     # => { "yes" => "..." }
+    # 
+    # This is useful for parameters that should be permitted in some cases, 
+    # but not others:
+    # 
+    #     params.permit(:title, :body, published: admin?)
+    #     # Result only includes published if admin? is true.
+    def permit_with_conditional_params(*filters)
+      filters.each do |filter|
+        if filter.is_a? Hash
+          filter.delete_if do |key, value|
+            case value
+            when TrueClass
+              filters << key
+              true
+            when FalseClass, NilClass
+              # do nothing
+              true
+            else
+              false
+            end
+          end
+        end
+      end
+    
+      permit_without_conditional_params(*filters)
+    end
+  
+    def Patch.included(other)
+      other.alias_method_chain :permit, :conditional_params
+    end
+  end
+end

data/lib/rails_conditional_params/version.rb

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

data/lib/rails_conditional_params.rb

@@ -0,0 +1,8 @@
+require 'action_controller'
+
+require "rails_conditional_params/version"
+require "rails_conditional_params/patch"
+
+module RailsConditionalParams
+  ActionController::Parameters.include Patch
+end

data/rails_conditional_params.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_conditional_params/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_conditional_params"
+  spec.version       = RailsConditionalParams::VERSION
+  spec.authors       = ["Brent Royal-Gordon"]
+  spec.email         = ["brent@architechies.com"]
+  spec.summary       = %q{Patches ActionController::Parameters to let you easily permit parameters sometimes}
+  spec.homepage      = "http://github.com/brentdax/rails_conditional_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.required_ruby_version = '>= 2.2.0'
+  spec.add_dependency "actionpack", ">= 4.2.0"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "rack-test", "~> 0.6.3"
+end

data/spec/params_spec.rb

@@ -0,0 +1,20 @@
+require "rack/test"
+require_relative "../lib/rails_conditional_params"
+
+describe ActionController::Parameters do
+  before do
+    @params = ActionController::Parameters.new(allowed: "allowed", forbidden: "forbidden", maybe: "maybe")
+  end
+  
+  it "should work the same without conditionals" do
+    expect(@params.permit(:allowed)).to eq("allowed" => "allowed")
+  end
+  
+  it "should include conditionals when conditionals are true" do
+    expect(@params.permit(:allowed, maybe: true)).to eq("allowed" => "allowed", "maybe" => "maybe")
+  end
+  
+  it "should exclude conditionals when conditionals are false" do
+    expect(@params.permit(:allowed, maybe: false)).to eq("allowed" => "allowed")
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: rails_conditional_params
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brent Royal-Gordon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+description: 
+email:
+- brent@architechies.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_conditional_params.rb
+- lib/rails_conditional_params/patch.rb
+- lib/rails_conditional_params/version.rb
+- rails_conditional_params.gemspec
+- spec/params_spec.rb
+homepage: http://github.com/brentdax/rails_conditional_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: 2.2.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: Patches ActionController::Parameters to let you easily permit parameters
+  sometimes
+test_files:
+- spec/params_spec.rb