cancan_strong_parameters 0.2.1 → 0.2.2

data/.gitignore

@@ -16,4 +16,5 @@ test/tmp
 test/version_tmp
 tmp
 .DS_Store
-log/
+log/
+test/log/

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7

data/README.md

@@ -1,14 +1,12 @@
 # CancanStrongParameters
 
-CanCan and [strong_parameters](https://github.com/rails/strong_parameters) are friends now!
+[CanCan](ryanb/cancan) and [strong_parameters](rails/strong_parameters) are friends now!
 
 [![Build Status](https://secure.travis-ci.org/colinyoung/cancan_strong_parameters.png)](http://travis-ci.org/colinyoung/cancan_strong_parameters)
 
 ## Authors
 
-The majority of this gem is credited to @mckeed, who posted this gist: https://gist.github.com/2878508
-I (@colinyoung) helped put some of it together.
-
+The majority of this gem is credited to @mckeed, who posted this gist: https://gist.github.com/2878508. I (@colinyoung) helped put some of it together.
 
 ## Installation
 
@@ -26,14 +24,40 @@ Or install it yourself as:
 
 ## Usage
 
-    1. Add it to your Gemfile
-    2. Wherever you use `load_and_authorize_resource`, also add:
-    
-        class PostsController < ApplicationController
-          ...
-          load_and_authorize_resource
-          permit_params post: [:name, :title, author: {:name}]
-        end
+1. Add `gem "cancan_strong_parameters"` to your Gemfile
+2. Wherever you use `load_and_authorize_resource`, also permit your parameters:
+
+   ```ruby
+   class PostsController < ApplicationController
+      ...
+      load_and_authorize_resource
+      
+      permit_params :body, tags: [:name]
+      # --> permit_params allows parameters but doesn't require them.
+      # In the preceding, :tags are a nested resource of post, while
+      # :body is an attribute of a Post.
+      #
+      # :tags is plural here because it's a has_many association, but
+      # you should use a singular key for a has_one.
+      
+      require_params :title
+      # --> require_params works exactly the same, but throws an error
+      # if the parameter isn't provided.
+      
+      # You can also require/permit params on create or update only:
+      permit_params_on_create ...
+      permit_params_on_update ...
+      require_params_on_create ...
+   end
+   ```
+3. Finally, don't forget to make the vars you use in your controllers
+   accessible in your models:
+   
+   ```ruby
+   class Post < ActiveRecord::Base
+      attr_accessible :title, :body, :tags_attributes
+   end
+   ```
         
 ## Testing
 
@@ -49,6 +73,7 @@ Run with `bundle exec rake test`.
 
 ## Changelog
 
+* Fixed docs to be compatible with 0.1.5.
 * Fixed some issues with nested form subfields in `permit_params`
 * Made compatible for nested forms
 * Added default allows for _destroy.

data/cancan_strong_parameters.gemspec

@@ -14,8 +14,8 @@ Gem::Specification.new do |gem|
   
   gem.add_development_dependency "require_all"
   gem.add_development_dependency "minitest", "~> 3.0"
+  gem.add_development_dependency "minitest_tu_shim"
   gem.add_development_dependency "rails"
-  gem.add_development_dependency "debugger"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/cancan_strong_parameters.rb

@@ -1,4 +1,4 @@
-require "active_support/hash_with_indifferent_access"
+require "cancan_strong_parameters/ruby/hash"
 require "cancan_strong_parameters/version"
 require "cancan_strong_parameters/controller"
 require "cancan_strong_parameters/deep_permit"

data/lib/cancan_strong_parameters/controller.rb

@@ -1,7 +1,7 @@
 module CancanStrongParameters
   module Controller
     
-    HASH_DEFAULTS = [:id, :_destroy, :_delete]
+    HASH_DEFAULTS = ['id', '_destroy', '_delete']
     
     module ClassMethods
       # Use this with CanCan's load_resource to permit a set of params before
@@ -72,11 +72,24 @@ module CancanStrongParameters
         if (hash.present? && keys.present?) || (hash.select{|k,v| v.is_a?(Array)} == hash)
           
           defaults = CancanStrongParameters::Controller::HASH_DEFAULTS
-          hash = hash.attributized
+          
+          # @todo We have to stringify everything for 1.8.7 due to a bug in `strong_parameters`.
+          # More at https://github.com/rails/strong_parameters/pull/51
+          hash = hash.attributized.stringified
           
           prepend_before_filter :only => actions do
             resource_name = self.class.resource_name
-            self.params[resource_name] = params[resource_name].standardized.send method, *[*keys.flatten + defaults, hash]
+            
+            # @todo We have to stringify everything for 1.8.7 due to a bug in `strong_parameters`.
+            # More at https://github.com/rails/strong_parameters/pull/51
+            parameters = keys.flatten.map! {|k| k.to_s } + defaults
+            parameters << ActionController::Parameters.new(hash)
+            
+            # original: parameters = keys.flatten + defaults
+            #           parameters << hash
+            return warn("Not updating - no parameters key present for #{resource_name}") unless params[resource_name]
+            
+            self.params[resource_name] = params[resource_name].standardized.send method, *parameters
           end
         elsif hash.present?
           prepend_before_filter :only => actions do
@@ -86,9 +99,9 @@ module CancanStrongParameters
           prepend_before_filter :only => actions do
             resource_name = self.class.resource_name
             if params.has_key?(resource_name)
-              self.params[resource_name] = params[resource_name].send method, *keys
+              self.params[resource_name] = params[resource_name].send method, *keys.stringified
             else
-              self.params = params.send method, *keys
+              self.params = params.send method, *keys.stringified
             end
           end
         end
@@ -106,6 +119,12 @@ module CancanStrongParameters
     def self.included(base)
       base.extend(ClassMethods)
     end
+    
+    # Errors
+    def warn msg
+      return unless Rails and Rails.logger
+      Rails.logger.warn(msg)
+    end
 
   end
 end
@@ -184,4 +203,39 @@ class String
   def is_hex?
     !!(self =~ /^[0-9a-f]+$/)
   end
+end
+
+# @todo Can be remove when new version of `strong_parameters` (>=0.1.5) is released.
+class Hash
+  def stringified
+    Hash.new.tap do |h|
+      each do |key, value|
+        value = case value
+        when Symbol
+          value.to_s
+        when Hash
+          value.indifferent
+        when Array
+          value.stringified
+        end
+        h[key.to_s] = value
+      end
+    end
+  end
+end
+
+class Array
+  def stringified
+    Array.new.tap do |a|
+      each do |value|
+        value = if value.is_a? Hash
+          value.stringified.indifferent 
+        else
+          value.to_s
+        end
+        
+        a << value
+      end
+    end
+  end
 end

data/lib/cancan_strong_parameters/ruby/hash.rb

@@ -0,0 +1,8 @@
+require "active_support/hash_with_indifferent_access"
+
+class Hash
+  def indifferent
+    ActiveSupport::HashWithIndifferentAccess.new(self)
+  end
+  alias :indifferent_access :indifferent
+end

data/lib/cancan_strong_parameters/version.rb

@@ -1,3 +1,3 @@
 module CancanStrongParameters
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/test/app/controllers/posts_controller.rb

@@ -2,22 +2,23 @@ class PostsController < ActionController::Base
   include CancanStrongParameters::Controller
   
   permit_params :title, :content,
-    comments: [
-      :body, tags: [:name]
+    :comments => [
+      :body, 
+      { :tags => [ :name ] } # This is fugly, use 1.9!
     ]
     
   def create
     @post = Post.new(params[:post])
     @post_attributes = params[:post]
-    render json: @post
+    render :json => @post
   end
   
   def update
     @post = Post.find(params[:id])
     if @post.update_attributes(params[:post])
-      render json: @post
+      render :json => @post
     else
-      render json: { errors: @post.errors.full_messages }, status: :unprocessable_entity
+      render :json => { :errors => post.errors.full_messages }, :status => :unprocessable_entity
     end
   end
   

data/test/app/models/post.rb

@@ -12,7 +12,7 @@ class Post
   
   # Fake persistence
   def self.sample_post
-    new(title: "Sample post", body: "Sample body")
+    new(:title => "Sample post", :body => "Sample body")
   end
   
   def self.find(*args)

data/test/assertions/assert_same_content.rb

@@ -0,0 +1,60 @@
+module MiniTest::Expectations
+  def assert_same_content(item, other_item, verb=:assert)  
+    item.each do |attrs|
+      value = attrs.last
+      key = attrs.first if attrs.length > 1
+      
+      
+      other_value = other_item[key] if self.is_a?(Hash)
+      
+      if other_value.present?
+        if value.respond_to? :same_as?
+          send verb, value.same_as?(other_value), "#{value} was not same as #{other_value}."
+        else
+          send "#{verb}_equal", value, other_value
+        end
+      else
+        send verb, item.same_as?(other_item), "#{item} was not the same as #{other_item}."
+      end
+    end
+  end
+  
+  def refute_same_content(item, other_item)
+    assert_same_content(item, other_item, :refute)
+  end
+end
+
+class Array
+  def same_as?(other_ary)
+    cpy = dup
+    other_cpy = other_ary.dup
+    each do |item|
+      case item
+      when Array, Hash
+        cpy.delete(item) if other_ary.any? { |other_item| other_item.same_as?(item) && other_cpy.delete(other_item) }
+      else
+        cpy.delete(item) if other_ary.include?(item) && other_cpy.delete(item)
+      end
+    end
+    
+    cpy.empty? and other_cpy.empty?
+  end
+end
+
+class Hash
+  def same_as?(other_hsh)
+    return false unless self.keys.count == other_hsh.keys.count
+    each do |key, value|
+      return false unless other_hsh.has_key? key
+      
+      other_value = other_hsh[key]
+      if value.respond_to? :same_as?
+        return false unless value.same_as? other_value
+      else
+        return false unless value == other_value
+      end
+    end
+    
+    true
+  end
+end

data/test/config.ru

@@ -1 +1 @@
-# Empty to make tests work
+# Empty to make tests work 

data/test/functional/posts_controller_test.rb

@@ -1,101 +1,97 @@
 require 'test_helper'
 
 class PostsControllerTest < ActionController::TestCase
+  
   test "should not clip off deep params" do
     params = {
-      post: {
-        title: "Title of post",
-        content: "Post main content.",
-        comments_attributes: [{
-          body: "My comment.",
-          tags_attributes: [{
-            name: "article"
+      :post => {
+        :title => "Title of post",
+        :content => "Post main content.",
+        :comments_attributes => [{
+          :body => "My comment.",
+          :tags_attributes => [{
+            :name => "article"
           }]
         }]
       }
     }
     
     post :create, params
-    assert_equal \
-      ActiveSupport::HashWithIndifferentAccess.new(assigns(:post_attributes)),
-      ActiveSupport::HashWithIndifferentAccess.new(params[:post])
+    assigns(:post_attributes).indifferent.must_have_same_content_as params[:post].indifferent
   end
   
   test "keeps _destroy keys" do  
     params = {
-      post: {
-        _destroy: true
+      :post => {
+        :_destroy => true
       }
     }
     
     post :create, params
-    assert_equal \
-      ActiveSupport::HashWithIndifferentAccess.new(assigns(:post_attributes)),
-      ActiveSupport::HashWithIndifferentAccess.new(params[:post])
+    assigns(:post_attributes).indifferent.must_have_same_content_as params[:post].indifferent
   end
   
   test "can handle multiple items" do
     params = {
-      post: {
-        title: "Hello",
-        comments_attributes: {
+      :post => {
+        :title => "Hello",
+        :comments_attributes => {
           "0" => {
-            body: "Comment 1",
-            tags_attributes: {
+            :body => "Comment 1",
+            :tags_attributes => {
               "0" => {
-                name: "article"
+                :name => "article"
               },
               "1" => {
-                name: "post"
+                :name => "post"
               },
             }
           },
           "1" => {
-            body: "Comment 2"
+            :body => "Comment 2"
           },
           "new_3904949" => {
-            body: "Comment 3"
+            :body => "Comment 3"
           }
         }
       }
     }
     
     post :create, params
-    assert_equal \
-      ActiveSupport::HashWithIndifferentAccess.new(assigns(:post_attributes)),
-      ActiveSupport::HashWithIndifferentAccess.new({
-        title: "Hello",
-        comments_attributes: [
-          {
-            body: "Comment 1",
-            tags_attributes: [{
-                name: "article"
-              },
-              {
-                name: "post"
-              }
-            ]
-          },
-          {
-            body: "Comment 2"
-          },
-          {
-            body: "Comment 3"
-          }
-        ]
-      })
+    expected = {
+      :title => "Hello",
+      :comments_attributes => [
+        {
+          :body => "Comment 1",
+          :tags_attributes => [{
+              :name => "post"
+            },
+            {
+              :name => "article"
+            }
+          ]
+        },
+        {
+          :body => "Comment 2"
+        },
+        {
+          :body => "Comment 3"
+        }
+      ]
+    }
+    assigns(:post_attributes).must_have_same_content_as expected.indifferent
   end
   
-  test "can handle multiple items but with only new itesm" do
+  test "can handle multiple items but with only new items" do
     params = {
-      post: {
-        title: "Hello",
-        comments_attributes: {
+      :post => {
+        :title => "Hello",
+        :comments_attributes => {
           "new_3904949" => {
-            body: "Comment 3",
-            tags_attributes: {
+            :body => "Comment 3",
+            :tags_attributes => {
               "new_23040234" => {
-                name: "article"
+                :name => "article"
               }
             }
           }
@@ -104,16 +100,15 @@ class PostsControllerTest < ActionController::TestCase
     }
     
     post :create, params
-    assert_equal \
-      ActiveSupport::HashWithIndifferentAccess.new(assigns(:post_attributes)),
-      ActiveSupport::HashWithIndifferentAccess.new({
-        title: "Hello",
-        comments_attributes: [{
-          body: "Comment 3",
-          tags_attributes: [{
-              name: "article"
-          }]
+    expected = {
+      :title => "Hello",
+      :comments_attributes => [{
+        :body => "Comment 3",
+        :tags_attributes => [{
+            :name => "article"
         }]
-      })
+      }]
+    }
+    assigns(:post_attributes).indifferent.must_have_same_content_as expected.indifferent
   end
 end

data/test/functional/title_controller_test.rb

@@ -6,9 +6,9 @@ class TitleControllerTest < ActionController::TestCase
     
     new_title = 'Changed title'
     put :update, 
-      id: 1,
-      post: {
-        title: new_title
+      :id => 1,
+      :post => {
+        :title => new_title
       }
     
     assert_equal assigns[:post].title, new_title

data/test/rails_helper.rb

@@ -5,8 +5,6 @@ ENV["RAILS_ENV"] ||= 'test'
 
 require 'rubygems'
 
-require 'debugger'
-
 gem 'actionpack', '>= 3.0.0'
 gem 'activesupport', '>= 3.0.0'
 gem 'activemodel', '>= 3.0.0'
@@ -35,5 +33,5 @@ Config::Application.initialize!
 Config::Application.routes.draw do
   resources :posts
   
-  match 'title/:id', to: 'title#update', via: :put
+  match 'title/:id', :to => 'title#update', :via => :put
 end

data/test/test_helper.rb

@@ -8,3 +8,11 @@ require 'cancan_strong_parameters'
 ## Boot up an instance of rails
 require 'rails_helper'
 require 'rails/test_help'
+
+## Custom matchers
+require 'assertions/assert_same_content'
+
+module MiniTest::Expectations
+  infect_an_assertion :assert_same_content, :must_have_same_content_as
+  infect_an_assertion :refute_same_content, :wont_have_same_content_as
+end

data/test/unit/assert_same_content_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+class SameContentTest < Test::Unit::TestCase
+
+  def test_same_content_works
+    ['a', 'b', 'c'].must_have_same_content_as ['b', 'a', 'c']
+    ['a', 'b', 'c'].wont_have_same_content_as ['b', 'a', 'c', 'd']
+    
+    dog1 = {
+      :breed => "Husky/Lab Mix",
+      :name => "Rue",
+      :tricks => {
+        :not_jumping_up => false, # :( Workin on it!
+        :sitting => true,
+        :coming_when_called => true,
+        :other => [
+          {
+            :name => "trick1",
+            :value => false
+          },
+          {
+            :name => "trick2",
+            :value => true
+          }
+        ]
+      }
+    }
+    
+    dog2 = dog1.dup
+    dog2[:tricks][:other].reverse!
+    dog1.must_have_same_content_as dog2
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cancan_strong_parameters
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-24 00:00:00.000000000 Z
+date: 2012-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cancan
@@ -92,7 +92,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: minitest_tu_shim
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -108,7 +108,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: debugger
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -131,6 +131,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -140,16 +141,19 @@ files:
 - lib/cancan_strong_parameters/controller.rb
 - lib/cancan_strong_parameters/deep_permit.rb
 - lib/cancan_strong_parameters/rails/controller/base.rb
+- lib/cancan_strong_parameters/ruby/hash.rb
 - lib/cancan_strong_parameters/version.rb
 - test/app/controllers/posts_controller.rb
 - test/app/controllers/title_controller.rb
 - test/app/models/post.rb
+- test/assertions/assert_same_content.rb
 - test/config.ru
 - test/functional/posts_controller_test.rb
 - test/functional/title_controller_test.rb
 - test/rails_helper.rb
 - test/script/rails
 - test/test_helper.rb
+- test/unit/assert_same_content_test.rb
 homepage: https://github.com/colinyoung/cancan_strong_parameters
 licenses: []
 post_install_message: 
@@ -178,9 +182,11 @@ test_files:
 - test/app/controllers/posts_controller.rb
 - test/app/controllers/title_controller.rb
 - test/app/models/post.rb
+- test/assertions/assert_same_content.rb
 - test/config.ru
 - test/functional/posts_controller_test.rb
 - test/functional/title_controller_test.rb
 - test/rails_helper.rb
 - test/script/rails
 - test/test_helper.rb
+- test/unit/assert_same_content_test.rb