action_args 1.0.0 → 1.0.1

data/README.rdoc

@@ -25,7 +25,28 @@ So, you do never need to touch the ugly +params+ Hash in order to fetch the requ
 == StrongParameters
 
 ActionArgs plays very nice with Rails 4 StrongParameters.
-Hashes in the action method arguments simply responds to the `permit` method.
+
+In this `show` action, ActionArgs `require`s the `id` parameter.
+Hence, raises an error if the `id` value has not been specified, in the same way as usual Ruby methods do.
+
+  class UsersController < ApplicationController
+    # the `id` parameter is mandatory
+    def show(id)
+      @user = User.find id
+    end
+  end
+
+If you don't want ActionArgs to check the existence of some action parameters, you can make them optional by defining option values.
+Again, it just acts in the same way as usual Ruby methods do.
+
+  class UsersController < ApplicationController
+    # the `page` parameter is optional
+    def index(page = nil)
+      @users = User.page(page).per(50)
+    end
+  end
+
+Hashes in the action method arguments simply respond to the StrongParameters' `permit` method.
 
   class UsersController < ApplicationController
     def create(user)
@@ -55,7 +76,7 @@ The `permits` method assumes the model class from the controller name, and
 ActionArgs provides a custom scaffold controller generator that overwrites the default scaffold generator.
 Thus, by hitting the following command:
 
-  % rails g scaffold user name:string
+  % rails g scaffold user name age:integer email
 
 The following beautiful controller code will be generated:
 

data/lib/action_args/abstract_controller.rb

@@ -6,15 +6,17 @@ module AbstractController
       values = if defined? ActionController::StrongParameters
         target_model_name = self.class.name.sub(/Controller$/, '').singularize.underscore.to_sym
         permitted_attributes = self.class.instance_variable_get '@permitted_attributes'
-        method(method_name).parameters.reject {|kind, _| kind == :block }.map(&:last).map do |k|
-          if (k == target_model_name) && permitted_attributes
-            params.require(k).permit(*permitted_attributes)
+        method(method_name).parameters.map {|type, key|
+          next if type == :block
+          params.require key if type == :req
+          if (key == target_model_name) && permitted_attributes
+            params[key].try :permit, *permitted_attributes
           else
-            params.require(k)
+            params[key]
           end
-        end
+        }.compact
       else
-        method(method_name).parameters.reject {|kind, _| kind == :block }.map(&:last).map {|k| params[k]}
+        method(method_name).parameters.map {|type, key| params[key] unless type == :block }.compact
       end
       send method_name, *values
     end

data/lib/action_args/version.rb

@@ -1,3 +1,3 @@
 module ActionArgs
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/spec/controllers/action_args_controller_spec.rb

@@ -1,6 +1,18 @@
 require 'spec_helper'
 
 describe BooksController do
+  describe 'GET index (having an optional parameter)' do
+    context 'without page parameter' do
+      before { get :index }
+      its(:response) { should be_success }
+    end
+
+    context 'with page parameter' do
+      before { get :index, page: 3 }
+      its(:response) { should be_success }
+    end
+  end
+
   describe 'GET show' do
     let(:rhg) { Book.create! title: 'RHG' }
     before { get :show, :id => rhg.id }

data/spec/fake_app.rb

@@ -39,6 +39,12 @@ class AuthorsController < ApplicationController
   end
 end
 class BooksController < ApplicationController
+  # optional parameter
+  def index(page = 1)
+    @books = Book.limit(10).offset((page.to_i - 1) * 10)
+    render text: 'index'
+  end
+
   def show(id)
     @book = Book.find(id)
     render text: @book.title

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_args
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-27 00:00:00.000000000 Z
+date: 2012-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3