strong-permitter 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d361eadf47f42ec59835011692c35d0f6ff37e51
-  data.tar.gz: 21c700f22385a2846e944ce81d5f3df53dac972c
+  metadata.gz: 8f4c40942316855614f9f688b714a50f2969e7c4
+  data.tar.gz: 74828bdbc10f2417d20e29292dcf71bf0112332e
 SHA512:
-  metadata.gz: 33d48ac7dac654ec570b27d0f5db88b831f67a23a2fde10a98dc6f294eacc961d17a8ea32245f7ec0264baa9e2f1ed5ad81d06414a649817b57385b1ab00fe83
-  data.tar.gz: 6b240d7a6a4285c710bc65e0fdcec4289e46a4181ff13c590d30f909aab20dc7d89c97a5122656d10bbe1356ac85d8a521f3b191bb47ddb38ce30f31262f0312
+  metadata.gz: 7ecf50cf6cef3ccd88f85c507a5246f2375ffbe9bf75f53786cec68a5a31eaf900cc8ae3c7e0c0fbbd506786456aa14369ab003ae326c0279ec306e90b990eb5
+  data.tar.gz: 697d4b2dfc4958a1aa56361d4e190a49fb3ced63b3693d43c48c66a9cbd5d4c8f081891f75f984a02599179cd7870d9b1d9fb2f1ff232a50198624264a8d26eb

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.7
+  - 2.2.3

data/README.md

