action_args 2.3.2 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 234e515eeed335a94bc99891422b4e0374227c9d18b0cd5dcab10dc5c86a8ee2
-  data.tar.gz: bab6cf038df32ccc98d4921bda15b4815f039660219c8430fbf5a5f293be1cd9
+  metadata.gz: 6622f79d42d59b8e4ac5da4090a0f135246157e38db10662c20bc17269fa343a
+  data.tar.gz: 1e20928a79311c79a5cab6028956519a21477c567ecd0f3b7c41c95919fa7043
 SHA512:
-  metadata.gz: 143f8be57fe2a24ff9ad59abc21433a3248cc64536fbdd4b2b72dbf3fcb7df4f86be0655f543e696db4b909a789e189ed7b3377b27ac5c8a9082d9d4c3546558
-  data.tar.gz: 8627eb5561b52f110be725779eea1382fdd9453755d7cae01ba2f7fb4b87bcd77e0207466acc15b62c9ac4f323d6688dabce8a646dfe050924f75ae43d1709df
+  metadata.gz: 40ed64f0cacf2a3c787c164967804a00f5644a575231da58274605386ff3cfdf1a00a8866b2f509106940352e90abcd130298c0a654ccaabc6dfef614b6497fc
+  data.tar.gz: 8cf743239b588cdf6f4af6175b3218679d78b96ad433993b14c3b4c72b2ff31934d22e9fa16a36b5f2155dd9de7b920cfdf0ffb017666fa32338e81b21152025

data/.github/workflows/main.yml

@@ -0,0 +1,88 @@
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        include:
+          - ruby_version: ruby-head
+            gemfile: gemfiles/rails_edge.gemfile
+            allow_failures: 'true'
+          - ruby_version: '3.0'
+            gemfile: gemfiles/rails_70.gemfile
+            allow_failures: 'true'
+          - ruby_version: '3.0'
+            gemfile: gemfiles/rails_61.gemfile
+            allow_failures: 'true'
+
+          - ruby_version: '3.0'
+            gemfile: gemfiles/rails_edge.gemfile
+            allow_failures: 'true'
+          - ruby_version: '3.0'
+            gemfile: gemfiles/rails_70.gemfile
+          - ruby_version: '3.0'
+            gemfile: gemfiles/rails_61.gemfile
+          - ruby_version: '3.0'
+            gemfile: gemfiles/rails_60.gemfile
+
+          - ruby_version: jruby
+            gemfile: gemfiles/rails_61.gemfile
+            allow_failures: 'true'
+          - ruby_version: jruby
+            gemfile: gemfiles/rails_70.gemfile
+            allow_failures: 'true'
+
+          - ruby_version: '2.7'
+            gemfile: gemfiles/rails_edge.gemfile
+            allow_failures: 'true'
+          - ruby_version: '2.7'
+            gemfile: gemfiles/rails_70.gemfile
+          - ruby_version: '2.7'
+            gemfile: gemfiles/rails_61.gemfile
+
+          - ruby_version: '2.6'
+            gemfile: gemfiles/rails_61.gemfile
+          - ruby_version: '2.6'
+            gemfile: gemfiles/rails_52.gemfile
+          - ruby_version: '2.6'
+            gemfile: gemfiles/rails_51.gemfile
+          - ruby_version: '2.6'
+            gemfile: gemfiles/rails_50.gemfile
+
+          - ruby_version: '2.5'
+            gemfile: gemfiles/rails_61.gemfile
+          - ruby_version: '2.5'
+            gemfile: gemfiles/rails_52.gemfile
+
+          - ruby_version: '2.4'
+            gemfile: gemfiles/rails_52.gemfile
+
+          - ruby_version: '2.3'
+            gemfile: gemfiles/rails_52.gemfile
+
+          - ruby_version: '2.2'
+            gemfile: gemfiles/rails_42.gemfile
+          - ruby_version: '2.2'
+            gemfile: gemfiles/rails_41.gemfile
+
+          - ruby_version: '2.1'
+            gemfile: gemfiles/rails_42.gemfile
+
+    runs-on: ubuntu-latest
+
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler-cache: true
+        continue-on-error: ${{ matrix.allow_failures == 'true' }}
+
+      - run: bundle exec rake
+        continue-on-error: ${{ matrix.allow_failures == 'true' }}

data/README.md

