action_args 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 934fd8b7952d38e30c4ddd6a38ae073f28ba622e
-  data.tar.gz: cd9f1a095d88748cdbeb2f0457711f59bfd70ebb
+  metadata.gz: 08400217d2c2140b99d452215b2c61abf84e4970
+  data.tar.gz: 497ce69932a416822d0091fac672635da7c74e1d
 SHA512:
-  metadata.gz: 27612eea7d1ed88309d165b557804f7c8be1a785ceb2e1734fc2401229726b308ab35e11a0c1f4b2b117401d905f76a6661a6bc12e3cc96e330f47ebe535453f
-  data.tar.gz: b9e3a78501ce177f5f30dfb25b5e99271ddd380699d4b5497216d9992c2648b452f231c95d073410411903c2aac4ca8842ed2273a9f565dde5391ee79014d2c7
+  metadata.gz: 611853b0ba4d24a9af960f3e3c39a17155efab017b4bf4703dbf3bb19db13633da2f7f8a66c53270de3aa21fdec0afd7e4753d45978fc602c2dff406d9374165
+  data.tar.gz: 1c513207a195c7293122f487c24aa1f493e8747823191e09a1d0e8c9682b0372b908cb0c3f98c5b7b1e11b811739ed780a358b00ee4aa1f9a8467c15a79b3b17

data/.travis.yml

@@ -3,7 +3,7 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1
   - ruby-head
   - jruby
   - rbx-19mode
@@ -15,3 +15,4 @@ matrix:
 gemfile:
   - gemfiles/rails_32.gemfile
   - gemfiles/rails_40.gemfile
+  - gemfiles/rails_41.gemfile

data/CONTRIBUTING.md

