action_parameter 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa9cc72cb78003cacc9033f3fd23a76bdf326123
-  data.tar.gz: a718df9d730d24e5950ace918081cf65048a3798
+  metadata.gz: 20349d935998f29c2416ce507da7a788fe501219
+  data.tar.gz: d70fda5403bfee909f7f3af9fa19133d6b43b31d
 SHA512:
-  metadata.gz: dd62ba7e769620aa895c2d5942c3144be5395acc9785cdf25e8a014053f71edbe84bcf7117e2380758990b28740af78ac56faa8fb775262cdfbb6542538d9736
-  data.tar.gz: 9065aa9389ec2ab881ddfffe93cf20bab5a6c7510a46d024ac615275f19d9b2424c2a029c63aba07764c3dad2543333f33e86721b2822af6192626b46dce8bb2
+  metadata.gz: 00ea0e919832434b7d2d3954ad0ada4a5d2f91a3270716a8db0d5d19f9eb9fdb4a4e4eb11aded1193a9fcc9bc22930fee2ea3a6ef5706b3152ce545b099bda5c
+  data.tar.gz: 93165ee51a9168c294503f7e76fdc96a0ddc196ac4dd4fa198fb176957849b13ce6a27c0227c76b4fbec458271917aa738e72b9ca6f7514ac375d0804583d126

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: UyOEGDlk0CRMGA13fGDYwg96fLKh1hOXs

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+script: "bundle exec rake test"
+rvm:
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - Gemfile
+notifications:
+  email: false

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+### 0.0.2
+
+* enhancements
+  * Adds `locals` method to permitted_params to create helpers methods on ActionParameter
+
+* deprecations
+  * `permitted_params(locals: {})` in favor of `permitted_params.locals({})`
+  * `rails g parameter` rails' generator in favor of `rails g parameters`

data/Gemfile

@@ -5,4 +5,5 @@ gemspec
 gem 'actionpack',     '~> 3.0.0'
 gem 'activesupport',  '~> 3.0.0'
 gem 'mocha',          '~> 0.13.2', require: false
-gem 'rake'
+gem 'rake'
+gem 'coveralls',                   require: false

data/README.md

