action_args 2.3.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 234e515eeed335a94bc99891422b4e0374227c9d18b0cd5dcab10dc5c86a8ee2
-  data.tar.gz: bab6cf038df32ccc98d4921bda15b4815f039660219c8430fbf5a5f293be1cd9
+  metadata.gz: 4b4a8d847e94c900a71e3ce0c0bc9e5fb1f33c195a2b30222fad4ca5f4574d73
+  data.tar.gz: d557de21bbcb6eb76f88c4d4bc70fb899f58449192e9125f7c8548e2f8d17ab8
 SHA512:
-  metadata.gz: 143f8be57fe2a24ff9ad59abc21433a3248cc64536fbdd4b2b72dbf3fcb7df4f86be0655f543e696db4b909a789e189ed7b3377b27ac5c8a9082d9d4c3546558
-  data.tar.gz: 8627eb5561b52f110be725779eea1382fdd9453755d7cae01ba2f7fb4b87bcd77e0207466acc15b62c9ac4f323d6688dabce8a646dfe050924f75ae43d1709df
+  metadata.gz: 43ee46cb44156ad2cd9a47aab03e312b00058d2173c416e6f60152c3b423ddadfa92c0ebf41c4c22b17d6c0daac3e029a3042a1d3b5272fcf18a18a5a1e03d58
+  data.tar.gz: fea23dadb984ed9d43250ead66849f38ed45d5a5ca053b1c6513e7235d0dd7d961ba9d6b7773126af104d1ed93a31d99f01b168403dded36074fcea12b273e38

data/.travis.yml

@@ -3,7 +3,7 @@ language: ruby
 sudo: false
 
 before_install:
-  - "ruby -e 'exit RUBY_VERSION.to_f >= 2.3' && gem up --system || gem i rubygems-update -v '<3' && update_rubygems"
+  - "ruby -e 'exit RUBY_VERSION.to_f >= 2.3' && gem up --system || (gem i rubygems-update -v '<3' && update_rubygems)"
   - gem up bundler
 
 # rvm:
@@ -53,12 +53,12 @@ matrix:
     - rvm: ruby-head
       gemfile: gemfiles/rails_edge.gemfile
 
-    - rvm: jruby-9.2.0.0
+    - rvm: jruby-9.2.6.0
       gemfile: gemfiles/rails_52.gemfile
     - rvm: rubinius-3
       gemfile: gemfiles/rails_52.gemfile
 
   allow_failures:
-    - rvm: jruby-9.2.0.0
+    - rvm: jruby-9.2.6.0
     - rvm: rubinius-3
     - gemfile: gemfiles/rails_edge.gemfile

data/README.md