@@ -1,12 +1,12 @@
-# ActionArgs
-[![Build Status](https://travis-ci.org/asakusarb/action_args.svg?branch=master)](https://travis-ci.org/asakusarb/action_args)
+# action_args
+[![Build Status](https://github.com/asakusarb/action_args/actions/workflows/main.yml/badge.svg)](https://github.com/asakusarb/action_args/actions/actions)
 
-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
+* Ruby 2.0.0, 2.1.x, 2.2.x, 2.3.x, 2.4.x, 2.5.x, 2.6.x, 2.7.x, 3.0.x, 3.1 (trunk), JRuby, & Rubinius with 2.0+ mode
 
-* Rails 4.1.x, 4.2.x, 5.0, 5.1, 5.2, 6.0 (edge)
+* Rails 4.1.x, 4.2.x, 5.0, 5.1, 5.2, 6.0, 6.1, 7.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/Rakefile

@@ -10,22 +10,4 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-task :default => 'test:all'
-
-namespace :test do
-  %w(rails_41 rails_42 rails_edge).each do |gemfile|
-    desc "Run Tests against #{gemfile}"
-    task gemfile do
-      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle --quiet"
-      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle exec rake -t test"
-    end
-  end
-
-  desc 'Run Tests against all Rails versions'
-  task :all do
-    %w(rails_41 rails_42 rails_edge).each do |gemfile|
-      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle --quiet"
-      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle exec rake -t test"
-    end
-  end
-end
+task default: :test

data/action_args.gemspec

@@ -12,12 +12,15 @@ Gem::Specification.new do |s|
   s.email       = ['ronnie@dio.jp']
   s.homepage    = 'http://asakusa.rubyist.net/'
   s.license     = 'MIT'
+  s.metadata = {
+    'source_code_uri' => 'https://github.com/asakusarb/action_args'
+  }
   s.summary     = 'Controller action arguments parameterizer for Rails 4+ & Ruby 2.0+'
   s.description = 'Rails plugin gem that supports Merbish style controller action arguments.'
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
   s.require_paths = ["lib"]
 
   s.add_development_dependency 'bundler'

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

@@ -4,12 +4,10 @@ source 'https://rubygems.org'
 
 gem 'rails', '~> 5.0.1'
 
-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

@@ -4,12 +4,10 @@ source 'https://rubygems.org'
 
 gem 'rails', '~> 5.1.0'
 
-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

@@ -4,12 +4,10 @@ source 'https://rubygems.org'
 
 gem 'rails', '~> 5.2.0'
 
-gem 'rails-controller-testing'
-
 gemspec :path => '../'
 
 platforms :ruby do
-  gem 'sqlite3'
+  gem 'sqlite3', '~> 1.3.6'
 end
 
 platforms :jruby do

data/gemfiles/rails_60.gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'rails', '~> 6.0.0'
+gem 'selenium-webdriver'
+
+gemspec path: '../'
+
+platforms :ruby do
+  gem 'sqlite3'
+end
+
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+end

data/gemfiles/rails_61.gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'rails', '~> 6.1.0'
+gem 'selenium-webdriver'
+
+gemspec path: '../'
+
+platforms :ruby do
+  gem 'sqlite3'
+end
+
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+end

data/gemfiles/rails_70.gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'rails', '~> 7.0.0'
+gem 'net-smtp'
+gem 'selenium-webdriver'
+
+gemspec path: '../'
+
+platforms :ruby do
+  gem 'sqlite3'
+end
+
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+end

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 'net-smtp'
+gem 'selenium-webdriver'
 
 gemspec :path => '../'
 

data/lib/action_args/abstract_controller.rb

@@ -10,8 +10,12 @@ module ActionArgs
       return super if !defined?(params) || params.nil?
 
       strengthen_params! method_name
-      values = extract_method_arguments_from_params method_name
-      super method_name, *values
+      values, kwargs_values = extract_method_arguments_from_params method_name
+      if kwargs_values.any?
+        super method_name, *values, **kwargs_values
+      else
+        super method_name, *values
+      end
     end
   end
 

data/lib/action_args/callbacks.rb

@@ -4,65 +4,81 @@ using ActionArgs::ParamsHandler
 
 module ActionArgs
   module ActiveSupport
-    # For Rails >= 5.1
-    module CallbackParameterizer
-      # Extending AS::Callbacks::Callback's `expand` not just to call specified
-      # method but to call the method with method parameters taken from `params`.
-      # This would happen only when
-      # * the target object is_a ActionController object
-      # * the filter was not defined via lambda
-      def expand(*)
-        target, block, method, *arguments = super
-
-        if (ActionController::Base === target) && (method != :instance_exec) && arguments.empty?
-          target.strengthen_params! method
-          arguments = target.extract_method_arguments_from_params method
+    if Rails::VERSION::MAJOR >= 7
+      module CallTemplate
+        module MethodCallParameterizer
+          def make_lambda
+            lambda do |target, value, &block|
+              if ActionController::Base === target
+                target.strengthen_params! @method_name
+                arguments, keyword_arguments = target.extract_method_arguments_from_params @method_name
+                if keyword_arguments.any?
+                  target.send(@method_name, *arguments, **keyword_arguments, &block)
+                else
+                  target.send(@method_name, *arguments, &block)
+                end
+              else
+                lambda do |target, value, &block|
+                  target.send(@method_name, &block)
+                end
+              end
+            end
+          end
         end
-
-        [target, block, method, *arguments]
       end
-    end
+      ::ActiveSupport::Callbacks::CallTemplate::MethodCall.prepend ActionArgs::ActiveSupport::CallTemplate::MethodCallParameterizer
+    elsif Rails.version >= '5.1'
+      module CallbackParameterizer
+        # Extending AS::Callbacks::Callback's `make_lambda` not just to call specified
+        # method but to call the method with method parameters taken from `params`.
+        # This would happen only when
+        # * the target object is_a ActionController object
+        # * the filter was not defined via lambda
+        def make_lambda
+          lambda do |target, value, &block|
+            target, block, method, *arguments = expand(target, value, block)
 
-    # For Rails 4 & 5.0
-    module CallbackParameterizerLegacy
-      # Extending AS::Callbacks::Callback's `make_lambda` not just to call specified
-      # method but to call the method with method parameters taken from `params`.
-      # This would happen only when
-      # * the filter was defined in Symbol form
-      # * the target object is_a ActionController object
-      def make_lambda(filter)
-        if Symbol === filter
-          lambda do |target, _, &blk|
-            if ActionController::Base === target
-              target.strengthen_params! filter
-              values = target.extract_method_arguments_from_params filter
-              target.send filter, *values, &blk
+            if (ActionController::Base === target) && (method != :instance_exec) && arguments.empty?
+              target.strengthen_params! method
+              arguments, keyword_arguments = target.extract_method_arguments_from_params method
+              if keyword_arguments.any?
+                target.send(method, *arguments, **keyword_arguments, &block)
+              else
+                target.send(method, *arguments, &block)
+              end
             else
-              target.send filter, &blk
+              target.send(method, *arguments, &block)
             end
           end
-        else
-          super
         end
       end
-    end
-  end
-end
-
-if Rails.version >= '5.1'
-  module ActiveSupport
-    module Callbacks
-      class CallTemplate
-        prepend ActionArgs::ActiveSupport::CallbackParameterizer
-      end
-    end
-  end
-else
-  module ActiveSupport
-    module Callbacks
-      class Callback
-        prepend ActionArgs::ActiveSupport::CallbackParameterizerLegacy
+      ::ActiveSupport::Callbacks::CallTemplate.prepend ActionArgs::ActiveSupport::CallbackParameterizer
+    else
+      # For Rails 4 & 5.0
+      module CallbackParameterizerLegacy
+        # Extending AS::Callbacks::Callback's `make_lambda` not just to call specified
+        # method but to call the method with method parameters taken from `params`.
+        # This would happen only when
+        # * the filter was defined in Symbol form
+        # * the target object is_a ActionController object
+        def make_lambda(filter)
+          if Symbol === filter
+            lambda do |target, _, &blk|
+              if ActionController::Base === target
+                target.strengthen_params! filter
+                values, kwargs_values = target.extract_method_arguments_from_params filter
+                values << kwargs_values if kwargs_values.any?
+                target.send filter, *values, &blk
+              else
+                target.send filter, &blk
+              end
+            end
+          else
+            super
+          end
+        end
       end
+      ::ActiveSupport::Callbacks::Callback.prepend ActionArgs::ActiveSupport::CallbackParameterizerLegacy
     end
   end
 end