action_args 1.0.2 → 1.0.3

data/.travis.yml

@@ -3,12 +3,12 @@ language: ruby
 rvm:
   - 1.9.3
   - ruby-head
-  - jruby-head
+  - jruby
   - rbx-19mode
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby-head
+    - rvm: jruby
     - rvm: rbx-19mode
 gemfile:
   - gemfiles/rails_32.gemfile

data/README.md

@@ -0,0 +1,207 @@
+# ActionArgs
+
+Controller action arguments parameterizer for Rails 3+
+
+
+## What is this?
+
+ActionArgs is a Rails plugin that extends your controller action methods to look and act like simple general Ruby methods with meaningful parameters, or in short, Merbish.
+
+
+## The Controllers
+
+Having the following controller code:
+
+```ruby
+class HogeController < ApplicationController
+  def fuga(piyo)
+    render :text => piyo
+  end
+end
+```
+
+Hitting "/hoge/fuga?piyo=foo" will call fuga('foo') and output 'foo'.
+So, you do never need to touch the ugly `params` Hash in order to fetch the request parameters.
+
+
+## StrongParameters
+
+ActionArgs plays very nice with Rails 4 StrongParameters.
+
+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.
+
+```ruby
+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 their default values.
+Again, it just acts in the same way as usual Ruby methods do.
+
+```ruby
+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.
+
+```ruby
+class UsersController < ApplicationController
+  def create(user)
+    @user = User.new(user.permit(:name, :age))
+    ...
+  end
+end
+```
+
+Moreover, ActionArgs provides declarative `permits` method for controller classes,
+so that you can DRY up your `permit` calls in the most comprehensible way.
+The `permits` method assumes the model class from the controller name, and
+`permit`s the action arguments containing attributes for that model.
+
+```ruby
+class UsersController < ApplicationController
+  # white-lists User model's attributes
+  permits :name, :age
+
+  # the given `user` parameter would be automatically permitted by ActionArgs
+  def create(user)
+    @user = User.new(user)
+  end
+end
+```
+
+
+## The Scaffold Generator
+
+ActionArgs provides a custom scaffold controller generator that overwrites the default scaffold generator.
+Thus, by hitting the scaffold generator command like this:
+
+```sh
+% rails g scaffold user name age:integer email
+```
+
+The following beautiful controller code will be generated:
+
+```ruby
+# coding: utf-8
+
+class UsersController < ApplicationController
+  permits :name, :age, :email
+
+  # GET /users
+  def index
+    @users = User.all
+  end
+
+  # GET /users/1
+  def show(id)
+    @user = User.find(id)
+  end
+
+  # GET /users/new
+  def new
+    @user = User.new
+  end
+
+  # GET /users/1/edit
+  def edit(id)
+    @user = User.find(id)
+  end
+
+  # POST /users
+  def create(user)
+    @user = User.new(user)
+
+    if @user.save
+      redirect_to @user, notice: 'User was successfully created.'
+    else
+      render action: 'new'
+    end
+  end
+
+  # PUT /users/1
+  def update(id, user)
+    @user = User.find(id)
+
+    if @user.update_attributes(user)
+      redirect_to @user, notice: 'User was successfully updated.'
+    else
+      render action: 'edit'
+    end
+  end
+
+  # DELETE /users/1
+  def destroy(id)
+    @user = User.find(id)
+    @user.destroy
+
+    redirect_to users_url
+  end
+end
+```
+
+You may notice that
+* There are no globalish `params` referrence
+* 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
+
+
+## Supported versions
+
+* Ruby 1.9.2, 1.9.3, 2.0.0 (trunk), JRuby & Rubinius with 1.9 mode
+
+* Rails 3.0.x, 3.1.x, 3.2.x, 4.0 (edge)
+
+
+## Installation
+
+Put this line in your Gemfile:
+```ruby
+gem 'action_args'
+```
+
+Then bundle:
+```sh
+% bundle
+```
+
+## Notes
+
+### Plain Old Action Methods
+
+Of courese 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.
+
+### Argument Naming Convention
+
+Each action method parameter name corresponds to `params` key name. For example, the following beautifully written nested show action works perfectly (this might not be a very good example of effective querying, but that's another story).
+
+```ruby
+Rails.application.routes.draw do
+  resources :authors do
+    resources :books
+  end
+end
+
+class BooksController < ApplicationController
+  # GET /authors/:author_id/books/:id
+  def show(author_id, id)
+    @book = Author.find(author_id).books.find(id)
+  end
+  ...
+end
+```
+
+
+## Copyright
+
+Copyright (c) 2011 Asakusa.rb. See MIT-LICENSE for further details.

data/action_args.gemspec

@@ -18,6 +18,4 @@ 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 'sqlite3', ['>= 0']
 end

data/gemfiles/rails_32.gemfile

@@ -4,3 +4,11 @@ gem 'rails', '>= 3.2.9'
 gem 'rspec-rails', '>= 2.0'
 
 gemspec :path => '../'
+
+platforms :ruby do
+  gem 'sqlite3'
+end
+
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+end

data/gemfiles/rails_40.gemfile

@@ -6,3 +6,11 @@ gem 'journey', github: 'rails/journey'
 gem 'rspec-rails', '>= 2.0'
 
 gemspec :path => '../'
+
+platforms :ruby do
+  gem 'sqlite3'
+end
+
+platforms :jruby do
+  gem 'activerecord-jdbcsqlite3-adapter'
+end

data/lib/action_args/abstract_controller.rb

@@ -1,12 +1,12 @@
 module AbstractController
   class Base
-    def send_action(method_name, *args)
-      return send method_name, *args unless args.blank?
+    if defined? ActionController::StrongParameters
+      def send_action(method_name, *args)
+        return send method_name, *args unless args.empty?
 
-      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 {|type, _| type == :block }.map do |type, key|
+        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
@@ -14,26 +14,32 @@ module AbstractController
             params[key]
           end
         end
-      else
-        method(method_name).parameters.reject {|type, _| type == :block }.map(&:last).map {|key| params[key]}
+        send method_name, *values
       end
-      send method_name, *values
-    end
 
-    # You can configure StrongParameters' `permit` attributes using this DSL method.
-    # The `permit` call will be invoked only against parameters having the resource
-    # model name inferred from the controller class name.
-    #
-    #   class UsersController < ApplicationController
-    #     permits :name, :age
-    #
-    #     def create(user)
-    #       @user = User.new(user)
-    #     end
-    #   end
-    #
-    def self.permits(*attributes)
-      @permitted_attributes = attributes
+      # You can configure StrongParameters' `permit` attributes using this DSL method.
+      # The `permit` call will be invoked only against parameters having the resource
+      # model name inferred from the controller class name.
+      #
+      #   class UsersController < ApplicationController
+      #     permits :name, :age
+      #
+      #     def create(user)
+      #       @user = User.new(user)
+      #     end
+      #   end
+      #
+      def self.permits(*attributes)
+        @permitted_attributes = attributes
+      end
+    # no StrongParameters
+    else
+      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]}
+        send method_name, *values
+      end
     end
   end
 end

