action_parameter 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20349d935998f29c2416ce507da7a788fe501219
-  data.tar.gz: d70fda5403bfee909f7f3af9fa19133d6b43b31d
+  metadata.gz: 6ca9c847488299c399725c330b52fdb3a7c42b86
+  data.tar.gz: 2acb6e8b30dd04005179ffbd9183a2a0f2e97460
 SHA512:
-  metadata.gz: 00ea0e919832434b7d2d3954ad0ada4a5d2f91a3270716a8db0d5d19f9eb9fdb4a4e4eb11aded1193a9fcc9bc22930fee2ea3a6ef5706b3152ce545b099bda5c
-  data.tar.gz: 93165ee51a9168c294503f7e76fdc96a0ddc196ac4dd4fa198fb176957849b13ce6a27c0227c76b4fbec458271917aa738e72b9ca6f7514ac375d0804583d126
+  metadata.gz: 1abbdd2cdb36f50236e0ba283965d17e7914ab32a2c270b57f3976db3b99f8e1d5371e0d1bd01a96a31aabc92dff651a3f4e22eb4ce6b8c530461d80880d24ed
+  data.tar.gz: 9cb63658d70cadbf52579739dddf864f6e69b935a8a05f0f8ab1586a85eafcaedcc98da40ce79664ef61d4597d003d684a5729d6b7682677a02395cf49a21f89

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.0.3
+
+* bug fixing
+  * Adds class namespacing support when guessing parameter class. Thanks to @poporul.
+
 ### 0.0.2
 
 * enhancements

data/Gemfile

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

data/README.md