@@ -1,3 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/action_parameter.png)](http://badge.fury.io/rb/action_parameter)
+[![Build Status](https://travis-ci.org/edelpero/action_parameter.png?branch=master)](https://travis-ci.org/edelpero/action_parameter)
+[![Coverage Status](https://coveralls.io/repos/edelpero/action_parameter/badge.png)](https://coveralls.io/r/edelpero/action_parameter)
 [![Code Climate](https://codeclimate.com/github/edelpero/action_parameter.png)](https://codeclimate.com/github/edelpero/action_parameter)
 
 ActionParameter
@@ -5,10 +8,49 @@ 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.
 
+Before
+------
+
+```ruby
+# app/controllers/users_controllers.rb
+class UsersController < ActionController::Base
+  def create
+    User.create(user_params)
+  end
+
+  private
+    def user_params
+      params.require(:user).permit(:name, :age)
+    end
+end
+```
+
+After
+-----
+
+```ruby
+# app/controllers/users_controllers.rb
+class UsersController < ActionController::Base
+  def create
+    # It automatically deduces which Parameters class from Controller's name
+    User.create(permitted_params.permit)
+  end
+end
+```
+
+```ruby
+# app/parameters/user_parameters.rb
+class UserParameter < ActionParameter::Base
+  def permit
+    params.require(:user).permit(:name, :age)
+  end
+end
+```
+
 Install
 -------
 
-ActionParameter works with Rails 3.0 onwards and Ruby 1.9. You can add it to your Gemfile with:
+ActionParameter works with Rails 3.0 onwards and Ruby 1.9.3 onwards. You can add it to your Gemfile with:
 
 ```ruby
 gem 'action_parameter'
@@ -22,7 +64,7 @@ Usage
 ####Generator
 
 ```ruby
-rails generate parameter [MODEL_NAME]
+rails generate parameters [MODEL_NAME]
 ```
 Will create **app/parameters/[model_name]_parameters.rb**.
 
@@ -36,9 +78,8 @@ 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.
+ * **options**         - Hash with one valid key: **:class**.
+ * **options[:class]** - Symbol value with the name of the Parameters class you want to use.
 
 #####Example 1
 
@@ -80,7 +121,7 @@ class UserParameters < ActionParameter::Base
 end
 ```
 
-####Parameter Helpers
+####Parameter Class Helpers
 
 #####Default Helpers
 
@@ -90,11 +131,11 @@ end
 
 #####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**.
+If you want to create new helper methods for you parameters class, just call **:locals** over **permitted_params**. Let say you want to make **@current_user** available for the UserParameter's class, then you'll need to use the **:locals** method 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 })
+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.
 
@@ -104,21 +145,19 @@ This will create **current_user** and **another_helper** methods and they will b
 # 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
+    User.create(permitted_params.locals(current_user: @current_user).permit) # This will call to PersonParameters' permit method
   end
 end
 ```
 
 ```ruby
-# app/parameters/user_parameters.rb
+# app/parameters/person_parameters.rb
 class UserParameters < ActionParameter::Base
-  def sign_up
-    if current_user # Method created using :locals option
-      params.permit!
+  def permit
+    if user.admin?
+        params.require(:person).permit(:name, :age, :admin)
     else
-      params.require(:person).permit(:name, :age)
+        params.require(:person).permit(:name, :age)
     end
   end
 end

data/README.rdoc

@@ -1,3 +1,6 @@
+{<img src="https://badge.fury.io/rb/action_parameter.png" alt="Gem Version" />}[http://badge.fury.io/rb/action_parameter]
+{<img src="https://travis-ci.org/edelpero/action_parameter.png?branch=master" alt="Build Status" />}[https://travis-ci.org/edelpero/action_parameter]
+{<img src="https://coveralls.io/repos/edelpero/action_parameter/badge.png" alt="Coverage Status" />}[https://coveralls.io/r/edelpero/action_parameter]
 {<img src="https://codeclimate.com/github/edelpero/action_parameter.png" />}[https://codeclimate.com/github/edelpero/action_parameter]
 
 ActionParameter
@@ -5,10 +8,49 @@ 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.
 
+Before
+------
+
+```ruby
+# app/controllers/users_controllers.rb
+class UsersController < ActionController::Base
+  def create
+    User.create(user_params)
+  end
+
+  private
+    def user_params
+      params.require(:user).permit(:name, :age)
+    end
+end
+```
+
+After
+-----
+
+```ruby
+# app/controllers/users_controllers.rb
+class UsersController < ActionController::Base
+  def create
+    # It automatically deduces which Parameters class from Controller's name
+    User.create(permitted_params.permit)
+  end
+end
+```
+
+```ruby
+# app/parameters/user_parameters.rb
+class UserParameter < ActionParameter::Base
+  def permit
+    params.require(:user).permit(:name, :age)
+  end
+end
+```
+
 Install
 -------
 
-ActionParameter works with Rails 3.0 onwards and Ruby 1.9. You can add it to your Gemfile with:
+ActionParameter works with Rails 3.0 onwards and Ruby 1.9.3 onwards. You can add it to your Gemfile with:
 
 ```ruby
 gem 'action_parameter'
@@ -22,7 +64,7 @@ Usage
 ####Generator
 
 ```ruby
-rails generate parameter [MODEL_NAME]
+rails generate parameters [MODEL_NAME]
 ```
 Will create **app/parameters/[model_name]_parameters.rb**.
 
@@ -36,9 +78,8 @@ 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.
+ * **options**         - Hash with one valid key: **:class**.
+ * **options[:class]** - Symbol value with the name of the Parameters class you want to use.
 
 #####Example 1
 
@@ -80,7 +121,7 @@ class UserParameters < ActionParameter::Base
 end
 ```
 
-####Parameter Helpers
+####Parameter Class Helpers
 
 #####Default Helpers
 
@@ -90,11 +131,11 @@ end
 
 #####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**.
+If you want to create new helper methods for you parameters class, just call **:locals** over **permitted_params**. Let say you want to make **@current_user** available for the UserParameter's class, then you'll need to use the **:locals** method 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 })
+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.
 
@@ -104,21 +145,19 @@ This will create **current_user** and **another_helper** methods and they will b
 # 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
+    User.create(permitted_params.locals(current_user: @current_user).permit) # This will call to PersonParameters' permit method
   end
 end
 ```
 
 ```ruby
-# app/parameters/user_parameters.rb
+# app/parameters/person_parameters.rb
 class UserParameters < ActionParameter::Base
-  def sign_up
-    if current_user # Method created using :locals option
-      params.permit!
+  def permit
+    if user.admin?
+        params.require(:person).permit(:name, :age, :admin)
     else
-      params.require(:person).permit(:name, :age)
+        params.require(:person).permit(:name, :age)
     end
   end
 end

data/lib/action_parameter/base.rb

@@ -3,20 +3,43 @@ module ActionParameter
 
     attr_accessor :params
 
-    # initialize: Initialize parameter class.
+    # initialize: Initialize parameter class and creates controller_name and action_name helpers.
     #
     # == 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 = {})
+    def initialize(params)
       @params = params
+      create_base_helpers
+    end
+
+    # locals: Creates helper methods for the ActionParameter instace.
+    #
+    # == Options
+    #
+    # * <tt>locals</tt> - Hash used to create helper methods available for the ActionParameter instance.
+    #
+    # == Examples
+    #
+    # * locals(new_method: @value, another_method: @other_value)
+    #   # => 'ActionParameter instace'
+    #
+    # Returns the ActionParameter instace.
+    def locals(locals = {})
       create_methods(locals)
+      self
     end
 
     protected
 
-      # create_methods: Creates instance methods using locals hash's keys and values, params[:controller] and params[:action].
+      # create_base_helpers: Creates controller_name and action_name helper methods, every time an ActionParameter instace is created.
+      def create_base_helpers
+        locals = { controller_name: params[:controller],
+                   action_name:     params[:action] }
+        create_methods(locals)
+      end
+
+      # create_methods: Creates instance methods using locals hash's keys and values.
       #
       # == Options
       #
@@ -26,18 +49,13 @@ module ActionParameter
       #
       #     create_methods(current_user: @user, another_key: @another_variable)
       #
-      #   Will create 'current_user', 'another_key', 'controller_name' and 'action_name' instance methods.
+      #   Will create 'current_user' and 'another_key' 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|

data/lib/action_parameter/helpers.rb

@@ -7,37 +7,36 @@ module ActionParameter
       #
       # == Options
       #
-      # * <tt>options</tt>          - Hash with two valid keys: class and locals.
+      # * <tt>options</tt>          - Hash with one valid key: class.
       # * <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
-      #   
+      #     permitted_params(class: customer) # called from UsersController
+      #
       #   This will create an instance of CustomerParameters and also will make
-      #   'current_user', 'params', 'controller_name' and 'action_name' helper methods
+      #   '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])
+        @permitted_params ||= parameter_class.new(params)
       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.
+      # * <tt>class_name</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(:customer)  # called from PeopleController
+      #     # => CustomerParameters
       #
-      #     permitted_params_class(class: :customers) # called from PeopleController
-      #     # => CustomersParameters
+      #     permitted_params_class(:customers) # called from PeopleController
+      #     # => CustomerParameters
       #
-      #     permitted_params_class()                  # called from PeopleController
+      #     permitted_params_class()           # called from PeopleController
       #     # => PersonParameters
       def permitted_params_class(class_name = nil)
         class_name                = class_name || params[:controller].to_s.singularize

data/lib/action_parameter/version.rb

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

data/lib/generators/{parameter → parameters}/USAGE

@@ -2,7 +2,7 @@ Description:
     Explain the generator
 
 Example:
-    rails generate parameter Thing
+    rails generate parameters Thing
 
     This will create:
         what/will/it/create

data/lib/generators/{parameter/parameter_generator.rb → parameters/parameters_generator.rb}

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

data/test/action_parameter_test.rb

@@ -14,7 +14,7 @@ class UsersController < ApplicationController
   end
 
   def permitted_params_with_locals
-    permitted_params(locals: { current_user: 'user'})
+    permitted_params.locals(current_user: 'user')
     render nothing: true
   end
 

data/test/test_helper.rb

@@ -1,3 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
 require 'bundler'
 
 Bundler.setup

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_parameter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ezequiel Delpero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-08 00:00:00.000000000 Z
+date: 2013-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -57,7 +57,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .coveralls.yml
 - .gitignore
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -69,9 +72,9 @@ files:
 - 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
+- lib/generators/parameters/USAGE
+- lib/generators/parameters/parameters_generator.rb
+- lib/generators/parameters/templates/parameter_class.rb
 - test/action_parameter_test.rb
 - test/test_helper.rb
 homepage: https://github.com/edelpero/action_parameter