@@ -0,0 +1,16 @@
+# Contributing
+
+## Running specs
+
+ActionArgs has several Bundler Gemfiles, each of which bundles different version of Rails.
+
+    % ls gemfiles/*.gemfile
+    gemfiles/rails_32.gemfile gemfiles/rails_40.gemfile gemfiles/rails_41.gemfile
+
+Via BUNDLE_GEMFILE ENV variable, you can tell Bundler which version of Rails to bundle.
+
+    $ BUNDLE_GEMFILE=gemfiles/rails_40.gemfile bundle ex rake spec
+
+Simply executing this command would probably run all tests against each version of Rails:
+
+    % rake spec:all

data/README.md

@@ -24,13 +24,11 @@ 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,
 
 
-## StrongParameters
+## Method parameter types in Ruby, and how ActionArgs handles parameters
 
-ActionArgs plays very nice with Rails 4 StrongParameters.
-
-### Required 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,
-an ArgumentError is raised.
+ActionContrller::BadRequest (or ArgumentError in Rails 3) is raised.
 
 In this `show` action, ActionArgs will require that `id` parameter is provided.
 ```ruby
@@ -42,7 +40,7 @@ class UsersController < ApplicationController
 end
 ```
 
-### Optional Parameters
+### Optional Parameters (:opt)
 Default parameter values are assigned in the standard way. Parameters with a default value will not require a matching item in the `params` Hash.
 
 ```ruby
@@ -54,8 +52,37 @@ class UsersController < ApplicationController
 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.
+
+```ruby
+class UsersController < ApplicationController
+  # the `page` parameter is optional
+  def index(page: nil)
+    @users = User.page(page).per(50)
+  end
+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.
+
+```ruby
+class CommentsController < ApplicationController
+  def create(post_id:, comment:)
+    post = Post.find post_id
+    if post.create comment
+      ...
+  end
+end
+```
+
 ### StrongParameters - permit
 
+ActionArgs plays very nice with Rails 4 StrongParameters.
+
 1. Inline declaration
 
 Hashes simply respond to the StrongParameters' `permit` method.
@@ -174,9 +201,9 @@ You may notice that
 
 ## Supported versions
 
-* Ruby 1.9.2, 1.9.3, 2.0.0, 2.1.0 (trunk), JRuby & Rubinius with 1.9 mode
+* Ruby 1.9.2, 1.9.3, 2.0.0, 2.1.x, 2.2.0 (trunk), JRuby, & Rubinius with 1.9+ mode
 
-* Rails 3.0.x, 3.1.x, 3.2.x, 4.0 (edge)
+* Rails 3.0.x, 3.1.x, 3.2.x, 4.0.x, 4.1.x, 4.2 (edge)
 
 
 ## Installation

data/Rakefile

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

data/action_args.gemspec

@@ -18,4 +18,7 @@ Gem::Specification.new do |s|
   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.require_paths = ["lib"]
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
 end

data/gemfiles/rails_32.gemfile

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

data/gemfiles/rails_40.gemfile

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

data/gemfiles/rails_41.gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.1.0'
+gem 'rspec-rails', '~> 2.0', '< 2.99'
+
+gemspec :path => '../'
+
+platforms :ruby do
+  gem 'sqlite3'
+end
+
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+end

data/lib/action_args/params_handler.rb

@@ -2,12 +2,19 @@ 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 = {}
+      kwargs, missing_required_params = {}, []
       parameter_names = method_parameters.map(&:last)
       method_parameters.reverse_each do |type, key|
         case type
         when :req
+          missing_required_params << key unless params.has_key? key
           next
+        when :keyreq
+          if params.has_key? key
+            kwargs[key] = params[key]
+          else
+            missing_required_params << key
+          end
         when :key
           kwargs[key] = params[key] if params.has_key? key
         when :opt
@@ -16,6 +23,13 @@ module ActionArgs
         # omitting parameters that are :block, :rest, :opt without a param, and :key without a param
         parameter_names.delete key
       end
+      if missing_required_params.any?
+        if defined? ActionController::BadRequest
+          raise ActionController::BadRequest.new(:required, ArgumentError.new("Missing required parameters: #{missing_required_params.join(', ')}"))
+        else
+          raise ArgumentError, "Missing required parameters: #{missing_required_params.join(', ')}"
+        end
+      end
 
       values = parameter_names.map {|k| params[k]}
       values << kwargs if kwargs.any?

data/lib/action_args/version.rb

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

data/spec/controllers/kwargs_controller_spec.rb

@@ -2,7 +2,15 @@ require 'spec_helper'
 
 describe KwBooksController do
   describe 'GET index (having an optional parameter)' do
-    context 'without giving any kw parameter' do
+    context 'without giving any kw parameter (not even giving :required one)' do
+      if ActionPack::VERSION::MAJOR >= 4
+        it { expect { get :index }.to raise_error ActionController::BadRequest }
+      else
+        it { expect { get :index }.to raise_error ArgumentError }
+      end
+    end
+
+    context 'without giving any optional kw parameter' do
       before { get :index, author_name: 'nari' }
       its(:response) { should be_success }
     end

data/spec/controllers/kwargs_keyreq_controller_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe KwKeyreqBooksController do
+  describe 'GET index (having an optional parameter)' do
+    context 'without giving any kw parameter (not even giving :required one)' do
+      if ActionPack::VERSION::MAJOR >= 4
+        it { expect { get :index }.to raise_error ActionController::BadRequest }
+      else
+        it { expect { get :index }.to raise_error ArgumentError }
+      end
+    end
+
+    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.1'

data/spec/fake_app.rb

@@ -16,6 +16,7 @@ ActionArgsTestApp::Application.routes.draw do
   resources :authors
   resources :books
   resources :kw_books  # 2.0+ only
+  resources :kw_keyreq_books  # 2.1+ only
   resources :stores
 
   namespace :admin do
@@ -102,6 +103,7 @@ if Rails::VERSION::MAJOR >= 4
 end
 
 require_relative 'kwargs_controllers' if RUBY_VERSION >= '2'
+require_relative 'kwargs_keyreq_controllers' if RUBY_VERSION >= '2.1'
 
 # migrations
 class CreateAllTables < ActiveRecord::Migration

data/spec/kwargs_keyreq_controllers.rb

@@ -0,0 +1,8 @@
+# this file should not be loaded from Ruby <2.1
+
+class KwKeyreqBooksController < 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

@@ -102,12 +102,60 @@ describe ActionArgs::ParamsHandler do
       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
+
+    if Rails::VERSION::MAJOR >= 4
+      context 'req without a value' do
+        before do
+          def m(x) end
+        end
+        it { expect { subject }.to raise_error ActionController::BadRequest }
+      end
+    end
+
+    if RUBY_VERSION >= '2'
+      eval <<-KWARGS_TEST
+        context 'key' do
+          before do
+            def m(a: nil) end
+          end
+          it { should == [a: '1'] }
+        end
+
+        context 'key, key without value' do
+          before do
+            def m(a: nil, x: 'x') end
+          end
+          it { should == [a: '1'] }
+        end
+      KWARGS_TEST
+    end
+
+    if RUBY_VERSION >= '2.1'
+      eval <<-KWARGS_KEYREQ_TEST
+        context 'keyreq' do
+          before do
+            def m(a:) end
+          end
+          it { should == [a: '1'] }
+        end
+
+        if Rails::VERSION::MAJOR >= 4
+          context 'keyreq, keyreq without value' do
+            before do
+              def m(a:, x:) end
+            end
+            it { expect { subject }.to raise_error ::ActionController::BadRequest }
+          end
+        end
+      KWARGS_KEYREQ_TEST
+    end
   end
 
   if defined? ActionController::StrongParameters

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: action_args
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-24 00:00:00.000000000 Z
-dependencies: []
+date: 2014-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rails plugin gem that supports Merbish style controller action arguments.
 email:
 - ronnie@dio.jp
@@ -19,6 +47,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CONTRIBUTING.md
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -26,6 +55,7 @@ files:
 - action_args.gemspec
 - gemfiles/rails_32.gemfile
 - gemfiles/rails_40.gemfile
+- gemfiles/rails_41.gemfile
 - lib/action_args.rb
 - lib/action_args/abstract_controller.rb
 - lib/action_args/params_handler.rb
@@ -36,10 +66,12 @@ files:
 - lib/generators/rails/templates/controller.rb
 - spec/controllers/action_args_controller_spec.rb
 - spec/controllers/kwargs_controller_spec.rb
+- spec/controllers/kwargs_keyreq_controller_spec.rb
 - spec/controllers/ordinal_controller_spec.rb
 - spec/controllers/strong_parameters_spec.rb
 - spec/fake_app.rb
 - spec/kwargs_controllers.rb
+- spec/kwargs_keyreq_controllers.rb
 - spec/mailers/action_mailer_spec.rb
 - spec/params_handler/params_handler_spec.rb
 - spec/spec_helper.rb
@@ -69,10 +101,12 @@ 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/kwargs_keyreq_controller_spec.rb
 - spec/controllers/ordinal_controller_spec.rb
 - spec/controllers/strong_parameters_spec.rb
 - spec/fake_app.rb
 - spec/kwargs_controllers.rb
+- spec/kwargs_keyreq_controllers.rb
 - spec/mailers/action_mailer_spec.rb
 - spec/params_handler/params_handler_spec.rb
 - spec/spec_helper.rb