data/lib/action_args/version.rb

@@ -1,3 +1,3 @@
 module ActionArgs
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_args
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-29 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2012-11-30 00:00:00.000000000 Z
+dependencies: []
 description: Rails plugin gem that supports Merbish style controller action arguments.
 email:
 - ronnie@dio.jp
@@ -38,7 +22,7 @@ files:
 - .travis.yml
 - Gemfile
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - action_args.gemspec
 - gemfiles/rails_32.gemfile

data/README.rdoc

@@ -1,193 +0,0 @@
-= ActionArgs
-
-Controller action arguments parameterizer for Rails 3+
-
-
-== What is this?
-
-ActionArgs is a Rails plugin that extends your controller action methods to look and act like simple general Ruby methods with meaningful parameters, or in short, Merbish.
-
-
-== The Controllers
-
-Having the following controller code:
-
-  class HogeController < ApplicationController
-    def fuga(piyo)
-      render :text => piyo
-    end
-  end
-
-Hitting "/hoge/fuga?piyo=foo" will call fuga('foo') and output 'foo'.
-So, you do never need to touch the ugly +params+ Hash in order to fetch the request parameters.
-
-
-== StrongParameters
-
-ActionArgs plays very nice with Rails 4 StrongParameters.
-
-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 their default 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)
-      @user = User.new(user.permit(:name, :age))
-      ...
-    end
-  end
-
-Moreover, ActionArgs provides declarative `permits` method for controller classes,
-so that you can DRY up your `permit` calls in the most comprehensible way.
-The `permits` method assumes the model class from the controller name, and
-`permit`s the action arguments containing attributes for that model.
-
-  class UsersController < ApplicationController
-    # white-lists User model's attributes
-    permits :name, :age
-
-    # the given `user` parameter would be automatically permitted by ActionArgs
-    def create(user)
-      @user = User.new(user)
-    end
-  end
-
-
-== The Scaffold Generator
-
-ActionArgs provides a custom scaffold controller generator that overwrites the default scaffold generator.
-Thus, by hitting the following command:
-
-  % rails g scaffold user name age:integer email
-
-The following beautiful controller code will be generated:
-
-  # coding: utf-8
-
-  class UsersController < ApplicationController
-    permits :name, :age, :email
-
-    # GET /users
-    def index
-      @users = User.all
-    end
-
-    # GET /users/1
-    def show(id)
-      @user = User.find(id)
-    end
-
-    # GET /users/new
-    def new
-      @user = User.new
-    end
-
-    # GET /users/1/edit
-    def edit(id)
-      @user = User.find(id)
-    end
-
-    # POST /users
-    def create(user)
-      @user = User.new(user)
-
-      if @user.save
-        redirect_to @user, notice: 'User was successfully created.'
-      else
-        render action: 'new'
-      end
-    end
-
-    # PUT /users/1
-    def update(id, user)
-      @user = User.find(id)
-
-      if @user.update_attributes(user)
-        redirect_to @user, notice: 'User was successfully updated.'
-      else
-        render action: 'edit'
-      end
-    end
-
-    # DELETE /users/1
-    def destroy(id)
-      @user = User.find(id)
-      @user.destroy
-
-      redirect_to users_url
-    end
-  end
-
-You may notice that
-* There are no globalish +params+ referrence
-* 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
-
-
-== Supported versions
-
-* Ruby 1.9.2, 1.9.3, 2.0.0 (trunk)
-
-* Rails 3.0.x, 3.1.x, 3.2.x, 4.0 (edge)
-
-
-== Installation
-
-Put this line in your Gemfile:
-  gem 'action_args'
-
-Then bundle:
-  % bundle
-
-
-== Notes
-
-=== Plain Old Action Methods
-
-Of courese 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.
-
-=== Argument Naming Convention
-
-Each action method parameter name corresponds to +params+ key name. For example, the following beautifully written nested show action works perfectly (this might not be a very good example of effective querying, but that's another story).
-
-  Rails.application.routes.draw do
-    resources :authors do
-      resources :books
-    end
-  end
-
-  class BooksController < ApplicationController
-    # GET /authors/:author_id/books/:id
-    def show(author_id, id)
-      @book = Author.find(author_id).books.find(id)
-    end
-    ...
-  end
-
-
-== Todo
-
-* other Ruby implementations
-
-
-== Copyright
-
-Copyright (c) 2011 Asakusa.rb. See MIT-LICENSE for further details.