action_args 1.0.4 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e820e5d9674aa0054496752320674fc8c57c364d
+  data.tar.gz: c854a76604f95d555872c93cc360ad42d19425e8
+SHA512:
+  metadata.gz: b82fea159869a228853c9362d9b321c9a4ef3e9f88b20be10a74b16c96c494317a96fa99936ff7ae2261812645cf89c6e68f959ee802eb942310c35df6126ccf
+  data.tar.gz: 85e3e9513651c34edce33142cc2fa4dc0d539f1eb9163a0464bcdb82686ebac6e549b2963406b56605f3376519b1d3847b576d2f14949749704ef80d4351960e

data/Gemfile

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

data/README.md

@@ -158,7 +158,7 @@ You may notice that
 
 ## Supported versions
 
-* Ruby 1.9.2, 1.9.3, 2.0.0 (trunk), JRuby & Rubinius with 1.9 mode
+* Ruby 1.9.2, 1.9.3, 2.0.0, 2.1.0 (trunk), JRuby & Rubinius with 1.9 mode
 
 * Rails 3.0.x, 3.1.x, 3.2.x, 4.0 (edge)
 
@@ -201,6 +201,31 @@ class BooksController < ApplicationController
 end
 ```
 
+### Default parameter values
+
+You are of course able to specify default values for action parameters such as:
+
+```ruby
+class BooksController < ApplicationController
+  def index(author_id = nil, page = 1)
+    ...
+  end
+end
+```
+
+However, due to some implementational reasons, the `page` variable will be actually defaulted to nil when `page` parameter was not given.
+
+In order to provide default parameter values in perfect Ruby manner, we recommend you to use the Ruby 2.0 "keyword arguments" syntax instead.
+
+```ruby
+class BooksController < ApplicationController
+  def index(author_id: nil, page: 1)
+    ...
+  end
+end
+```
+
+This way, the `page` parameter will be defaulted to 1 as everyone might expect.
 
 ## Copyright
 

data/Rakefile

@@ -19,7 +19,7 @@ namespace :spec do
     end
   end
 
-  desc 'Run Tests against all ORMs'
+  desc 'Run Tests against all Rails versions'
   task :all do
     %w(rails_32 rails_40).each do |gemfile|
       sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle --quiet"

data/gemfiles/rails_32.gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gem 'rails', '>= 3.2.9'
 gem 'rspec-rails', '>= 2.0'

data/gemfiles/rails_40.gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gem 'rails', github: 'rails/rails'
 gem 'activerecord-deprecated_finders', github: 'rails/activerecord-deprecated_finders'

data/lib/action_args.rb

@@ -2,6 +2,7 @@ begin
   require 'strong_parameters'
 rescue LoadError
 end
+require 'action_args/params_handler'
 require 'action_args/abstract_controller'
 
 module ActionArgs

data/lib/action_args/abstract_controller.rb

@@ -4,16 +4,9 @@ module AbstractController
       def send_action(method_name, *args)
         return send method_name, *args unless args.empty?
 
-        target_model_name = self.class.name.sub(/Controller$/, '').singularize.underscore.to_sym
-        permitted_attributes = self.class.instance_variable_get '@permitted_attributes'
-        values = method(method_name).parameters.reject {|type, _| type == :block }.map do |type, key|
-          params.require key if type == :req
-          if (key == target_model_name) && permitted_attributes
-            params[key].try :permit, *permitted_attributes
-          else
-            params[key]
-          end
-        end
+        method_parameters = method(method_name).parameters
+        ActionArgs::ParamsHandler.strengthen_params!(self.class, method_parameters, params)
+        values = ActionArgs::ParamsHandler.extract_method_arguments_from_params method_parameters, params
         send method_name, *values
       end
 
@@ -37,7 +30,7 @@ module AbstractController
       def send_action(method_name, *args)
         return send method_name, *args unless args.empty?
 
-        values = method(method_name).parameters.reject {|type, _| type == :block }.map {|_, key| params[key]}
+        values = ActionArgs::ParamsHandler.extract_method_arguments_from_params method(method_name).parameters, params
         send method_name, *values
       end
     end

data/lib/action_args/params_handler.rb

@@ -0,0 +1,38 @@
+module ActionArgs
+  module ParamsHandler
+    # converts the request params Hash into an Array to be passed into the target Method
+    def self.extract_method_arguments_from_params(method_parameters, params)
+      kwargs = {}
+      parameter_names = method_parameters.map(&:last)
+      method_parameters.reverse_each do |type, key|
+        case type
+        when :req
+          next
+        when :key
+          kwargs[key] = params[key] if params.has_key? key
+        when :opt
+          break if params.has_key? key
+        end
+        # omitting parameters that are :block, :rest, :opt without a param, and :key without a param
+        parameter_names.delete key
+      end
+
+      values = parameter_names.map {|k| params[k]}
+      values << kwargs if kwargs.any?
+      values
+    end
+
+    # permits declared model attributes in the params Hash
+    # note that this method mutates the given params Hash
+    def self.strengthen_params!(controller_class, method_parameters, params)
+      target_model_name = controller_class.name.sub(/.+::/, '').sub(/Controller$/, '').singularize.underscore.to_sym
+      permitted_attributes = controller_class.instance_variable_get '@permitted_attributes'
+
+      method_parameters.each do |type, key|
+        if (key == target_model_name) && permitted_attributes
+          params[key] = params.require(key).try :permit, *permitted_attributes
+        end
+      end
+    end
+  end
+end

data/lib/action_args/version.rb

@@ -1,3 +1,3 @@
 module ActionArgs
-  VERSION = '1.0.4'
+  VERSION = '1.1.0'
 end

data/spec/controllers/action_args_controller_spec.rb

@@ -2,14 +2,21 @@ require 'spec_helper'
 
 describe BooksController do
   describe 'GET index (having an optional parameter)' do
+    before do
+      @books = []
+      Book.delete_all
+      100.times {|i| @books << Book.create!(title: 'book'+i.to_s) }
+    end
     context 'without page parameter' do
       before { get :index }
       its(:response) { should be_success }
+      it { expect(assigns(:books)).to match_array(@books[0..9]) }
     end
 
     context 'with page parameter' do
       before { get :index, page: 3 }
       its(:response) { should be_success }
+      it { expect(assigns(:books)).to match_array(@books[20..29]) }
     end
 
     context 'first param is nil and second is not nil' do

data/spec/controllers/kwargs_controller_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe KwBooksController do
+  describe 'GET index (having an optional parameter)' do
+    context 'without giving any kw parameter' do
+      before { get :index, author_name: 'nari' }
+      its(:response) { should be_success }
+    end
+
+    context 'with kw parameter defaults to non-nil value' do
+      before { get :index, author_name: 'nari', page: 3 }
+      subject { eval response.body }
+      its([:author_name]) { should == 'nari' }
+      its([:page]) { should == '3' }
+      its([:q]) { should == nil }
+    end
+
+    context 'with kw parameter defaults to nil' do
+      before { get :index, author_name: 'nari', q: 'Rails' }
+      subject { eval response.body }
+      its([:author_name]) { should == 'nari' }
+      its([:page]) { should == '1' }
+      its([:q]) { should == 'Rails' }
+    end
+  end
+end if RUBY_VERSION >= '2'

data/spec/controllers/strong_parameters_spec.rb

@@ -13,4 +13,16 @@ if Rails::VERSION::MAJOR >= 4
       it { expect { post :create, :store => {name: 'Tatsu-zine', url: 'http://tatsu-zine.com'} }.to change(Store, :count).by(1) }
     end
   end
+
+  describe Admin::BooksController do
+    context "this controller doesn't permit price of new book" do
+      describe 'POST create' do
+        before { post :create, :book => {title: 'naruhoUnix', price: 30} }
+
+        it 'should not save price of the book' do
+          expect(Book.last.price).to be_nil
+        end
+      end
+    end
+  end
 end

data/spec/fake_app.rb

@@ -15,7 +15,12 @@ ActionArgsTestApp::Application.initialize!
 ActionArgsTestApp::Application.routes.draw do
   resources :authors
   resources :books
+  resources :kw_books  # 2.0+ only
   resources :stores
+
+  namespace :admin do
+    resources :books
+  end
 end
 
 # models
@@ -40,10 +45,10 @@ class AuthorsController < ApplicationController
 end
 class BooksController < ApplicationController
   # optional parameter
-  def index(page = 1, q = nil)
-    @books = Book.limit(10).offset(([page.to_i - 1, 0].max) * 10)
+  def index(page = 1, q = nil, limit = 10)
+    @books = Book.limit(limit.to_i).offset(([page.to_i - 1, 0].max) * 10)
     @books = @books.where('title like ?', "%#{q}%") unless q.blank?
-    render text: 'index'
+    render text: 'index', books: @books
   end
 
   def show(id)
@@ -71,8 +76,20 @@ if Rails::VERSION::MAJOR >= 4
       render text: @store.name
     end
   end
+  module Admin
+    class BooksController < ::ApplicationController
+      permits :title
+
+      def create(book)
+        @book = Book.create! book
+        render text: @book.title
+      end
+    end
+  end
 end
 
+require_relative 'kwargs_controllers' if RUBY_VERSION >= '2'
+
 # migrations
 class CreateAllTables < ActiveRecord::Migration
   def self.up

data/spec/kwargs_controllers.rb

@@ -0,0 +1,8 @@
+# this file should not be loaded from Ruby <2.0
+
+class KwBooksController < ApplicationController
+  # keyword arguments
+  def index(author_name, page: '1', q: nil)
+    render text: {author_name: author_name, page: page, q: q}.inspect
+  end
+end

data/spec/params_handler/params_handler_spec.rb

@@ -0,0 +1,158 @@
+require 'spec_helper'
+
+describe ActionArgs::ParamsHandler do
+  # ActionArgs::ParamsHandler.extract_method_arguments_from_params(method_parameters, params)
+  describe 'extract_method_arguments_from_params' do
+    let(:params) { {a: '1', b: '2'} }
+    subject { ActionArgs::ParamsHandler.extract_method_arguments_from_params method(:m).parameters, params }
+    context 'no parameters' do
+      before do
+        def m() end
+      end
+      it { should == [] }
+    end
+
+    context '1 req' do
+      before do
+        def m(a) end
+      end
+      it { should == ['1'] }
+    end
+
+    context '2 reqs' do
+      before do
+        def m(a, b) end
+      end
+      it { should == ['1', '2'] }
+    end
+
+    context '1 opt with value' do
+      before do
+        def m(a = 'a') end
+      end
+      it { should == ['1'] }
+    end
+
+    context '1 opt without value' do
+      before do
+        def m(x = 'x') end
+      end
+      it { should == [] }
+    end
+
+    context 'req, opt with value' do
+      before do
+        def m(a, b = 'b') end
+      end
+      it { should == ['1', '2'] }
+    end
+
+    context 'req, opt without value' do
+      before do
+        def m(a, x = 'x') end
+      end
+      it { should == ['1'] }
+    end
+
+    context 'opt with value, opt with value' do
+      before do
+        def m(a = 'a', b = 'b') end
+      end
+      it { should == ['1', '2'] }
+    end
+
+    context 'opt with value, opt without value' do
+      before do
+        def m(a = 'a', x = 'x') end
+      end
+      it { should == ['1'] }
+    end
+
+    context 'opt without value, opt with value' do
+      before do
+        def m(x = 'x', a = 'a') end
+      end
+      it { should == [nil, '1'] }
+    end
+
+    context 'opt without value, opt without value' do
+      before do
+        def m(x = 'x', y = 'y') end
+      end
+      it { should == [] }
+    end
+
+    context 'opt with value, req' do
+      before do
+        def m(a = 'a', b) end
+      end
+      it { should == ['1', '2'] }
+    end
+
+    context 'opt without value, req' do
+      before do
+        def m(x = 'x', a) end
+      end
+      it { should == ['1'] }
+    end
+
+    context 'opt without value, opt with value, req' do
+      before do
+        def m(x = 'x', b = 'b', a) end
+      end
+      it { should == [nil, '2', '1'] }
+    end
+    context 'opt with value, opt without value, req' do
+      before do
+        def m(b = 'b', x = 'x', a) end
+      end
+      it { should == ['2', '1'] }
+    end
+  end
+
+  if defined? ActionController::StrongParameters
+    # strengthen_params!(controller_class, method_parameters, params)
+    describe 'strengthen_params!' do
+      before { ActionArgs::ParamsHandler.strengthen_params! controller, controller.new.method(:a).parameters, params }
+      let(: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'}) }
+
+      context 'requiring via :req, permitting all scalars' do
+        let(:controller) { FooController ||= Class.new(ApplicationController) { permits :a, :b; def a(foo) end } }
+        subject { params[:foo] }
+        it { should be_permitted }
+        its([:a]) { should be }
+        its([:b]) { should be }
+      end
+
+      context 'requiring via :req, not permitting all scalars' do
+        let(:controller) { BarController ||= Class.new(ApplicationController) { permits :a; def a(bar, x = 'x') end } }
+        subject { params[:bar] }
+        it { should be_permitted }
+        its([:a]) { should be }
+        its([:b]) { should_not be }
+      end
+
+      context 'requiring via :req, not permitting any scalars' do
+        let(:controller) { BazController ||= Class.new(ApplicationController) { def a(baz, aho = 'omg') end } }
+        subject { params[:baz] }
+        it { should_not be_permitted }
+      end
+
+      context 'requiring via :opt, permitting all scalars' do
+        let(:controller) { HogeController ||= Class.new(ApplicationController) { permits :a, :b; def a(hoge = {}) end } }
+        subject { params[:hoge] }
+        it { should be_permitted }
+        its([:a]) { should be }
+        its([:b]) { should be }
+      end
+
+      context 'requiring via :key, permitting all scalars' do
+        let(:controller) { FugaController ||= Class.new(ApplicationController) { permits :a, :b; def a(fuga: {}) end } }
+        subject { params[:fuga] }
+        it { should be_permitted }
+        its([:a]) { should be }
+        its([:b]) { should be }
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_args
 version: !ruby/object:Gem::Version
-  version: 1.0.4
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-12 00:00:00.000000000 Z
+date: 2013-05-21 00:00:00.000000000 Z
 dependencies: []
 description: Rails plugin gem that supports Merbish style controller action arguments.
 email:
@@ -29,43 +28,49 @@ files:
 - gemfiles/rails_40.gemfile
 - lib/action_args.rb
 - lib/action_args/abstract_controller.rb
+- lib/action_args/params_handler.rb
 - lib/action_args/version.rb
 - lib/generators/action_args/rspec/scaffold/scaffold_generator.rb
 - lib/generators/action_args/rspec/scaffold/templates/action_args_controller_spec.rb
 - lib/generators/rails/action_args_scaffold_controller_generator.rb
 - lib/generators/rails/templates/controller.rb
 - spec/controllers/action_args_controller_spec.rb
+- spec/controllers/kwargs_controller_spec.rb
 - spec/controllers/ordinal_controller_spec.rb
 - spec/controllers/strong_parameters_spec.rb
 - spec/fake_app.rb
+- spec/kwargs_controllers.rb
+- spec/params_handler/params_handler_spec.rb
 - spec/spec_helper.rb
 homepage: http://asakusa.rubyist.net/
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: action_args
-rubygems_version: 1.8.24
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+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/kwargs_controller_spec.rb
 - spec/controllers/ordinal_controller_spec.rb
 - spec/controllers/strong_parameters_spec.rb
 - spec/fake_app.rb
+- spec/kwargs_controllers.rb
+- spec/params_handler/params_handler_spec.rb
 - spec/spec_helper.rb