action_args 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08400217d2c2140b99d452215b2c61abf84e4970
-  data.tar.gz: 497ce69932a416822d0091fac672635da7c74e1d
+  metadata.gz: f1be64c562566fa50677fd49064390945ef09e08
+  data.tar.gz: 579d02790193ebe0bb9bd3fc032ca29785b1f28c
 SHA512:
-  metadata.gz: 611853b0ba4d24a9af960f3e3c39a17155efab017b4bf4703dbf3bb19db13633da2f7f8a66c53270de3aa21fdec0afd7e4753d45978fc602c2dff406d9374165
-  data.tar.gz: 1c513207a195c7293122f487c24aa1f493e8747823191e09a1d0e8c9682b0372b908cb0c3f98c5b7b1e11b811739ed780a358b00ee4aa1f9a8467c15a79b3b17
+  metadata.gz: dcbe4c44a809e0fde4684c288c56f00b5595ffad2a38b6afd0bf2e14820d8694c949bb00f3b0c37bc3e5c8fb4ae1b88c48625e20fedbf52536b3c98c913ce960
+  data.tar.gz: 81d8cc112ced51eee850a17bd6f58441ecce23b7c8a976b0ab980d053a26b4cf85688b9096174e6ad34c4d7ac902d55e384bb06fec8a4f7582ef9498686fe05d

data/.travis.yml

@@ -4,15 +4,17 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1
+  - 2.2
   - ruby-head
   - jruby
-  - rbx-19mode
+  - rbx
 matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: jruby
-    - rvm: rbx-19mode
+    - rvm: rbx
 gemfile:
   - gemfiles/rails_32.gemfile
   - gemfiles/rails_40.gemfile
   - gemfiles/rails_41.gemfile
+  - gemfiles/rails_42.gemfile

data/README.md

@@ -21,7 +21,7 @@ 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,
+This allows you to explicitly state which members of the `params` Hash are used in your controller actions.
 
 
 ## Method parameter types in Ruby, and how ActionArgs handles parameters
@@ -124,6 +124,25 @@ class MembersController < ApplicationController
 end
 ```
 
+## Filters
+
+ActionArgs works in filters, in the same way as it works in controller actions.
+
+```ruby
+class UsersController < ApplicationController
+  before_action :set_user, only: :show
+
+  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
+end
+```
+
 ## The Scaffold Generator
 
 ActionArgs provides a custom scaffold controller generator that overwrites the default scaffold generator.
@@ -139,6 +158,7 @@ The following elegant controller code will be generated:
 # coding: utf-8
 
 class UsersController < ApplicationController
+  before_action :set_user, only: [:show, :edit, :update, :destroy]
   permits :name, :age, :email
 
   # GET /users
@@ -147,8 +167,7 @@ class UsersController < ApplicationController
   end
 
   # GET /users/1
-  def show(id)
-    @user = User.find(id)
+  def show
   end
 
   # GET /users/new
@@ -157,8 +176,7 @@ class UsersController < ApplicationController
   end
 
   # GET /users/1/edit
-  def edit(id)
-    @user = User.find(id)
+  def edit
   end
 
   # POST /users
@@ -173,9 +191,7 @@ class UsersController < ApplicationController
   end
 
   # PUT /users/1
-  def update(id, user)
-    @user = User.find(id)
-
+  def update(user)
     if @user.update_attributes(user)
       redirect_to @user, notice: 'User was successfully updated.'
     else
@@ -184,12 +200,17 @@ class UsersController < ApplicationController
   end
 
   # DELETE /users/1
-  def destroy(id)
-    @user = User.find(id)
+  def destroy
     @user.destroy
 
     redirect_to users_url
   end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_user(id)
+      @user = User.find(id)
+    end
 end
 ```
 
@@ -201,9 +222,9 @@ You may notice that
 
 ## Supported versions
 
-* Ruby 1.9.2, 1.9.3, 2.0.0, 2.1.x, 2.2.0 (trunk), JRuby, & Rubinius with 1.9+ mode
+* Ruby 1.9.2, 1.9.3, 2.0.0, 2.1.x, 2.2.x, 2.3.0 (trunk), JRuby, & Rubinius with 1.9+ mode
 
-* Rails 3.0.x, 3.1.x, 3.2.x, 4.0.x, 4.1.x, 4.2 (edge)
+* Rails 3.0.x, 3.1.x, 3.2.x, 4.0.x, 4.1.x, 4.2.x, 5.0 (edge)
 
 
 ## Installation

data/action_args.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec-rails', ['~> 2.0', '< 2.99']
 end

data/gemfiles/rails_32.gemfile

@@ -1,7 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'rails', '~> 3.2.9'
-gem 'rspec-rails', '~> 2.0', '< 2.99'
 
 gemspec :path => '../'
 
@@ -12,3 +11,4 @@ end
 platforms :jruby do
   gem 'activerecord-jdbcsqlite3-adapter'
 end
