action_args 0.0.3 → 1.0.0

data/.gitignore

@@ -1,4 +1,6 @@
 *.gem
 .bundle
 Gemfile.lock
+gemfiles/*.lock
 pkg/*
+log/*.log

data/.travis.yml

@@ -0,0 +1,15 @@
+script: "bundle exec rake spec"
+language: ruby
+rvm:
+  - 1.9.3
+  - ruby-head
+  - jruby-head
+  - rbx-19mode
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-19mode
+gemfile:
+  - gemfiles/rails_32.gemfile
+  - gemfiles/rails_40.gemfile

data/README.rdoc

@@ -1,11 +1,11 @@
 = ActionArgs
 
-Controller action arguments parameterizer for Rails 3 + Ruby 1.9
+Controller action arguments parameterizer for Rails 3+
 
 
 == What is this?
 
-ActionArgs is a Rails 3 plugin that extends your controller action methods to look and act like simple general Ruby methods with meaningful parameters, or in short, Merbish.
+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
@@ -19,12 +19,39 @@ Having the following controller code:
   end
 
 Hitting "/hoge/fuga?piyo=foo" will call fuga('foo') and output 'foo'.
-So, you do never need to touch the ugly +params+ Hash to get the request parameters.
+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.
+Hashes in the action method arguments simply responds to the `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
 
-To tell you the truth, Rails 3 is originally designed to be able to very easily add this functionality (because Carlhuda did the work on this), so perhaps the most characteristic feature of this plugin is the generator.
 ActionArgs provides a custom scaffold controller generator that overwrites the default scaffold generator.
 Thus, by hitting the following command:
 
@@ -35,6 +62,8 @@ 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
@@ -94,9 +123,9 @@ You may notice that
 
 == Supported versions
 
-* Ruby 1.9.2, 1.9.3 (trunk)
+* Ruby 1.9.2, 1.9.3, 2.0.0 (trunk)
 
-* Rails 3.0.x, 3.1 (edge)
+* Rails 3.0.x, 3.1.x, 3.2.x, 4.0 (edge)
 
 
 == Installation
@@ -135,15 +164,9 @@ Each action method parameter name corresponds to +params+ key name. For example,
 
 == Todo
 
-* specs
 * other Ruby implementations
 
 
-== Conclusion
-
-Ruby 1.9 on Rails 3 FTW!
-
-
 == Copyright
 
 Copyright (c) 2011 Asakusa.rb. See MIT-LICENSE for further details.

data/Rakefile

@@ -1,2 +1,29 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => 'spec:all'
+
+namespace :spec do
+  %w(rails_32 rails_40).each do |gemfile|
+    desc "Run Tests against #{gemfile}"
+    task gemfile do
+      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle --quiet"
+      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle exec rake -t spec"
+    end
+  end
+
+  desc 'Run Tests against all ORMs'
+  task :all do
+    %w(rails_32 rails_40).each do |gemfile|
+      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle --quiet"
+      sh "BUNDLE_GEMFILE='gemfiles/#{gemfile}.gemfile' bundle exec rake spec"
+    end
+  end
+end

data/action_args.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ['Akira Matsuda']
   s.email       = ['ronnie@dio.jp']
   s.homepage    = 'http://asakusa.rubyist.net/'
-  s.summary     = 'Controller action arguments parameterizer for Rails 3 + Ruby 1.9'
-  s.description = 'Rails 3 plugin gem that supports Merbish style controller action arguments.'
+  s.summary     = 'Controller action arguments parameterizer for Rails 3+ & Ruby 1.9+'
+  s.description = 'Rails plugin gem that supports Merbish style controller action arguments.'
 
   s.rubyforge_project = 'action_args'
 
@@ -18,4 +18,6 @@ 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

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'rails', '>= 3.2.9'
+gem 'rspec-rails', '>= 2.0'
+
+gemspec :path => '../'

data/gemfiles/rails_40.gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+gem 'rails', github: 'rails/rails'
+gem 'activerecord-deprecated_finders', github: 'rails/activerecord-deprecated_finders'
+gem 'journey', github: 'rails/journey'
+gem 'rspec-rails', '>= 2.0'
+
+gemspec :path => '../'

data/lib/action_args.rb

@@ -1,4 +1,8 @@
-require File.join(File.dirname(__FILE__), 'action_args/abstract_controller')
+require 'action_args/abstract_controller'
+begin
+  require 'strong_parameters'
+rescue LoadError
+end
 
 module ActionArgs
   class Railtie < ::Rails::Railtie

data/lib/action_args/abstract_controller.rb

@@ -3,8 +3,36 @@ module AbstractController
     def send_action(method_name, *args)
       return send method_name, *args unless args.blank?
 
-      values = method(method_name).parameters.map(&:last).map {|k| params[k]}
+      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)
+          else
+            params.require(k)
+          end
+        end
+      else
+        method(method_name).parameters.reject {|kind, _| kind == :block }.map(&:last).map {|k| params[k]}
+      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
+    end
   end
 end

data/lib/action_args/version.rb

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

data/lib/generators/rails/action_args_scaffold_controller_generator.rb

@@ -5,6 +5,7 @@ require 'rails/generators/rails/scaffold_controller/scaffold_controller_generato
 module Rails
   module Generators
     class ActionArgsScaffoldControllerGenerator < ::Rails::Generators::ScaffoldControllerGenerator
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
       source_root File.expand_path('../templates', __FILE__)
     end
   end

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

@@ -1,6 +1,10 @@
 # coding: utf-8
 
 class <%= controller_class_name %>Controller < ApplicationController
+<% if defined? ActionController::StrongParameters -%>
+  permits <%= attributes.map {|a| ":#{a.name}" }.join(', ') %>
+
+<% end -%>
   # GET <%= route_url %>
   def index
     @<%= plural_table_name %> = <%= orm_class.all(class_name) %>

data/spec/controllers/action_args_controller_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe BooksController do
+  describe 'GET show' do
+    let(:rhg) { Book.create! title: 'RHG' }
+    before { get :show, :id => rhg.id }
+    subject { assigns :book }
+    it { should == rhg }
+  end
+
+  describe 'POST create' do
+    let(:rhg) { Book.create! title: 'RHG' }
+    it { expect { post :create, :book => {title: 'AWDwR', price: 24} }.to change(Book, :count).by(1) }
+  end
+end

data/spec/controllers/ordinal_controller_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe AuthorsController do
+  describe 'GET show' do
+    let(:matz) { Author.create! name: 'Matz' }
+    it 'assigns the requested author as @author' do
+      get :show, :id => matz.id
+      assigns(:author).should eq(matz)
+    end
+  end
+end

data/spec/controllers/strong_parameters_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+if Rails::VERSION::MAJOR >= 4
+  describe StoresController do
+    describe 'GET show' do
+      let(:tatsu_zine) { Store.create! name: 'Tatsu-zine' }
+      before { get :show, :id => tatsu_zine.id }
+      subject { assigns :store }
+      it { should == tatsu_zine }
+    end
+
+    describe 'POST create' do
+      it { expect { post :create, :store => {name: 'Tatsu-zine', url: 'http://tatsu-zine.com'} }.to change(Store, :count).by(1) }
+    end
+  end
+end

data/spec/fake_app.rb

@@ -0,0 +1,76 @@
+# config
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+module ActionArgsTestApp
+  class Application < Rails::Application
+    config.secret_token = [*'A'..'z'].join
+    config.session_store :cookie_store, :key => '_myapp_session'
+    config.active_support.deprecation = :log
+    config.eager_load = false
+  end
+end
+ActionArgsTestApp::Application.initialize!
+
+# routes
+ActionArgsTestApp::Application.routes.draw do
+  resources :authors
+  resources :books
+  resources :stores
+end
+
+# models
+class Author < ActiveRecord::Base
+end
+class Book < ActiveRecord::Base
+end
+class Store < ActiveRecord::Base
+end
+
+# helpers
+module ApplicationHelper; end
+
+# controllers
+class ApplicationController < ActionController::Base
+end
+class AuthorsController < ApplicationController
+  def show
+    @author = Author.find params[:id]
+    render text: @author.name
+  end
+end
+class BooksController < ApplicationController
+  def show(id)
+    @book = Book.find(id)
+    render text: @book.title
+  end
+
+  def create(book)
+    book = book.permit :title, :price if Rails::VERSION::MAJOR >= 4
+    @book = Book.create! book
+    render text: @book.title
+  end
+end
+if Rails::VERSION::MAJOR >= 4
+  class StoresController < ApplicationController
+    permits :name, :url
+
+    def show(id)
+      @store = Store.find(id)
+      render text: @store.name
+    end
+
+    def create(store)
+      @store = Store.create! store
+      render text: @store.name
+    end
+  end
+end
+
+# migrations
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:authors) {|t| t.string :name}
+    create_table(:books) {|t| t.string :title; t.integer :price}
+    create_table(:stores) {|t| t.string :name; t.string :url}
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+# load Rails first
+require 'rails'
+require 'active_record'
+require 'action_controller/railtie'
+require 'action_args'
+require 'fake_app'
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.before :all do
+    CreateAllTables.up unless ActiveRecord::Base.connection.table_exists? 'authors'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: action_args
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,25 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-29 00:00:00.000000000 Z
-dependencies: []
-description: Rails 3 plugin gem that supports Merbish style controller action arguments.
+date: 2012-11-27 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'
+description: Rails plugin gem that supports Merbish style controller action arguments.
 email:
 - ronnie@dio.jp
 executables: []
@@ -19,11 +35,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
 - action_args.gemspec
+- gemfiles/rails_32.gemfile
+- gemfiles/rails_40.gemfile
 - lib/action_args.rb
 - lib/action_args/abstract_controller.rb
 - lib/action_args/version.rb
@@ -31,6 +50,11 @@ files:
 - 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/ordinal_controller_spec.rb
+- spec/controllers/strong_parameters_spec.rb
+- spec/fake_app.rb
+- spec/spec_helper.rb
 homepage: http://asakusa.rubyist.net/
 licenses: []
 post_install_message: 
@@ -51,8 +75,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: action_args
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Controller action arguments parameterizer for Rails 3 + Ruby 1.9
-test_files: []
+summary: Controller action arguments parameterizer for Rails 3+ & Ruby 1.9+
+test_files:
+- spec/controllers/action_args_controller_spec.rb
+- spec/controllers/ordinal_controller_spec.rb
+- spec/controllers/strong_parameters_spec.rb
+- spec/fake_app.rb
+- spec/spec_helper.rb