@@ -1,8 +1,9 @@
+[![Build Status](https://travis-ci.org/evg2108/strong-permitter.svg?branch=optional_resource_name_and_tests)](https://travis-ci.org/evg2108/strong-permitter)
 [![Gem Version](https://badge.fury.io/rb/strong-permitter.svg)](https://badge.fury.io/rb/strong-permitter)
 
 # StrongPermitter
 
-This gem allows move params permissions from controllers to separated permission-objects.
+This gem allows move params permissions from controllers to separated permission-objects. Used strong parameters whitelists.
 
 ## Installation
 
@@ -46,9 +47,22 @@ class ArticlesPermission < StrongPermitter::Permission::Base
     # for non-standard actions permissions use:
     # allowed_params_for :action_name, :param1, :param2, ...
     allowed_params_for :activate_article, :activation_status
+    
+    # also, you can set default resource name for this permission object (by default used controller name):
+    # self.resource_name = :blog
 end
 ```
 
+If you need use different resource names for different actions, you may set optional last argument `:resource` in `create_params`, `update_params` or `allowed_params_for` methods, like this:
+
+```Ruby
+class ArticlesPermission < StrongPermitter::Permission::Base
+    create_params :title, :description, :author_name, resource: :blog
+    update_params :title, :text, :blog_id, resource: :blog_post
+end
+```
+
+
 After that, you may use `permitted_params` method for your action methods:
 
 ```ruby

data/Rakefile

@@ -1,2 +1,7 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec

data/lib/strong_permitter/manager.rb

@@ -1,13 +1,15 @@
 module StrongPermitter
   module Manager
     def permitted_params
-      permission_class = "#{self.class.name.sub('Controller', '')}Permission".camelcase.safe_constantize
-      return nil unless permission_class
+      @permission_class ||= "#{self.class.name.sub('Controller', '')}Permission".camelcase.safe_constantize
+      return nil unless @permission_class
 
-      resource_name = permission_class.resource_name || controller_name.singularize
-      allowed_attributes = permission_class.actions[action_name]
+      action_hash = @permission_class.actions[action_name.to_sym]
 
-      params.require(resource_name).permit(allowed_attributes)
+      resource_name = action_hash[:resource] || @permission_class.resource_name || controller_name.singularize
+      allowed_params = action_hash[:permitted_params]
+
+      params.required(resource_name).permit(*allowed_params)
     end
   end
 end

data/lib/strong_permitter/permission/base.rb

@@ -3,19 +3,25 @@ module StrongPermitter
     class Base
       class << self
         def actions
-          @actions ||= HashWithIndifferentAccess.new { |hash,val| hash[val] = [] }
+          @actions ||= Hash.new { |hash,val| hash[val] = { permitted_params: [] } }
         end
 
-        def create_params(*param_names)
-          allowed_params_for :create, *param_names
+        def create_params(*param_names_and_options)
+          allowed_params_for :create, *param_names_and_options
         end
 
-        def update_params(*param_names)
-          allowed_params_for :update, *param_names
+        def update_params(*param_names_and_options)
+          allowed_params_for :update, *param_names_and_options
         end
 
-        def allowed_params_for(action_name, *param_names)
-          actions[action_name] = param_names
+        def allowed_params_for(action_name, *param_names_and_options)
+          options = extract_options!(param_names_and_options)
+          param_names = param_names_and_options
+
+          resource_name = get_resource_name(options)
+
+          actions[action_name][:permitted_params] = param_names
+          actions[action_name][:resource] = resource_name if resource_name
         end
 
         def resource_name=(name)
@@ -25,6 +31,23 @@ module StrongPermitter
         def resource_name
           @resource_name
         end
+
+        private
+
+        def extract_options!(param_names_and_options)
+          if param_names_and_options.last.is_a?(Hash)
+            if param_names_and_options.last[:resource]
+              options = param_names_and_options.last.keys.length == 1 ?
+                  param_names_and_options.pop :
+                  param_names_and_options.last.delete(:resource)
+            end
+          end
+          options || {}
+        end
+
+        def get_resource_name(options)
+          options.is_a?(Hash) && options[:resource]
+        end
       end
     end
   end

data/lib/strong_permitter/version.rb

@@ -1,3 +1,3 @@
 module StrongPermitter
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/lib/strong_permitter/manager_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+require 'action_controller'
+
+class TestController < ActionController::Base
+  include StrongPermitter::Manager
+
+  def create
+    self.action_name = :create
+    @allowed_params = permitted_params
+  end
+
+  def update
+    self.action_name = :update
+    @allowed_params = permitted_params
+  end
+
+  def test_action
+    self.action_name = :test_action
+    @allowed_params = permitted_params
+  end
+end
+
+class TestPermission < StrongPermitter::Permission::Base
+  create_params :arg1, :arg2, :arg5, :arg6
+  update_params :arg3, :arg4, resource: :another_resource
+end
+
+describe StrongPermitter::Manager do
+  subject { TestController.new }
+
+  describe '#permitted_params' do
+    before(:example) do
+      subject.params = ActionController::Parameters.new({ test: { arg1: 'arg1_val', arg2: 'arg2_val', other_arg: 'other_arg_val' }, another_resource: { arg3: 'arg3_val', arg4: 'arg4_val', other_arg: 'other_arg_val' }, another_resource2: { arg5: 'arg5_val', arg6: 'arg6_val', arg7: 'arg7_val'} })
+    end
+
+    context 'when :resource argument not set and resource_name not set' do
+      it 'calls params.require(controller_name.singularize).permit(*arguments_array)' do
+        subject.create
+        expect(subject.instance_variable_get(:@allowed_params)).to eq(HashWithIndifferentAccess.new({arg1: 'arg1_val', arg2: 'arg2_val'}))
+      end
+    end
+
+    context 'when :resource argument is set and resource_name not set' do
+      it 'calls params.require(<resource>).permit(*arguments_array)' do
+        subject.update
+        expect(subject.instance_variable_get(:@allowed_params)).to eq(HashWithIndifferentAccess.new({arg3: 'arg3_val', arg4: 'arg4_val'}))
+      end
+    end
+
+    context 'when resource_name is set' do
+      context 'and :resource argument not set' do
+        before(:example) do
+          TestPermission.resource_name = :another_resource2
+        end
+
+        it 'calls params.require(resource_name).permit(*arguments_array)' do
+          subject.create
+          expect(subject.instance_variable_get(:@allowed_params)).to eq(HashWithIndifferentAccess.new({arg5: 'arg5_val', arg6: 'arg6_val'}))
+        end
+      end
+
+      context 'and :resource argument is set' do
+        before(:example) do
+          TestPermission.resource_name = :another_resource2
+        end
+
+        it 'calls params.require(<resource>).permit(*arguments_array)' do
+          subject.update
+          expect(subject.instance_variable_get(:@allowed_params)).to eq(HashWithIndifferentAccess.new({arg3: 'arg3_val', arg4: 'arg4_val'}))
+        end
+      end
+    end
+  end
+end

data/spec/lib/strong_permitter/permission/base_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'active_support/hash_with_indifferent_access'
+
+describe StrongPermitter::Permission::Base do
+  subject { StrongPermitter::Permission::Base }
+
+  before(:example) do
+    subject.actions.keys.each { |key| subject.actions.delete(key) }
+  end
+
+  describe '.actions' do
+    context 'with not existed key' do
+      it 'returns hash with empty array for :permitted_params key' do
+        expect(subject.actions[:test][:permitted_params]).to eq([])
+      end
+    end
+  end
+
+  describe '.resource_name=' do
+    let(:test_val){ :test }
+
+    it 'assigns resource_name' do
+      subject.resource_name = test_val
+      expect(subject.resource_name).to eq(test_val)
+    end
+  end
+
+  describe '.create_params' do
+    let(:params) { [:arg1, :arg2, :arg3, resource: :test_resource] }
+    it 'calls allowed_params_for with :create in first param' do
+      is_expected.to receive(:allowed_params_for).with(:create, *params)
+      subject.create_params(*params)
+    end
+  end
+
+  describe '.update_params' do
+    let(:params) { [:arg1, :arg2, :arg3, resource: :test_resource] }
+    it 'calls allowed_params_for with :update in first param' do
+      is_expected.to receive(:allowed_params_for).with(:update, *params)
+      subject.update_params(*params)
+    end
+  end
+
+  describe '.allowed_params_for' do
+    let(:test_action_name) { :test_action }
+    let(:params) { [:arg1, :arg2, :arg3] }
+
+    context 'with :resource last argument' do
+      let(:resource_arg) { { resource: :test_resource } }
+
+      it 'assigns actions[<first argument>] with hash contains params in :permitted_params key and resource name in :resource key' do
+        subject.allowed_params_for test_action_name, *(params + [resource_arg])
+        expect(subject.actions[test_action_name]).to eq({ permitted_params: params, resource: resource_arg[:resource] })
+      end
+    end
+
+    context 'without :resource last argument' do
+      it 'assigns actions[<first argument>] with hash contains params in :permitted_params key' do
+        subject.allowed_params_for test_action_name, *params
+        expect(subject.actions[test_action_name]).to eq({ permitted_params: params })
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'strong-permitter'

data/strong-permitter.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
   spec.add_dependency 'actionpack', '~> 4.0'
   spec.add_dependency 'railties', '~> 4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strong-permitter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - evg2108
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-19 00:00:00.000000000 Z
+date: 2015-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +89,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -86,6 +101,9 @@ files:
 - lib/strong_permitter/permission/base.rb
 - lib/strong_permitter/templates/initializer.rb
 - lib/strong_permitter/version.rb
+- spec/lib/strong_permitter/manager_spec.rb
+- spec/lib/strong_permitter/permission/base_spec.rb
+- spec/spec_helper.rb
 - strong-permitter.gemspec
 homepage: https://github.com/evg2108/strong-permitter
 licenses:
@@ -111,4 +129,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: It allows move params permissions from controllers to separated permission-objects
-test_files: []
+test_files:
+- spec/lib/strong_permitter/manager_spec.rb
+- spec/lib/strong_permitter/permission/base_spec.rb
+- spec/spec_helper.rb