+gem 'test-unit'

data/gemfiles/rails_40.gemfile

@@ -1,7 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'rails', '~> 4.0.0'
-gem 'rspec-rails', '~> 2.0', '< 2.99'
 
 gemspec :path => '../'
 
@@ -12,3 +11,5 @@ end
 platforms :jruby do
   gem 'activerecord-jdbcsqlite3-adapter'
 end
+
+gem 'test-unit'

data/gemfiles/rails_41.gemfile

@@ -1,7 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'rails', '~> 4.1.0'
-gem 'rspec-rails', '~> 2.0', '< 2.99'
 
 gemspec :path => '../'
 

data/gemfiles/rails_42.gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.2.0'
+
+gemspec :path => '../'
+
+platforms :ruby do
+  gem 'sqlite3'
+end
+
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+end

data/lib/action_args.rb

@@ -4,6 +4,7 @@ rescue LoadError
 end
 require 'action_args/params_handler'
 require 'action_args/abstract_controller'
+require 'action_args/callbacks'
 
 module ActionArgs
   class Railtie < ::Rails::Railtie

data/lib/action_args/callbacks.rb

@@ -0,0 +1,71 @@
+module ActiveSupport
+  module Callbacks
+    class Callback
+      if Rails.version > '4.1'
+        # 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_with_method_parameters(filter)
+          if Symbol === filter
+            lambda do |target, _, &blk|
+              if ActionController::Base === target
+                meth = target.method filter
+                method_parameters = meth.parameters
+                ActionArgs::ParamsHandler.strengthen_params!(target.class, method_parameters, target.params)
+                values = ActionArgs::ParamsHandler.extract_method_arguments_from_params method_parameters, target.params
+                target.send filter, *values, &blk
+              else
+                target.send filter, &blk
+              end
+            end
+          else
+            make_lambda_without_method_parameters filter
+          end
+        end
+        alias_method_chain :make_lambda, :method_parameters
+
+      elsif Rails.version > '4.0'
+        def apply_with_method_parameters(code)
+          if (Symbol === @filter) && (@klass < ActionController::Base)
+            method_body = <<-FILTER
+              meth = method :#{@filter}
+              method_parameters = meth.parameters
+              ActionArgs::ParamsHandler.strengthen_params!(self.class, method_parameters, params)
+              values = ActionArgs::ParamsHandler.extract_method_arguments_from_params method_parameters, params
+              send :#{@filter}, *values
+            FILTER
+            if @kind == :before
+              @filter = "begin\n#{method_body}\nend"
+            else
+              @filter = method_body.chomp
+            end
+          end
+          apply_without_method_parameters code
+        end
+        alias_method_chain :apply, :method_parameters
+
+      else  # Rails 3.2
+        def start_with_method_parameters(key=nil, object=nil)
+          if (Symbol === @filter) && (@klass < ActionController::Base)
+            method_body = <<-FILTER
+              meth = method :#{@filter}
+              method_parameters = meth.parameters
+              ActionArgs::ParamsHandler.strengthen_params!(self.class, method_parameters, params)
+              values = ActionArgs::ParamsHandler.extract_method_arguments_from_params method_parameters, params
+              send :#{@filter}, *values
+            FILTER
+            if @kind == :before
+              @filter = "begin\n#{method_body}\nend"
+            else
+              @filter = method_body.chomp
+            end
+          end
+          start_without_method_parameters key, object
+        end
+        alias_method_chain :start, :method_parameters
+      end
+    end
+  end
+end

data/lib/action_args/version.rb

@@ -1,3 +1,3 @@
 module ActionArgs
-  VERSION = '1.4.0'.freeze
+  VERSION = '1.5.1'.freeze
 end

data/lib/generators/rails/templates/controller.rb

@@ -1,6 +1,7 @@
 # coding: utf-8
 
 class <%= controller_class_name %>Controller < ApplicationController
+  before_action :set_<%= singular_table_name %>, only: [:show, :edit, :update, :destroy]
 <% if defined? ActionController::StrongParameters -%>
   permits <%= attributes.map {|a| ":#{a.name}" }.join(', ') %>
 
@@ -11,8 +12,7 @@ class <%= controller_class_name %>Controller < ApplicationController
   end
 
   # GET <%= route_url %>/1
-  def show(id)
-    @<%= singular_table_name %> = <%= orm_class.find(class_name, 'id') %>
+  def show
   end
 
   # GET <%= route_url %>/new
@@ -21,8 +21,7 @@ class <%= controller_class_name %>Controller < ApplicationController
   end
 
   # GET <%= route_url %>/1/edit
-  def edit(id)
-    @<%= singular_table_name %> = <%= orm_class.find(class_name, 'id') %>
+  def edit
   end
 
   # POST <%= route_url %>
@@ -37,9 +36,7 @@ class <%= controller_class_name %>Controller < ApplicationController
   end
 
   # PUT <%= route_url %>/1
