action_parameter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa9cc72cb78003cacc9033f3fd23a76bdf326123
+  data.tar.gz: a718df9d730d24e5950ace918081cf65048a3798
+SHA512:
+  metadata.gz: dd62ba7e769620aa895c2d5942c3144be5395acc9785cdf25e8a014053f71edbe84bcf7117e2380758990b28740af78ac56faa8fb775262cdfbb6542538d9736
+  data.tar.gz: 9065aa9389ec2ab881ddfffe93cf20bab5a6c7510a46d024ac615275f19d9b2424c2a029c63aba07764c3dad2543333f33e86721b2822af6192626b46dce8bb2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle
+*.gem
+.bundle
+.idea
+Gemfile.lock
+log/*
+pkg/*
+.ruby-gemset
+.ruby-version

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'actionpack',     '~> 3.0.0'
+gem 'activesupport',  '~> 3.0.0'
+gem 'mocha',          '~> 0.13.2', require: false
+gem 'rake'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2009-2013 Ezequiel Delpero. http://github.com/edelpero
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,125 @@
+[![Code Climate](https://codeclimate.com/github/edelpero/action_parameter.png)](https://codeclimate.com/github/edelpero/action_parameter)
+
+ActionParameter
+===============
+
+ActionParameter helps you move all your parameter's logic into it's own class. This way you'll keep your controllers dry and they would be easier to test.
+
+Install
+-------
+
+ActionParameter works with Rails 3.0 onwards and Ruby 1.9. You can add it to your Gemfile with:
+
+```ruby
+gem 'action_parameter'
+```
+
+Run the bundle command to install it.
+
+Usage
+-----
+
+####Generator
+
+```ruby
+rails generate parameter [MODEL_NAME]
+```
+Will create **app/parameters/[model_name]_parameters.rb**.
+
+####Controller Helpers
+
+- **permitted_params:** Returns an ActionParameter instance.
+
+```ruby
+permitted_params(options={})
+```
+
+#####Options Hash
+
+ * **options**          - Hash with two valid keys **:class** and **:locals**.
+ * **options[:class]**  - Symbol value with the name of the Parameters class you want to use.
+ * **options[:locals]** - Hash used to create helper methods available for the ActionParameter instance.
+
+#####Example 1
+
+```ruby
+# app/controllers/people_controllers.rb
+class PeopleController < ActionController::Base
+  def create
+    Person.create(permitted_params.permit) # This will call to PersonParameters' permit method
+  end
+end
+```
+
+```ruby
+# app/parameters/person_parameters.rb
+class PersonParameters < ActionParameter::Base
+  def permit
+    params.require(:person).permit(:name, :age)
+  end
+end
+```
+
+#####Example 2
+
+```ruby
+# app/controllers/people_controllers.rb
+class PeopleController < ActionController::Base
+  def create
+    Person.create(permitted_params(class: :user).sign_up) # This will call to UserParameters' sign_up method
+  end
+end
+```
+
+```ruby
+# app/parameters/user_parameters.rb
+class UserParameters < ActionParameter::Base
+  def sign_up
+    params.require(:person).permit(:name, :age)
+  end
+end
+```
+
+####Parameter Helpers
+
+#####Default Helpers
+
+- **params:**          Returns params from the current controller request which instantiated the Parameter class.
+- **controller_name:** Returns the controller's name from which the Parameter class was instantiated.
+- **action_name:**     Returns the action's name from the controller from which the Parameter class was instantiated.
+
+#####Creating New Helpers
+
+If you want to create new helper methods for you parameters class, just pass a hash using **:locals**. Let say you want to make **@current_user** available for the UserParameter's class, then you'll need to use the **:locals** option to tell the UserParameters class to create a new helper that returns **@current_user**.
+
+```ruby
+permitted_params(class: :user, locals: { current_user:   @current_user,
+                                         another_helper: @value })
+```
+This will create **current_user** and **another_helper** methods and they will be available in UserParameters class.
+
+#####Example
+
+```ruby
+# app/controllers/people_controllers.rb
+class UsersController < ActionController::Base
+  def create
+    Person.create(permitted_params(locals: { current_user: @current_user }).sign_up)
+    # This will call to UserParameters' sign_up method and will also create a
+    # helper method named 'current_user' which will return @current_user
+  end
+end
+```
+
+```ruby
+# app/parameters/user_parameters.rb
+class UserParameters < ActionParameter::Base
+  def sign_up
+    if current_user # Method created using :locals option
+      params.permit!
+    else
+      params.require(:person).permit(:name, :age)
+    end
+  end
+end
+```

data/README.rdoc

@@ -0,0 +1,125 @@
+{<img src="https://codeclimate.com/github/edelpero/action_parameter.png" />}[https://codeclimate.com/github/edelpero/action_parameter]
+
+ActionParameter
+===============
+
+ActionParameter helps you move all your parameter's logic into it's own class. This way you'll keep your controllers dry and they would be easier to test.
+
+Install
+-------
+
+ActionParameter works with Rails 3.0 onwards and Ruby 1.9. You can add it to your Gemfile with:
+
+```ruby
+gem 'action_parameter'
+```
+
+Run the bundle command to install it.
+
+Usage
+-----
+
+####Generator
+
+```ruby
+rails generate parameter [MODEL_NAME]
+```
+Will create **app/parameters/[model_name]_parameters.rb**.
+
+####Controller Helpers
+
+- **permitted_params:** Returns an ActionParameter instance.
+
+```ruby
+permitted_params(options={})
+```
+
+#####Options Hash
+
+ * **options**          - Hash with two valid keys **:class** and **:locals**.
+ * **options[:class]**  - Symbol value with the name of the Parameters class you want to use.
+ * **options[:locals]** - Hash used to create helper methods available for the ActionParameter instance.
+
+#####Example 1
+
+```ruby
+# app/controllers/people_controllers.rb
+class PeopleController < ActionController::Base
+  def create
+    Person.create(permitted_params.permit) # This will call to PersonParameters' permit method
+  end
+end
+```
+
+```ruby
+# app/parameters/person_parameters.rb
+class PersonParameters < ActionParameter::Base
+  def permit
+    params.require(:person).permit(:name, :age)
+  end
+end
+```
+
+#####Example 2
+
+```ruby
+# app/controllers/people_controllers.rb
+class PeopleController < ActionController::Base
+  def create
+    Person.create(permitted_params(class: :user).sign_up) # This will call to UserParameters' sign_up method
+  end
+end
+```
+
+```ruby
+# app/parameters/user_parameters.rb
+class UserParameters < ActionParameter::Base
+  def sign_up
+    params.require(:person).permit(:name, :age)
+  end
+end
+```
+
+####Parameter Helpers
+
+#####Default Helpers
+
+- **params:**          Returns params from the current controller request which instantiated the Parameter class.
+- **controller_name:** Returns the controller's name from which the Parameter class was instantiated.
+- **action_name:**     Returns the action's name from the controller from which the Parameter class was instantiated.
+
+#####Creating New Helpers
+
+If you want to create new helper methods for you parameters class, just pass a hash using **:locals**. Let say you want to make **@current_user** available for the UserParameter's class, then you'll need to use the **:locals** option to tell the UserParameters class to create a new helper that returns **@current_user**.
+
+```ruby
+permitted_params(class: :user, locals: { current_user:   @current_user,
+                                         another_helper: @value })
+```
+This will create **current_user** and **another_helper** methods and they will be available in UserParameters class.
+
+#####Example
+
+```ruby
+# app/controllers/people_controllers.rb
+class UsersController < ActionController::Base
+  def create
+    Person.create(permitted_params(locals: { current_user: @current_user }).sign_up) 
+    # This will call to UserParameters' sign_up method and will also create a
+    # helper method named 'current_user' which will return @current_user
+  end
+end
+```
+
+```ruby
+# app/parameters/user_parameters.rb
+class UserParameters < ActionParameter::Base
+  def sign_up
+    if current_user # Method created using :locals option
+      params.permit!
+    else
+      params.require(:person).permit(:name, :age)
+    end
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+  require 'bundler/gem_tasks'
+rescue LoadError
+  raise 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActionParameter'
+  rdoc.options << '--line-numbers'
+  rdoc_main     = 'README.md'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs    << 'lib'
+  t.libs    << 'test'
+  t.pattern  = 'test/**/*_test.rb'
+  t.verbose  = false
+end
+
+task :default => :test