@@ -2,6 +2,7 @@
 [![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)
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/edelpero/action_parameter/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
 
 ActionParameter
 ===============
@@ -40,7 +41,7 @@ end
 
 ```ruby
 # app/parameters/user_parameters.rb
-class UserParameter < ActionParameter::Base
+class UserParameters < ActionParameter::Base
   def permit
     params.require(:user).permit(:name, :age)
   end
@@ -131,27 +132,27 @@ end
 
 #####Creating New Helpers
 
-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**.
+If you want to create new helper methods for your parameters class, just call **locals** method over **permitted_params**. Let say you want to make **@current_user** available for the UserParameter's class under the **user** method, 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,
+permitted_params(class: :user).locals( user:           @current_user,
                                        another_helper: @value )
 ```
-This will create **current_user** and **another_helper** methods and they will be available in UserParameters class.
+This will create **user** and **another_helper** methods and they will be available in UserParameters class.
 
 #####Example
 
 ```ruby
-# app/controllers/people_controllers.rb
+# app/controllers/users_controllers.rb
 class UsersController < ActionController::Base
   def create
-    User.create(permitted_params.locals(current_user: @current_user).permit) # This will call to PersonParameters' permit method
+    User.create(permitted_params.locals(user: @current_user).permit) # This will call to UserParameters' permit method
   end
 end
 ```
 
 ```ruby
-# app/parameters/person_parameters.rb
+# app/parameters/user_parameters.rb
 class UserParameters < ActionParameter::Base
   def permit
     if user.admin?
@@ -161,4 +162,43 @@ class UserParameters < ActionParameter::Base
     end
   end
 end
-```
+```
+
+RSpec
+-----
+
+This example shows how to test using RSpec. 
+
+Theses tests require your **test.rb** configured to **config.action_controller.action_on_unpermitted_parameters = :raise**.
+
+```ruby
+# spec/parameters/user_parameters_spec.rb
+require "spec_helper"
+
+describe UserParameters do
+  describe ".permit" do
+    describe "when permitted parameters" do
+      it "returns the cleaned parameters" do
+        user_params = { first_name: "John", last_name: "Doe" }
+        params = ActionController::Parameters.new(user: user_params)
+
+        permitted_params = UserParameters.new(params).permit
+
+        expect(permitted_params).to eq user_params.with_indifferent_access
+      end
+    end
+
+    describe "when unpermitted parameters" do
+      it "raises error" do
+        user_params = { foo: "bar" }
+        params = ActionController::Parameters.new(user: user_params)
+
+        expect{ UserParameters.new(params).permit }.
+          to raise_error(ActionController::UnpermittedParameters)
+      end
+    end
+  end
+end
+
+```
+

data/action_parameter.gemspec

@@ -17,6 +17,8 @@ Gem::Specification.new do |s|
   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')
+  s.add_development_dependency('minitest', '~> 4.2')
+
+  s.add_dependency('activesupport', '>= 3.0.0')
+  s.add_dependency('actionpack',    '>= 3.0.0')
 end

data/lib/action_parameter/helpers.rb

@@ -34,14 +34,13 @@ module ActionParameter
       #     # => CustomerParameters
       #
       #     permitted_params_class(:customers) # called from PeopleController
-      #     # => CustomerParameters
+      #     # => 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
+        class_name = class_name || self.class.name.sub(/Controller$/, '').singularize
+        @permitted_params_class ||= "#{class_name.to_s.camelcase}Parameters".constantize
       end
 
   end

data/lib/action_parameter/version.rb

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

data/test/action_parameter_test.rb

@@ -1,8 +1,13 @@
 require 'test_helper'
 
-class UsersController < ApplicationController
-  include ActionParameter::Helpers
+UserParameters = Class.new(ActionParameter::Base)
+CustomerParameters = Class.new(ActionParameter::Base)
+
+Admin = Module.new
+Admin::UserParameters = Class.new(ActionParameter::Base)
+Admin::CustomerParameters = Class.new(ActionParameter::Base)
 
+module SharedActionMethods
   def permitted_params_without_arguments
     permitted_params
     render nothing: true
@@ -13,17 +18,25 @@ class UsersController < ApplicationController
     render nothing: true
   end
 
+  def permitted_params_with_namespaced_class_attribute
+    permitted_params(class: 'admin/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
+class Admin::UsersController < ApplicationController
+  include ActionParameter::Helpers
+  include SharedActionMethods
 end
 
-class CustomerParameters < ActionParameter::Base
+class UsersController < ApplicationController
+  include ActionParameter::Helpers
+  include SharedActionMethods
 end
 
 class ActionParameterTest < ActionController::TestCase
@@ -58,4 +71,23 @@ class ActionParameterTest < ActionController::TestCase
     get :permitted_params_with_locals
     assert_equal(true, assigns(:permitted_params).respond_to?(:current_user))
   end
-end
+end
+
+class ActionParameterNamespaceTest < ActionController::TestCase
+  tests Admin::UsersController
+
+  def test_permitted_params_without_arguments_is_an_instance_of_user_parameters
+    get :permitted_params_without_arguments
+    assert_equal('Admin::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_with_namespaced_class_attribute_returns_an_instance_of_customer_parameters
+    get :permitted_params_with_namespaced_class_attribute
+    assert_equal('Admin::CustomerParameters', assigns(:permitted_params).class.to_s)
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: action_parameter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ezequiel Delpero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-07 00:00:00.000000000 Z
+date: 2014-05-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -17,9 +31,6 @@ dependencies:
     - - '>='
       - !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
@@ -27,9 +38,6 @@ dependencies:
     - - '>='
       - !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
@@ -37,9 +45,6 @@ dependencies:
     - - '>='
       - !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
@@ -47,9 +52,6 @@ dependencies:
     - - '>='
       - !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
@@ -64,7 +66,6 @@ files:
 - Gemfile
 - MIT-LICENSE
 - README.md
-- README.rdoc
 - Rakefile
 - action_parameter.gemspec
 - lib/action_parameter.rb
@@ -97,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.3
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Single Responsability Principle for Rails Controller's Parameters.

data/README.rdoc

@@ -1,164 +0,0 @@
-{<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
-===============
-
-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.3 onwards. You can add it to your Gemfile with:
-
-```ruby
-gem 'action_parameter'
-```
-
-Run the bundle command to install it.
-
-Usage
------
-
-####Generator
-
-```ruby
-rails generate parameters [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 one valid key: **:class**.
- * **options[:class]** - Symbol value with the name of the Parameters class you want to use.
-
-#####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 Class 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 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 )
-```
-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
-    User.create(permitted_params.locals(current_user: @current_user).permit) # This will call to PersonParameters' permit method
-  end
-end
-```
-
-```ruby
-# app/parameters/person_parameters.rb
-class UserParameters < ActionParameter::Base
-  def permit
-    if user.admin?
-        params.require(:person).permit(:name, :age, :admin)
-    else
-        params.require(:person).permit(:name, :age)
-    end
-  end
-end
-```