-  def update(id, <%= singular_table_name %>)
-    @<%= singular_table_name %> = <%= orm_class.find(class_name, 'id') %>
-
+  def update(<%= singular_table_name %>)
 <% if orm_instance.respond_to? :update -%>
     if @<%= orm_instance.update(singular_table_name) %>
 <% else -%>
@@ -52,10 +49,15 @@ class <%= controller_class_name %>Controller < ApplicationController
   end
 
   # DELETE <%= route_url %>/1
-  def destroy(id)
-    @<%= singular_table_name %> = <%= orm_class.find(class_name, 'id') %>
+  def destroy
     @<%= orm_instance.destroy %>
 
     redirect_to <%= index_helper %>_url, notice: <%= "'#{human_name} was successfully destroyed.'" %>
   end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_<%= singular_table_name %>(id)
+      @<%= singular_table_name %> = <%= orm_class.find(class_name, 'id') %>
+    end
 end

data/spec/controllers/hooks_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe BooksController, 'action hooks' do
+  before do
+    Book.delete_all
+    @book = Book.create! title: 'Head First ActionArgs'
+    get :show, id: @book.id
+  end
+
+  describe 'before_action' do
+    context 'via Symbol' do
+      subject { assigns :book }
+      it { should == @book }
+    end
+
+    context 'via String' do
+      subject { assigns :string_filter_executed }
+      it { should be_true }
+    end
+
+    context 'via Proc' do
+      subject { assigns :proc_filter_executed }
+      it { should be_true }
+    end
+  end
+
+  describe 'around_action' do
+    subject { assigns :elapsed_time }
+    it { should be }
+  end
+end

data/spec/fake_app.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 # config
 ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
 
@@ -58,6 +60,22 @@ class AuthorsController < ApplicationController
   end
 end
 class BooksController < ApplicationController
+  if Rails::VERSION::MAJOR >= 4
+    before_action :set_book, only: :show
+    before_action -> { @proc_filter_executed = true }, only: :show
+    before_action '@string_filter_executed = true', only: :show
+    around_action :benchmark_action
+    before_action :omg
+    skip_before_action :omg
+  else
+    before_filter :set_book, only: :show
+    before_filter -> { @proc_filter_executed = true }, only: :show
+    before_filter '@string_filter_executed = true', only: :show
+    around_filter :benchmark_action
+    before_filter :omg
+    skip_before_filter :omg
+  end
+
   # optional parameter
   def index(page = 1, q = nil, limit = 10)
     @books = Book.limit(limit.to_i).offset(([page.to_i - 1, 0].max) * 10)
@@ -66,7 +84,6 @@ class BooksController < ApplicationController
   end
 
   def show(id)
-    @book = Book.find(id)
     render text: @book.title
   end
 
@@ -75,6 +92,21 @@ class BooksController < ApplicationController
     @book = Book.create! book
     render text: @book.title
   end
+
+  private
+    def set_book(id)
+      @book = Book.find(id)
+    end
+
+    def benchmark_action
+      start  = Time.now
+      yield
+      @elapsed_time = Time.now - start
+    end
+
+    def omg
+      raise '💣'
+    end
 end
 if Rails::VERSION::MAJOR >= 4
   class StoresController < ApplicationController

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_args
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-25 00:00:00.000000000 Z
+date: 2015-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.99'
 description: Rails plugin gem that supports Merbish style controller action arguments.
 email:
 - ronnie@dio.jp
@@ -56,8 +76,10 @@ files:
 - gemfiles/rails_32.gemfile
 - gemfiles/rails_40.gemfile
 - gemfiles/rails_41.gemfile
+- gemfiles/rails_42.gemfile
 - lib/action_args.rb
 - lib/action_args/abstract_controller.rb
+- lib/action_args/callbacks.rb
 - lib/action_args/params_handler.rb
 - lib/action_args/version.rb
 - lib/generators/action_args/rspec/scaffold/scaffold_generator.rb
@@ -65,6 +87,7 @@ files:
 - lib/generators/rails/action_args_scaffold_controller_generator.rb
 - lib/generators/rails/templates/controller.rb
 - spec/controllers/action_args_controller_spec.rb
+- spec/controllers/hooks_spec.rb
 - spec/controllers/kwargs_controller_spec.rb
 - spec/controllers/kwargs_keyreq_controller_spec.rb
 - spec/controllers/ordinal_controller_spec.rb
@@ -94,12 +117,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: action_args
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Controller action arguments parameterizer for Rails 3+ & Ruby 1.9+
 test_files:
 - spec/controllers/action_args_controller_spec.rb
+- spec/controllers/hooks_spec.rb
 - spec/controllers/kwargs_controller_spec.rb
 - spec/controllers/kwargs_keyreq_controller_spec.rb
 - spec/controllers/ordinal_controller_spec.rb