data/action_parameter.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "action_parameter/version"
+
+Gem::Specification.new do |s|
+  s.name          = "action_parameter"
+  s.version       = ActionParameter::VERSION.dup
+  s.platform      = Gem::Platform::RUBY
+  s.summary       = "Single Responsability Principle for Rails Controller's Parameters."
+  s.email         = "edelpero@gmail.com"
+  s.homepage      = "https://github.com/edelpero/action_parameter"
+  s.description   = "ActionParameter helps you move all your parameter's logic into it's own class. This way you'll keep your controllers dry and they would be easier to test."
+  s.authors       = ['Ezequiel Delpero']
+  s.license       = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency('activesupport', '>= 3.0.0', '< 4.1')
+  s.add_dependency('actionpack',    '>= 3.0.0', '< 4.1')
+end

data/lib/action_parameter.rb

@@ -0,0 +1,11 @@
+require 'action_pack'
+require 'active_support'
+require 'action_parameter/railtie' if defined?(Rails)
+
+module ActionParameter
+  extend ActiveSupport::Autoload
+
+  autoload :Base,    'action_parameter/base.rb'
+  autoload :Helpers, 'action_parameter/helpers.rb'
+
+end

data/lib/action_parameter/base.rb

@@ -0,0 +1,51 @@
+module ActionParameter
+  class Base
+
+    attr_accessor :params
+
+    # initialize: Initialize parameter class.
+    #
+    # == Options
+    #
+    # * <tt>params</tt> - The ActionController::Parameters instance from the controller who initialize this.
+    # * <tt>locals</tt> - Hash used to create helper methods available for the ActionParameter instance.
+    def initialize(params, locals = {})
+      @params = params
+      create_methods(locals)
+    end
+
+    protected
+
+      # create_methods: Creates instance methods using locals hash's keys and values, params[:controller] and params[:action].
+      #
+      # == Options
+      #
+      # * <tt>locals</tt> - Hash used to create helper methods available for the ActionParameter instance. Methods will be named using the hash keys and they'll return the hash values.
+      #
+      # == Examples
+      #
+      #     create_methods(current_user: @user, another_key: @another_variable)
+      #
+      #   Will create 'current_user', 'another_key', 'controller_name' and 'action_name' instance methods.
+      #   This methods will be aviable only in the current parameter class where create_method was called.
+      #   'current_user'    will return @user.
+      #   'another_key'     will return @another_variable
+      #   'controller_name' will return the controller instance's name
+      #   'action_name'     will return the controller action instance's name
+      def create_methods(locals = {})
+        locals = {} unless locals
+
+        locals.merge!(controller_name: params[:controller],
+                      action_name:     params[:action])
+
+        klass = class << self; self; end
+
+        locals.each do |method_name, value|
+          klass.send(:define_method, method_name) do
+            value
+          end
+        end
+      end
+
+  end
+end

