nested_strong_parameters 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc0f70a0c0e5426698354f4a4a106ab46b4eeb72
+  data.tar.gz: d61d41f5b3f407091e736be640cb877ccc75c19a
+SHA512:
+  metadata.gz: 4aee309e0e9cd4b3cf460db78d15eea68f15dc371d1dce3dcbc7584ea565ce844ae33e0a6ea0ce7299b24d5f6f5d9d0eaa6fc82adcd71802fa356fd72f5687f9
+  data.tar.gz: 50b8ca2417e6e92570cdf4d41808fb162951f258a2876d566fe90f8152ab3e3a9ea33066fcd7d4dba7d60155e3ada8fb9e14f58749eb51c81030c72e80668a3b

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.*.s[a-w][a-z]
+.ruby-*
+*~

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2014 Alejandro Babio
+
+
+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,180 @@
+# NestedStrongParameters
+
+If in your Rails app you use strong_parameters with nested_attributes, and believe the old attr_accessible were easier to use. This gem is for you.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+  gem 'nested_strong_parameters'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nested_strong_parameters
+
+## Usage
+
+In your models use `strong_fields` to define the whitelist of fields that can be updated by params. If a model accepts nested attributes for `some_model`, add the field `<some_model>_attributes`. Also you can set a role with :as option, and works fine with STI. Yes, just like we used to do with protected_attributes. And an array parameter must be write in the same fashion at we do with strong_parameters.
+
+And then use on permit this way: `params.require(:<model>).permit(<Model>.whitelist)`
+
+An example:
+
+```ruby
+  Class Project < ActiveRecord::Base
+    has_many :tasks
+    has_many :taggings
+    has_many :tags, through: :taggings
+
+    accepts_nested_attributes_for :tasks
+
+    strong_fields :name, :description, :tasks_attributes, tag_ids: []
+    strong_fields :budget, as: :admin
+  end
+
+  Class Task < ActiveRecord::Base
+    belongs_to :project
+
+    strong_fields :name, :start, :end
+  end
+```
+
+Now call permit on params is really easy:
+
+```ruby
+  # at console
+  # with Project.whitelist, I got:
+  ~/ (main) > Project.whitelist
+  => [:name, :description, {:tasks_attributes=>[:name, :start, :end]},
+  {tag_ids: []}]
+
+  # or with admin role:
+  ~/ (main) > Project.whitelist(:admin)
+  => [:name, :description, {:tasks_attributes=>[:name, :start, :end]},
+  {tag_ids: []}, :budget]
+
+  # used to call permit
+  @project.update_attributes(params.require(:project).permit(Project.whitelist))
+```
+
+Can I avoid error prone with whitelist? Take a look to this real life example:
+
+```ruby
+  # irb:
+  ~/rails/rfinan (main) > Dealing.whitelist
+  [:due_date,
+  :note,
+  :status,
+  {:items_attributes=>
+    [:amount,
+      :dealing_id,
+      :product_selector,
+      :price,
+      :sign,
+      :reference_value,
+      :chk_item,
+      :sequence,
+      {:security_items_attributes=>
+        [:commission,
+        :commission_rate,
+        :interest,
+        :interest_rate,
+        :net_value,
+        :security_id,
+        :item_id,
+        :sequence,
+        {:check_attributes=>
+          [:amount,
+            :note,
+            :payment_day,
+            :commodity_id,
+            :owner,
+            :branch,
+            :number,
+            :bank_lookup,
+            :signer_lookup,
+            :chk_refuse]},
+        {:loan_attributes=>
+          [:amount,
+            :note,
+            :payment_day,
+            :commodity_id,
+            :owner,
+            :due_date,
+            :params]}]},
+      :payer_sequence,
+      :paid_items_count]},
+  {:person_attributes=>
+    [:name,
+      :phone,
+      :mobile,
+      :address,
+      :city,
+      :province,
+      :estate,
+      :postal_code,
+      :email,
+      :note]}]
+
+  # controller code with nested_strong_parameters:
+  Dealing.create(params.require(:dealing).permit(Dealing.whitelist))
+
+  # without nested_strong_parameters:
+  Dealing.create(params.require(:dealing).permit(
+    [
+      :due_date, :note, :status,
+      {
+        :items_attributes=>
+          [
+            :amount, :dealing_id, :product_selector, :price, :sign,
+            :reference_value, :chk_item, :sequence,
+            {
+              :security_items_attributes=>
+                [
+                  :commission, :commission_rate, :interest, :interest_rate,
+                  :net_value, :security_id, :item_id, :sequence,
+                  {
+                    :check_attributes=>
+                      [
+                        :amount, :note, :payment_day, :commodity_id, :owner,
+                        :branch, :number, :bank_lookup, :signer_lookup,
+                        :chk_refuse
+                      ]
+                  },
+                  {
+                    :loan_attributes=>
+                      [
+                        :amount, :note, :payment_day, :commodity_id, :owner,
+                        :due_date, :params
+                      ]
+                  }
+                ]
+            },
+            :payer_sequence, :paid_items_count
+          ]
+      },
+      {
+        :person_attributes=>
+          [
+            :name, :phone, :mobile, :address, :city, :province, :estate,
+            :postal_code, :email, :note
+          ]
+      }
+    ]
+  )
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/alejandrobabio/nested_strong_parameters/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,11 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end

data/lib/nested_strong_parameters.rb

@@ -0,0 +1,5 @@
+require "nested_strong_parameters/version"
+require "nested_strong_parameters/nested_strong_parameters"
+
+require "active_record"
+ActiveRecord::Base.include(NestedStrongParameters)

data/lib/nested_strong_parameters/nested_strong_parameters.rb

@@ -0,0 +1,55 @@
+require "active_support/concern"
+require "active_support/core_ext"
+
+module NestedStrongParameters
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :_strong_fields, instance_accessors: false
+    self._strong_fields ||= {}
+  end
+
+  module ClassMethods
+    def strong_fields(*args)
+      options = extract_option_as(args)
+      roles = options[:as] || :default
+
+      self._strong_fields = self._strong_fields.deep_dup
+      Array(roles).each do |role|
+        self._strong_fields[role] ||= []
+        self._strong_fields[role] += args
+      end
+    end
+
+    def whitelist(role = nil)
+      map_params(self, role)
+    end
+
+  private
+
+    def extract_option_as(args)
+      if args.last.is_a?(Hash) && args.last[:as]
+        args.pop
+      else
+        {}
+      end
+    end
+
+    def map_params(model, role = nil)
+      fields = model._strong_fields[:default]
+      fields += model._strong_fields.fetch(role) { [] }
+
+      fields.uniq.map do |field|
+        if field.to_s.match /_attributes$/
+          { field => map_params(nested_model(field), role) }
+        else
+          field
+        end
+      end
+    end
+
+    def nested_model(field)
+      field.to_s.gsub(/_attributes$/, '').classify.constantize
+    end
+  end
+end

data/lib/nested_strong_parameters/version.rb

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

data/nested_strong_parameters.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nested_strong_parameters/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nested_strong_parameters"
+  spec.version       = NestedStrongParameters::VERSION
+  spec.authors       = ["Alejandro Babio\n"]
+  spec.email         = ["alejandro.e.babio@hotmail.com"]
+  spec.summary       = %q{Make simple the use of nested_attributes with strong_parameters}
+  spec.description   = %q{Make simple the use of nested_attributes with strong_parameters}
+  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 "activerecord", "~> 4.0"
+  spec.add_dependency "activesupport", "~> 4.0"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 4.7"
+end

data/test/nested_strong_parameters_test.rb

@@ -0,0 +1,64 @@
+# coding: utf-8
+require 'test_helper'
+
+class Parent < ActiveRecord::Base
+  strong_fields :name, :child_attributes, tags: []
+end
+
+class Child < ActiveRecord::Base
+  strong_fields :name, :age, :toys_attributes
+end
+
+class Toy < ActiveRecord::Base
+  strong_fields :name, :tag
+  strong_fields :price, as: :admin
+end
+
+class CarToy < Toy
+end
+
+class Father < Parent
+  strong_fields :wife, as: :admin
+end
+
+describe NestedStrongParameters do
+
+  it 'admin whitelist' do
+    toys_attributes = [:name, :tag, :price]
+    child_attributes = [:name, :age, toys_attributes: toys_attributes]
+
+    Parent.whitelist(:admin).must_equal [
+      :name, { child_attributes: child_attributes }, { tags: [] }
+    ]
+  end
+
+  it 'admin whitelist on STI Father' do
+    toys_attributes = [:name, :tag, :price]
+    child_attributes = [:name, :age, toys_attributes: toys_attributes]
+
+    Father.whitelist(:admin).must_equal [
+      :name, { child_attributes: child_attributes }, { tags: [] }, :wife
+    ]
+  end
+
+  it 'default whitelist' do
+    toys_attributes = [:name, :tag]
+    child_attributes = [:name, :age, toys_attributes: toys_attributes]
+
+    Parent.whitelist.must_equal [
+      :name, { child_attributes: child_attributes }, { tags: [] }
+    ]
+  end
+
+  it 'admin whitelist without nested attributes' do
+    Toy.whitelist(:admin).must_equal [:name, :tag, :price]
+  end
+
+  it 'admin whitelist without nested attributes on STI' do
+    CarToy.whitelist(:admin).must_equal [:name, :tag, :price]
+  end
+
+  it 'role without strong_fields equal default whitelist' do
+    Parent.whitelist.must_equal Parent.whitelist(:undefined_role)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift( File.join( File.dirname(__FILE__), "..", "lib") )
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'nested_strong_parameters'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: nested_strong_parameters
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- |
+  Alejandro Babio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: 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: 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+description: Make simple the use of nested_attributes with strong_parameters
+email:
+- alejandro.e.babio@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/nested_strong_parameters.rb
+- lib/nested_strong_parameters/nested_strong_parameters.rb
+- lib/nested_strong_parameters/version.rb
+- nested_strong_parameters.gemspec
+- test/nested_strong_parameters_test.rb
+- test/test_helper.rb
+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: Make simple the use of nested_attributes with strong_parameters
+test_files:
+- test/nested_strong_parameters_test.rb
+- test/test_helper.rb