@@ -1,12 +1,12 @@
-# ActionArgs
+# action_args
 [![Build Status](https://travis-ci.org/asakusarb/action_args.svg?branch=master)](https://travis-ci.org/asakusarb/action_args)
 
-Controller action arguments parameterizer for Rails 4.1+
+Controller action arguments parameterizer for Rails
 
 
-## What is this?
+## What Is This?
 
-ActionArgs is a Rails plugin that extends your controller action methods to allow you to specify arguments of interest in the method definition for any action. - in short, Merbish.
+action_args is a Rails plugin that extends your controller action methods to allow you to specify arguments of interest in the method definition for any action. - in short, this makes your Rails controller Merb-ish.
 
 
 ## The Controllers
@@ -14,24 +14,24 @@ ActionArgs is a Rails plugin that extends your controller action methods to allo
 Having the following controller code:
 
 ```ruby
-class HogeController < ApplicationController
-  def fuga(piyo)
-    render :text => piyo
+class UsersController < ApplicationController
+  def show(id)
+    @user = User.find id
   end
 end
 ```
 
-Hitting "/hoge/fuga?piyo=foo" will call `fuga('foo')` and output 'foo'.
-This allows you to explicitly state which members of the `params` Hash are used in your controller actions.
+When a request visits "/users/777", it calls `UsersController#show` passing 777 as the method parameter.
+This allows you to explicitly state the most important API for the action -- which members of the `params` Hash are used in your controller actions -- in a perfectly natural Ruby way!
 
 
-## Method parameter types in Ruby, and how ActionArgs handles parameters
+## Method Parameter Types in Ruby, and How action_args Handles Parameters
 
 ### Required Parameters (:req)
-Method parameters that you specify are required. If a key of the same name does not exist in the params Hash,
-ActionContrller::BadRequest is raised.
+Method parameters that you specify are required. If a key of the same name does not exist in the params Hash, ActionContrller::BadRequest is raised.
+
+In this `show` action, action_args will require that `id` parameter is provided.
 
-In this `show` action, ActionArgs will require that `id` parameter is provided.
 ```ruby
 class UsersController < ApplicationController
   # the `id` parameter is mandatory
@@ -55,7 +55,7 @@ end
 
 ### Keyword Argument (:key)
 If you think this Ruby 2.0 syntax reads better, you can choose this style for defining your action methods.
-This just works in the same way as :opt here.
+This just works in the same way as `:opt` here.
 
 ```ruby
 class UsersController < ApplicationController
@@ -67,8 +67,8 @@ end
 ```
 
 ### Required Keyword Argument (:keyreq)
-:keyreq is the required version of :key, which was introduced in Ruby 2.1.
-You can use this syntax instead of :req.
+`:keyreq` is the required version of `:key`, which was introduced in Ruby 2.1.
+You can use this syntax instead of `:req`.
 
 ```ruby
 class CommentsController < ApplicationController
@@ -80,9 +80,9 @@ class CommentsController < ApplicationController
 end
 ```
 
-### StrongParameters - permit
+## StrongParameters - permit
 
-ActionArgs plays very nice with Rails 4 StrongParameters.
+action_args plays very nice with Rails 4 StrongParameters.
 
 1. Inline declaration
 
@@ -97,17 +97,17 @@ class UsersController < ApplicationController
 end
 ```
 
-2. Declarative white-listing
+2. Declarative allow-listing
 
-ActionArgs also provides a declarative `permits` method for controller classes.
+action_args also provides a declarative `permits` method for controller classes.
 Use this to keep your `permit` calls DRY in a comprehensible way.
 
 ```ruby
 class UsersController < ApplicationController
-  # white-lists User model's attributes
+  # allow-lists User model's attributes
   permits :name, :age
 
-  # the given `user` parameter would be automatically permitted by ActionArgs
+  # the given `user` parameter would be automatically permitted by action_args
   def create(user)
     @user = User.new(user)
   end
@@ -116,18 +116,19 @@ end
 
 By default, action_args deduces the target model name from the controller name.
 For example, the `permits` call in `UsersController` expects the model name to be `User`.
-If this is not the case, you can specify the :model_name option:
+If this is not the case, you can specify the `:model_name` option:
 
 ```ruby
 class MembersController < ApplicationController
-  # white-lists User model's attributes
+  # allow-lists User model's attributes
   permits :name, :age, model_name: 'User'
 end
 ```
 
+
 ## Filters
 
-ActionArgs works in filters, in the same way as it works in controller actions.
+action_args works in filters, in the same way as it works in controller actions.
 
 ```ruby
 class UsersController < ApplicationController
@@ -136,17 +137,44 @@ class UsersController < ApplicationController
   def show
   end
 
-  private
-    # `params[:id]` will be dynamically assigned to the method parameter `id` here
-    def set_user(id)
-      @user = User.find(id)
-    end
+  # `params[:id]` will be dynamically assigned to the method parameter `id` here
+  private def set_user(id)
+    @user = User.find(id)
+  end
 end
 ```
 
+
+## The *_params Convention
+
+For those who are familiar with the Rails scaffold's default naming style, you can add `_params` suffix to any of the parameter names in the method signatures.
+It just matches with the params name without `_params`.
+
+For instance, these two actions both pass `params[:user]` as the method parameter.
+
+```ruby
+# without _params
+def create(user)
+  @user = User.new(user)
+  ...
+end
+```
+
+```ruby
+# with _params
+def create(user_params)
+  @user = User.new(user_params)
+  ...
+end
+```
+
+This naming convention makes your controller code look much more compatible with the Rails' default scaffolded code,
+and so it may be actually super easy for you to manually migrate from the legacy scaffold controller to the action_args style.
+
+
 ## The Scaffold Generator
 
-ActionArgs provides a custom scaffold controller generator that overwrites the default scaffold generator.
+action_args provides a custom scaffold controller generator that overwrites the default scaffold generator.
 Thus, by hitting the scaffold generator command like this:
 
 ```sh
@@ -212,37 +240,33 @@ end
 ```
 
 You may notice that
-* There are no globalish `params` reference
+* There are no global-ish `params` reference
 * It's quite easy to comprehend what's the actual input value for each action
-* You may write the unit test code as if the actions are just normal Ruby methods
+* You may be able to write the unit test code without mocking `params` as if the actions are just normal Ruby methods
 
 
-## Supported versions
+## Supported Versions
 
 * Ruby 2.0.0, 2.1.x, 2.2.x, 2.3.x, 2.4.x, 2.5.x, 2.6.x, 2.7.0 (trunk), JRuby, & Rubinius with 2.0+ mode
 
 * Rails 4.1.x, 4.2.x, 5.0, 5.1, 5.2, 6.0 (edge)
 
-Please use Version 1.5.4 for Rails 4.0.x.
+For Rails 4.0.x, please use Version 1.5.4.
 
 
 ## Installation
 
-Put this line in your Gemfile:
+Bundle the gem to your Rails app by putting this line in your Gemfile:
+
 ```ruby
 gem 'action_args'
 ```
 
-Then bundle:
-```sh
-% bundle
-```
-
 ## Notes
 
 ### Plain Old Action Methods
 
-Of course you still can use both Merbish style and plain old Rails style action methods even if this plugin is loaded. `params` parameter is still alive as well. That means, this plugin won't break any existing controller API.
+Of course you still can use both Merb-like style and plain old Rails style action methods even if this plugin is loaded. `params` parameter is still alive as well. That means, this plugin won't break any existing controller API.
 
 ### Argument Naming Convention
 
@@ -264,7 +288,7 @@ class BooksController < ApplicationController
 end
 ```
 
-### Default parameter values
+### Default Parameter Values
 
 You are of course able to specify default values for action parameters such as:
 
@@ -290,6 +314,7 @@ end
 
 This way, the `page` parameter will be defaulted to 1 as everyone might expect.
 
+
 ## Copyright
 
 Copyright (c) 2011- Asakusa.rb. See MIT-LICENSE for further details.

data/gemfiles/rails_41.gemfile

@@ -8,7 +8,7 @@ gem 'nokogiri', RUBY_VERSION < '2.1' ? '~> 1.6.0' : '>= 1.7'
 gemspec :path => '../'
 
 platforms :ruby do
-  gem 'sqlite3'
+  gem 'sqlite3', '~> 1.3.6'
 end
 
 platforms :jruby do

data/gemfiles/rails_42.gemfile

@@ -8,7 +8,7 @@ gem 'nokogiri', RUBY_VERSION < '2.1' ? '~> 1.6.0' : '>= 1.7'
 gemspec :path => '../'
 
 platforms :ruby do
-  gem 'sqlite3'
+  gem 'sqlite3', '~> 1.3.6'
 end
 
 platforms :jruby do

data/gemfiles/rails_50.gemfile

@@ -9,7 +9,7 @@ gem 'rails-controller-testing'
 gemspec :path => '../'
 
 platforms :ruby do
-  gem 'sqlite3'
+  gem 'sqlite3', '~> 1.3.6'
 end
 
 platforms :jruby do

data/gemfiles/rails_51.gemfile

@@ -9,7 +9,7 @@ gem 'rails-controller-testing'
 gemspec :path => '../'
 
 platforms :ruby do
-  gem 'sqlite3'
+  gem 'sqlite3', '~> 1.3.6'
 end
 
 platforms :jruby do

data/gemfiles/rails_52.gemfile

@@ -9,7 +9,7 @@ gem 'rails-controller-testing'
 gemspec :path => '../'
 
 platforms :ruby do
-  gem 'sqlite3'
+  gem 'sqlite3', '~> 1.3.6'
 end
 
 platforms :jruby do

data/gemfiles/rails_edge.gemfile

@@ -7,11 +7,8 @@ git_source(:github) do |repo_name|
 end
 
 gem 'rails', github: 'rails/rails'
-gem 'rack', github: 'rack/rack'
-gem 'arel', github: 'rails/arel'
-gem 'sprockets', github: 'rails/sprockets'
-gem 'sprockets-rails', github: 'rails/sprockets-rails'
 gem 'rails-controller-testing'
+gem 'selenium-webdriver'
 
 gemspec :path => '../'
 

data/lib/action_args/params_handler.rb

@@ -9,20 +9,21 @@ module ActionArgs
         kwargs, missing_required_params = {}, []
         parameter_names = method_parameters.map(&:last)
         method_parameters.reverse_each do |type, key|
+          trimmed_key = key.to_s.sub(/_params\z/, '').to_sym
           case type
           when :req
-            missing_required_params << key unless params.key? key
+            missing_required_params << key unless params.key? trimmed_key
             next
           when :keyreq
-            if params.key? key
-              kwargs[key] = params[key]
+            if params.key? trimmed_key
+              kwargs[key] = params[trimmed_key]
             else
               missing_required_params << key
             end
           when :key
-            kwargs[key] = params[key] if params.key? key
+            kwargs[key] = params[trimmed_key] if params.key? trimmed_key
           when :opt
-            break if params.key? key
+            break if params.key? trimmed_key
           end
           # omitting parameters that are :block, :rest, :opt without a param, and :key without a param
           parameter_names.delete key
@@ -36,7 +37,7 @@ module ActionArgs
           end
         end
 
-        values = parameter_names.map {|k| params[k]}
+        values = parameter_names.map {|k| params[k.to_s.sub(/_params\z/, '').to_sym]}
         values << kwargs if kwargs.any?
         values
       end
@@ -50,9 +51,10 @@ module ActionArgs
 
         method_parameters = method(method_name).parameters
         method_parameters.each do |type, key|
-          if (key == target_model_name) && permitted_attributes
-            params.require(key) if %i[req keyreq].include?(type)
-            params[key] = params[key].try :permit, *permitted_attributes if params.key? key
+          trimmed_key = key.to_s.sub(/_params\z/, '').to_sym
+          if (trimmed_key == target_model_name) && permitted_attributes
+            params.require(trimmed_key) if %i[req keyreq].include?(type)
+            params[trimmed_key] = params[trimmed_key].try :permit, *permitted_attributes if params.key? trimmed_key
           end
         end
       end

data/lib/action_args/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionArgs
-  VERSION = '2.3.2'
+  VERSION = '2.4.0'
 end

data/test/params_handler/params_handler_test.rb

@@ -21,18 +21,36 @@ class ActionArgs::ParamsHandlerTest < ActiveSupport::TestCase
       assert_equal ['1'], @controller.extract_method_arguments_from_params(:m)
     end
 
+    test '1 req with args named like strong parameters' do
+      def @controller.m(a_params) end
+
+      assert_equal ['1'], @controller.extract_method_arguments_from_params(:m)
+    end
+
     test '2 reqs' do
       def @controller.m(a, b) end
 
       assert_equal ['1', '2'], @controller.extract_method_arguments_from_params(:m)
     end
 
+    test '2 reqs with args named like strong parameters' do
+      def @controller.m(a_params, b_params) end
+
+      assert_equal ['1', '2'], @controller.extract_method_arguments_from_params(:m)
+    end
+
     test '1 opt with value' do
       def @controller.m(a = 'a') end
 
       assert_equal ['1'], @controller.extract_method_arguments_from_params(:m)
     end
 
+    test '1 opt with value with args named like strong parameters' do
+      def @controller.m(a_params = 'a') end
+
+      assert_equal ['1'], @controller.extract_method_arguments_from_params(:m)
+    end
+
     test '1 opt without value' do
       def @controller.m(x = 'x') end
 
@@ -111,6 +129,12 @@ class ActionArgs::ParamsHandlerTest < ActiveSupport::TestCase
       assert_equal [a: '1'], @controller.extract_method_arguments_from_params(:m)
     end
 
+    test 'key with args named like strong parameters' do
+      def @controller.m(a_params: nil) end
+
+      assert_equal [a_params: '1'], @controller.extract_method_arguments_from_params(:m)
+    end
+
     test 'key, key without value' do
       def @controller.m(a: nil, x: 'x') end
 
@@ -125,6 +149,12 @@ class ActionArgs::ParamsHandlerTest < ActiveSupport::TestCase
           assert_equal [a: '1'], @controller.extract_method_arguments_from_params(:m)
         end
 
+        test 'keyreq with args named like strong parameters' do
+          def @controller.m(a_params:) end
+
+          assert_equal [a_params: '1'], @controller.extract_method_arguments_from_params(:m)
+        end
+
         test 'keyreq, keyreq without value' do
           def @controller.m(a:, x:) end
 
@@ -136,7 +166,7 @@ class ActionArgs::ParamsHandlerTest < ActiveSupport::TestCase
 
   sub_test_case 'strengthen_params!' do
     setup do
-      @params = ActionController::Parameters.new(x: '1', y: '2', foo: {a: 'a', b: 'b'}, bar: {a: 'a', b: 'b'}, baz: {a: 'a', b: 'b'}, hoge: {a: 'a', b: 'b'}, fuga: {a: 'a', b: 'b'})
+      @params = ActionController::Parameters.new(x: '1', y: '2', foo: {a: 'a', b: 'b'}, bar: {a: 'a', b: 'b'}, baz: {a: 'a', b: 'b'}, hoge: {a: 'a', b: 'b'}, fuga: {a: 'a', b: 'b'}, foo_foo: {a: 'a', b: 'b'}, hoge_hoge: {a: 'a', b: 'b'}, fuga_fuga: {a: 'a', b: 'b'})
     end
 
     def execute_strengthen_params!(controller)
@@ -153,6 +183,14 @@ class ActionArgs::ParamsHandlerTest < ActiveSupport::TestCase
       assert_not_nil @params[:foo][:b]
     end
 
+    test 'requiring via :req, permitting all scalars with args named like strong parameters' do
+      execute_strengthen_params! FooFooController ||= Class.new(ApplicationController) { permits :a, :b; def a(foo_foo_params) end }
+
+      assert @params[:foo_foo].permitted?
+      assert_not_nil @params[:foo_foo][:a]
+      assert_not_nil @params[:foo_foo][:b]
+    end
+
     test 'requiring via :req, not permitting all scalars' do
       execute_strengthen_params! BarController ||= Class.new(ApplicationController) { permits :a; def a(bar, x = 'x') end }
 
@@ -175,6 +213,14 @@ class ActionArgs::ParamsHandlerTest < ActiveSupport::TestCase
       assert_not_nil @params[:hoge][:b]
     end
 
+    test 'requiring via :opt, permitting all scalars with args named like strong parameters' do
+      execute_strengthen_params! HogeHogeController ||= Class.new(ApplicationController) { permits :a, :b; def a(hoge_hoge_params = {}) end }
+
+      assert @params[:hoge_hoge].permitted?
+      assert_not_nil @params[:hoge_hoge][:a]
+      assert_not_nil @params[:hoge_hoge][:b]
+    end
+
     test 'requiring via :key, permitting all scalars' do
       execute_strengthen_params! FugaController ||= Class.new(ApplicationController) { permits :a, :b; def a(fuga: {}) end }
 
@@ -183,6 +229,14 @@ class ActionArgs::ParamsHandlerTest < ActiveSupport::TestCase
       assert_not_nil @params[:fuga][:b]
     end
 
+    test 'requiring via :key, permitting all scalars with args named like strong parameters' do
+      execute_strengthen_params! FugaFugaController ||= Class.new(ApplicationController) { permits :a, :b; def a(fuga_fuga_params: {}) end }
+
+      assert @params[:fuga_fuga].permitted?
+      assert_not_nil @params[:fuga_fuga][:a]
+      assert_not_nil @params[:fuga_fuga][:b]
+    end
+
     test '"model_name" option' do
       execute_strengthen_params! PiyoController ||= Class.new(ApplicationController) { permits :a, :b, model_name: 'Foo'; def a(foo) end }
 
@@ -190,5 +244,13 @@ class ActionArgs::ParamsHandlerTest < ActiveSupport::TestCase
       assert_not_nil @params[:foo][:a]
       assert_not_nil @params[:foo][:b]
     end
+
+    test '"model_name" option with args named like strong parameters' do
+      execute_strengthen_params! PiyoPiyoController = Class.new(ApplicationController) { permits :a, :b, model_name: 'Foo'; def a(foo_params) end }
+
+      assert @params[:foo].permitted?
+      assert_not_nil @params[:foo][:a]
+      assert_not_nil @params[:foo][:b]
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_args
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.4.0
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-22 00:00:00.000000000 Z
+date: 2019-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -111,7 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubyforge_project: 
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Controller action arguments parameterizer for Rails 4+ & Ruby 2.0+