data/lib/action_parameter/helpers.rb

@@ -0,0 +1,49 @@
+module ActionParameter
+  module Helpers
+
+    protected
+
+      # permitted_params: Returns an ActionParameter instance.
+      #
+      # == Options
+      #
+      # * <tt>options</tt>          - Hash with two valid keys: class and locals.
+      # * <tt>options[:class]</tt>  - Symbol value with the name of the Parameters class you want to use.
+      # * <tt>options[:locals]</tt> - Hash used to create helper methods available for the ActionParameter instance.
+      #
+      # == Examples
+      #
+      #     permitted_params(class: customer, locals: { current_user: @user }) # called from UsersController
+      #   
+      #   This will create an instance of CustomerParameters and also will make
+      #   'current_user', 'params', 'controller_name' and 'action_name' helper methods
+      #   available on the CustomerParameters instace.
+      def permitted_params(options = {})
+        parameter_class     = permitted_params_class(options[:class])
+        @permitted_params ||= parameter_class.new(params, options[:locals])
+      end
+
+      # permitted_params_class: Returns a Parameters class.
+      #
+      # == Options
+      #
+      # * <tt>options[:class]</tt> - Symbol value with the name of the Parameters class you want to use.
+      #
+      # == Examples
+      #
+      #     permitted_params_class(class: :customer)  # called from PeopleController
+      #     # => CustomerParameters 
+      #
+      #     permitted_params_class(class: :customers) # called from PeopleController
+      #     # => CustomersParameters
+      #
+      #     permitted_params_class()                  # called from PeopleController
+      #     # => PersonParameters
+      def permitted_params_class(class_name = nil)
+        class_name                = class_name || params[:controller].to_s.singularize
+        formatted_class_name      = class_name.to_s.camelcase
+        @permitted_params_class ||= "#{formatted_class_name}Parameters".constantize
+      end
+
+  end
+end

data/lib/action_parameter/railtie.rb

