action_args 2.3.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 598aaa9aed74e171f523629f5cb06ed0c490aedb
-  data.tar.gz: 9ae3b89639a940b6d220e743bfdcde9c04449adb
+SHA256:
+  metadata.gz: 8be56bb5bd7e6183a1f68f1cfeb7baa5da32287d11a50dddc53248561755ee1c
+  data.tar.gz: 14b0d9da9608f4d0cdc465039d202eb35eabb2abe7471f12cdf28af205d0bd01
 SHA512:
-  metadata.gz: ce77ebc9c3ced1a55ea9467f50d2bec5691a56fed2fe16286e92542bac86ecb689ca082fedcc456cd1628fd3648e0b6176b5d67384cb06e127e3eaa54ef0dc87
-  data.tar.gz: 212c5e8b682e2ccc2964aa207f4f58395a4170db80eb6b2aed9ca65591c0169e728d1ee0b2a9aa769b71ea276bfdbadbd6f94e862659892dddc6f404d14988eb
+  metadata.gz: 4a112b0b811700d98a8f5c65958d1f9566b0401bcb885bcd160f2d6d7fdcbbc47b55b72e8b3258f9f3c6a461e3256e5d4c97409fe2ccc3373fbdb2deb5db55d4
+  data.tar.gz: d10fdf287ee66df67eee06cfd9c515bbaab7567cac69a84dbbdf11732ca86609ecafc7d437e3e2c89dff9b4001f9757edc4887061cc5d0c3d606d68629850ed6

data/.travis.yml

@@ -1,44 +1,78 @@
 script: 'bundle exec rake -t test'
 language: ruby
-sudo: false
 
-rvm:
-  - 2.0.0
-  - 2.1.10
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
-  - ruby-head
-  - jruby-9.1.9.0
-  - rubinius-3
+cache: bundler
+
+before_install:
+  - "ruby -e 'exit RUBY_VERSION.to_f >= 2.3' && gem up --system || (gem i rubygems-update -v '<3' && update_rubygems)"
+  - gem up bundler
+
+# rvm:
+#   - 2.6.7
+#   - 2.5.9
+#   - 2.4.10
+#   - 2.3.8
+#   - 2.2.10
+#   - 2.1.10
+#   - 2.0.0
+#   - ruby-head
+# gemfile:
+#   - gemfiles/rails_52.gemfile
+#   - gemfiles/rails_51.gemfile
+#   - gemfiles/rails_50.gemfile
+#   - gemfiles/rails_42.gemfile
+#   - gemfiles/rails_41.gemfile
+#   - gemfiles/rails_edge.gemfile
+
 matrix:
-  exclude:
-    - rvm: 2.0.0
-      gemfile: gemfiles/rails_50.gemfile
-    - rvm: 2.1.10
-      gemfile: gemfiles/rails_50.gemfile
-    - rvm: 2.0.0
-      gemfile: gemfiles/rails_51.gemfile
-    - rvm: 2.1.10
-      gemfile: gemfiles/rails_51.gemfile
-    - rvm: 2.0.0
+  include:
+    - rvm: 3.0.1
+      gemfile: gemfiles/rails_61.gemfile
+    - rvm: 3.0.1
+      gemfile: gemfiles/rails_60.gemfile
+    - rvm: 3.0.1
       gemfile: gemfiles/rails_edge.gemfile
-    - rvm: 2.1.10
+    - rvm: 2.7.3
+      gemfile: gemfiles/rails_61.gemfile
+    - rvm: 2.7.3
       gemfile: gemfiles/rails_edge.gemfile
-    - rvm: 2.4.1
+    - rvm: 2.6.7
+      gemfile: gemfiles/rails_61.gemfile
+    - rvm: 2.6.7
+      gemfile: gemfiles/rails_52.gemfile
+    - rvm: 2.6.7
+      gemfile: gemfiles/rails_51.gemfile
+    - rvm: 2.6.7
+      gemfile: gemfiles/rails_50.gemfile
+    - rvm: 2.5.9
+      gemfile: gemfiles/rails_61.gemfile
+    - rvm: 2.5.9
+      gemfile: gemfiles/rails_52.gemfile
+    - rvm: 2.4.10
+      gemfile: gemfiles/rails_52.gemfile
+    - rvm: 2.3.8
+      gemfile: gemfiles/rails_52.gemfile
+    - rvm: 2.2.10
+      gemfile: gemfiles/rails_42.gemfile
+    - rvm: 2.2.10
       gemfile: gemfiles/rails_41.gemfile
-    - rvm: 2.4.1
+    - rvm: 2.1.10
       gemfile: gemfiles/rails_42.gemfile
+    - rvm: 2.0.0
+      gemfile: gemfiles/rails_42.gemfile
+
     - rvm: ruby-head
-      gemfile: gemfiles/rails_41.gemfile
+      gemfile: gemfiles/rails_61.gemfile
     - rvm: ruby-head
-      gemfile: gemfiles/rails_42.gemfile
+      gemfile: gemfiles/rails_edge.gemfile
+
+    - rvm: jruby-9.2.17.0
+      gemfile: gemfiles/rails_52.gemfile
+    - rvm: rubinius-3
+      gemfile: gemfiles/rails_52.gemfile
+
   allow_failures:
-    - rvm: jruby-9.1.9.0
+    - rvm: ruby-head
+    - rvm: jruby-9.2.17.0
     - rvm: rubinius-3
-gemfile:
-  - gemfiles/rails_41.gemfile
-  - gemfiles/rails_42.gemfile
-  - gemfiles/rails_50.gemfile
-  - gemfiles/rails_51.gemfile
-  - gemfiles/rails_edge.gemfile
+    - gemfile: gemfiles/rails_edge.gemfile

data/Gemfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in action_args.gemspec

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
@@ -157,7 +185,6 @@ The following elegant controller code will be generated:
 
 ```ruby
 class UsersController < ApplicationController
-  before_action :set_user, only: [:show, :edit, :update, :destroy]
   permits :name, :age, :email
 
   # GET /users
@@ -166,7 +193,8 @@ class UsersController < ApplicationController
   end
 
   # GET /users/1
-  def show
+  def show(id)
+    @user = User.find(id)
   end
 
   # GET /users/new
@@ -175,7 +203,8 @@ class UsersController < ApplicationController
   end
 
   # GET /users/1/edit
-  def edit
+  def edit(id)
+    @user = User.find(id)
   end
 
   # POST /users
@@ -185,66 +214,59 @@ class UsersController < ApplicationController
     if @user.save
       redirect_to @user, notice: 'User was successfully created.'
     else
-      render action: 'new'
+      render :new
     end
   end
 
   # PUT /users/1
-  def update(user)
-    if @user.update_attributes(user)
+  def update(id, user)
+    @user = User.find(id)
+
+    if @user.update(user)
       redirect_to @user, notice: 'User was successfully updated.'
     else
-      render action: 'edit'
+      render :edit
     end
   end
 
   # DELETE /users/1
-  def destroy
+  def destroy(id)
+    @user = User.find(id)
     @user.destroy
 
-    redirect_to users_url
+    redirect_to users_url, notice: 'User was successfully destroyed.'
   end
-
-  private
-    # Use callbacks to share common setup or constraints between actions.
-    def set_user(id)
-      @user = User.find(id)
-    end
 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.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 (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
 
@@ -266,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:
 
@@ -292,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/action_args.gemspec

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*-
 # frozen_string_literal: true
+
 $:.push File.expand_path("../lib", __FILE__)
 require 'action_args/version'
 
@@ -11,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'