@@ -0,0 +1,13 @@
+require 'rails/railtie'
+
+module ActionParameter
+  class Railtie < Rails::Railtie
+
+    initializer "action_parameter.helpers" do |app|
+      ActiveSupport.on_load :action_controller do
+        include ActionParameter::Helpers
+      end
+    end
+
+  end
+end

data/lib/action_parameter/version.rb

@@ -0,0 +1,3 @@
+module ActionParameter
+  VERSION = "0.0.1".freeze
+end

data/lib/generators/parameter/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate parameter Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/parameter/parameter_generator.rb

@@ -0,0 +1,11 @@
+require 'rails/generators'
+require 'rails/generators/named_base'
+
+class ParameterGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  def parameter
+    template "parameter_class.rb", "app/parameters/#{name.underscore}_parameters.rb"
+  end
+
+end

data/lib/generators/parameter/templates/parameter_class.rb

@@ -0,0 +1,3 @@
+class <%= name.camelcase %>Parameters < ActionParameter::Base
+
+end

data/test/action_parameter_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+class UsersController < ApplicationController
+  include ActionParameter::Helpers
+
+  def permitted_params_without_arguments
+    permitted_params
+    render nothing: true
+  end
+
+  def permitted_params_with_class_attribute
+    permitted_params(class: :customer)
+    render nothing: true
+  end
+
+  def permitted_params_with_locals
+    permitted_params(locals: { current_user: 'user'})
+    render nothing: true
+  end
+
+end
+
+class UserParameters < ActionParameter::Base
+end
+
+class CustomerParameters < ActionParameter::Base
+end
+
+class ActionParameterTest < ActionController::TestCase
+  tests UsersController
+
+  def test_permitted_params_without_arguments_is_an_instance_of_user_parameters
+    get :permitted_params_without_arguments
+    assert_equal('UserParameters', assigns(:permitted_params).class.to_s)
+  end
+
+  def test_permitted_params_with_class_attribute_returns_an_instance_of_customer_parameters
+    get :permitted_params_with_class_attribute
+    assert_equal('CustomerParameters', assigns(:permitted_params).class.to_s)
+  end
+
+  def test_permitted_params_instance_params_helper_method
+    get :permitted_params_without_arguments
+    assert_equal(@request.params, assigns(:permitted_params).params)
+  end
+
+  def test_permitted_params_instance_controller_name_helper_method
+    get :permitted_params_without_arguments
+    assert_equal(@request.params['controller'], assigns(:permitted_params).controller_name)
+  end
+
+  def test_permitted_params_instance_action_name_helper_method
+    get :permitted_params_without_arguments
+    assert_equal(@request.params['action'], assigns(:permitted_params).action_name)
+  end
+
+  def test_permitted_params_with_locals_should_respond_to_current_user_method
+    get :permitted_params_with_locals
+    assert_equal(true, assigns(:permitted_params).respond_to?(:current_user))
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,30 @@
+require 'bundler'
+
+Bundler.setup
+require 'test/unit'
+require 'mocha/setup'
+
+# Configure Rails
+ENV["RAILS_ENV"] = "test"
+
+require 'active_support'
+require 'action_controller'
+require 'action_dispatch/middleware/flash'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'action_parameter'
+
+ActionParameter::Routes = ActionDispatch::Routing::RouteSet.new
+ActionParameter::Routes.draw do
+  get '/:controller(/:action(/:id))'
+end
+
+class ApplicationController < ActionController::Base
+  include ActionParameter::Routes.url_helpers
+end
+
+class ActiveSupport::TestCase
+  setup do
+    @routes = ActionParameter::Routes
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: action_parameter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ezequiel Delpero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
+description: ActionParameter helps you move all your parameter's logic into it's own
+  class. This way you'll keep your controllers dry and they would be easier to test.
+email: edelpero@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- README.rdoc
+- Rakefile
+- action_parameter.gemspec
+- lib/action_parameter.rb
+- lib/action_parameter/base.rb
+- lib/action_parameter/helpers.rb
+- lib/action_parameter/railtie.rb
+- lib/action_parameter/version.rb
+- lib/generators/parameter/USAGE
+- lib/generators/parameter/parameter_generator.rb
+- lib/generators/parameter/templates/parameter_class.rb
+- test/action_parameter_test.rb
+- test/test_helper.rb
+homepage: https://github.com/edelpero/action_parameter
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.3
+signing_key: 
+specification_version: 4
+summary: Single Responsability Principle for Rails Controller's Parameters.
+test_files:
+- test/action_parameter_test.rb
+- test/test_helper.rb