has_scope 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48513d85f54847d588aec0efc61f818a2ffebefe
-  data.tar.gz: 8c85796fc391a814bbb821f006934ded14bd820f
+  metadata.gz: 4a38c086c93545529f868febab3d09cf921f5722
+  data.tar.gz: c41ae283cf6b0f45698fee5d631030cdf0565acf
 SHA512:
-  metadata.gz: 9648a802b913abb6873ec394d14c3fe22404e788f1a984901439a3c5883351dc9b3223bdb67c4f443351db16e56b9502b3923c8e0c0770448893e5f4eb1c7350
-  data.tar.gz: 49c94cbb4ef1d0376078deb8ac6c81cbc61b1092e0440b36f53dc362240799bf503a8a91338c8b9a5a52425fa4cced774f9965e7c65d03c280eb37546ddc592e
+  metadata.gz: 0dd2ec790d7b8f8e322cd40bb5086f445b3bc0ae39dba21d9465741270adb99ebd89c0fd91a62a0f9c338e41cd2d0df2370c2e2d9d5587801d55acff15a42971
+  data.tar.gz: 1d377574c40939629bbd82116a14070777ed9df568792599a94749a048addd1218d7c0cd0be4543a402479884afcd2f408cfbee35156ffb72f5769285d24939c

data/README.md

@@ -4,7 +4,7 @@
 [![Build Status](https://api.travis-ci.org/plataformatec/has_scope.png?branch=master)](http://travis-ci.org/plataformatec/has_scope)
 [![Code Climate](https://codeclimate.com/github/plataformatec/has_scope.png)](https://codeclimate.com/github/plataformatec/has_scope)
 
-Has scope allows you to easily create controller filters based on your resources named scopes.
+Has scope allows you to map incoming controller parameters to named scopes in your resources.
 Imagine the following model called graduations:
 
 ```ruby
@@ -131,6 +131,20 @@ has_scope :not_voted_by_me, :type => :boolean do |controller, scope|
 end
 ```
 
+## Keyword arguments
+
+Scopes with keyword arguments need to be called in a block:
+
+```ruby
+# in the model
+scope :for_course, lambda { |course_id:| where(course_id: course_id) }
+
+# in the controller
+has_scope :for_course do |controller, scope, value|
+  scope.for_course(course_id: value)
+end
+```
+
 ## Apply scope on every request
 
 To apply scope on every request set default value and `allow_blank: true`:

data/lib/has_scope.rb

@@ -3,7 +3,7 @@ module HasScope
 
   ALLOWED_TYPES = {
     :array   => [[ Array ]],
-    :hash    => [[ Hash ]],
+    :hash    => [[Hash, ActionController::Parameters]],
     :boolean => [[ Object ], -> v { TRUE_VALUES.include?(v) }],
     :default => [[ String, Numeric ]],
   }
@@ -147,6 +147,8 @@ module HasScope
       value.select { |v| v.present? }
     when Hash
       value.select { |k, v| normalize_blanks(v).present? }.with_indifferent_access
+    when ActionController::Parameters
+      normalize_blanks(value.to_unsafe_h)
     else
       value
     end
@@ -201,5 +203,5 @@ end
 
 ActiveSupport.on_load :action_controller do
   include HasScope
-  helper_method :current_scopes
+  helper_method :current_scopes if respond_to?(:helper_method)
 end

data/lib/has_scope/version.rb

@@ -1,3 +1,3 @@
 module HasScope
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/test/has_scope_test.rb

@@ -38,6 +38,7 @@ class TreesController < ApplicationController
   def show
     @tree = apply_scopes(Tree).find(params[:id])
   end
+
   alias :edit :show
 
   protected
@@ -49,8 +50,15 @@ class TreesController < ApplicationController
       false
     end
 
-    def default_render
-      render :text => action_name
+    if ActionPack::VERSION::MAJOR == 5
+      def default_render
+        render body: action_name
+      end
+    else
+      # TODO: Remove this when we only support Rails 5.
+      def default_render
+        render text: action_name
+      end
     end
 end
 
@@ -70,7 +78,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:only_tall).with().returns(Tree).in_sequence
     Tree.expects(:all).returns([mock_tree]).in_sequence
     get :index, :only_tall => 'true'
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ :only_tall => true }, current_scopes)
   end
 
@@ -78,7 +86,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:only_tall).never
     Tree.expects(:all).returns([mock_tree])
     get :index, :only_tall => 'false'
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ }, current_scopes)
   end
 
@@ -86,7 +94,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:conifer).with(true).returns(Tree).in_sequence
     Tree.expects(:all).returns([mock_tree]).in_sequence
     get :index, :conifer => 'true'
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ :conifer => true }, current_scopes)
   end
 
@@ -94,7 +102,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:conifer).with(false).returns(Tree).in_sequence
     Tree.expects(:all).returns([mock_tree]).in_sequence
     get :index, :conifer => 'not_true'
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ :conifer => false }, current_scopes)
   end
 
@@ -102,7 +110,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:conifer).never
     Tree.expects(:all).returns([mock_tree])
     get :index
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ }, current_scopes)
   end
 
@@ -110,7 +118,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:only_tall).never
     Tree.expects(:find).with('42').returns(mock_tree)
     get :show, :only_tall => 'true', :id => '42'
-    assert_equal(mock_tree, assigns(:tree))
+    assert_equal(mock_tree, assigns(:@tree))
     assert_equal({ }, current_scopes)
   end
 
@@ -119,7 +127,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:only_tall).never
     Tree.expects(:all).returns([mock_tree])
     get :index, :only_tall => 'true'
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ }, current_scopes)
   end
 
@@ -128,7 +136,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:color).never
     Tree.expects(:all).returns([mock_tree])
     get :index, :color => 'blue'
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ }, current_scopes)
   end
 
@@ -136,7 +144,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:shadown_range).never
     Tree.expects(:all).returns([mock_tree])
     get :index, :shadown_range => 20
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ }, current_scopes)
   end
 
@@ -144,7 +152,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:color).with('blue').returns(Tree).in_sequence
     Tree.expects(:all).returns([mock_tree]).in_sequence
     get :index, :color => 'blue'
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ :color => 'blue' }, current_scopes)
   end
 
@@ -152,7 +160,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:color).never
     Tree.expects(:all).returns([mock_tree]).in_sequence
     get :index, :color => ''
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ }, current_scopes)
   end
 
@@ -160,7 +168,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:root_type).with('').returns(Tree)
     Tree.expects(:all).returns([mock_tree]).in_sequence
     get :index, :root => ''
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ :root => '' }, current_scopes)
   end
 
@@ -169,7 +177,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:color).with('blue').returns(Tree)
     Tree.expects(:all).returns([mock_tree])
     get :index, :color => 'blue', :only_tall => 'true'
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ :color => 'blue', :only_tall => true }, current_scopes)
   end
 
@@ -178,8 +186,8 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:paginate).with(hash).returns(Tree)
     Tree.expects(:all).returns([mock_tree])
     get :index, :paginate => hash
-    assert_equal([mock_tree], assigns(:trees))
-    assert_equal({ :paginate => hash }, current_scopes)
+    assert_equal([mock_tree], assigns(:@trees))
+    assert_equal({ paginate: hash }, current_scopes)
   end
 
   def test_scope_of_type_hash_with_using
@@ -187,7 +195,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:args_paginate).with("1", "10").returns(Tree)
     Tree.expects(:all).returns([mock_tree])
     get :index, :args_paginate => hash
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ :args_paginate => hash }, current_scopes)
   end
 
@@ -196,7 +204,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:paginate).never
     Tree.expects(:all).returns([mock_tree])
     get :index, :paginate => hash
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ }, current_scopes)
   end
 
@@ -205,7 +213,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:paginate).never
     Tree.expects(:all).returns([mock_tree])
     get :index, :paginate => hash
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ }, current_scopes)
   end
 
@@ -214,7 +222,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:paginate).never
     Tree.expects(:all).returns([mock_tree])
     get :index, :paginate => hash
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ }, current_scopes)
   end
 
@@ -223,7 +231,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:categories).with(array).returns(Tree)
     Tree.expects(:all).returns([mock_tree])
     get :index, :categories => array
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ :categories => array }, current_scopes)
   end
 
@@ -231,14 +239,14 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:categories).never
     Tree.expects(:all).returns([mock_tree])
     get :index, :categories => [""]
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ }, current_scopes)
   end
 
   def test_scope_of_invalid_type_silently_fails
     Tree.expects(:all).returns([mock_tree])
     get :index, :paginate => "1"
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ }, current_scopes)
   end
 
@@ -246,7 +254,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:shadown_range).with(10).returns(Tree).in_sequence
     Tree.expects(:find).with('42').returns(mock_tree).in_sequence
     get :edit, :id => '42'
-    assert_equal(mock_tree, assigns(:tree))
+    assert_equal(mock_tree, assigns(:@tree))
     assert_equal({ :shadown_range => 10 }, current_scopes)
   end
 
@@ -254,7 +262,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:shadown_range).with('20').returns(Tree).in_sequence
     Tree.expects(:find).with('42').returns(mock_tree).in_sequence
     get :edit, :id => '42', :shadown_range => '20'
-    assert_equal(mock_tree, assigns(:tree))
+    assert_equal(mock_tree, assigns(:@tree))
     assert_equal({ :shadown_range => '20' }, current_scopes)
   end
 
@@ -262,7 +270,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:root_type).with('outside').returns(Tree).in_sequence
     Tree.expects(:find).with('42').returns(mock_tree).in_sequence
     get :show, :id => '42', :root => 'outside'
-    assert_equal(mock_tree, assigns(:tree))
+    assert_equal(mock_tree, assigns(:@tree))
     assert_equal({ :root => 'outside' }, current_scopes)
   end
 
@@ -271,7 +279,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:planted_before).with("today").returns(Tree)
     Tree.expects(:all).returns([mock_tree])
     get :index
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ :planted_before => "today" }, current_scopes)
   end
 
@@ -280,7 +288,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:calculate_height).with(100).returns(Tree).in_sequence
     Tree.expects(:new).returns(mock_tree).in_sequence
     get :new
-    assert_equal(mock_tree, assigns(:tree))
+    assert_equal(mock_tree, assigns(:@tree))
     assert_equal({ :calculate_height => 100 }, current_scopes)
   end
 
@@ -289,7 +297,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:planted_after).with(parsed).returns(Tree)
     Tree.expects(:all).returns([mock_tree])
     get :index, :planted_after => "2014-11-11"
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ :planted_after => parsed }, current_scopes)
   end
 
@@ -297,7 +305,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:only_really_short!).with(@controller.object_id).returns(Tree)
     Tree.expects(:all).returns([mock_tree])
     get :index, :only_short => 'true'
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ :only_short => true }, current_scopes)
   end
 
@@ -305,7 +313,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:by_given_category).with(@controller.object_id, 'for_id').returns(Tree)
     Tree.expects(:all).returns([mock_tree])
     get :index, :by_category => 'for'
-    assert_equal([mock_tree], assigns(:trees))
+    assert_equal([mock_tree], assigns(:@trees))
     assert_equal({ :by_category => 'for' }, current_scopes)
   end
 
@@ -314,9 +322,9 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:title).with('the-title').returns(Tree)
     Tree.expects(:content).with('the-content').returns(Tree)
     Tree.expects(:all).returns([mock_tree])
-    get :index, :q => hash
-    assert_equal([mock_tree], assigns(:trees))
-    assert_equal({ :q => hash }, current_scopes)
+    get :index, q: hash
+    assert_equal([mock_tree], assigns(:@trees))
+    assert_equal({ q: hash }, current_scopes)
   end
 
   def test_overwritten_scope
@@ -326,6 +334,13 @@ class HasScopeTest < ActionController::TestCase
 
   protected
 
+    if ActionPack::VERSION::MAJOR == 5
+      # TODO: Remove this when we only support Rails 5.
+      def get(action, params = {})
+        super action, params: params
+      end
+    end
+
     def mock_tree(stubs={})
       @mock_tree ||= mock(stubs)
     end
@@ -333,6 +348,10 @@ class HasScopeTest < ActionController::TestCase
     def current_scopes
       @controller.send :current_scopes
     end
+
+    def assigns(ivar)
+      @controller.instance_variable_get(ivar)
+    end
 end
 
 class TreeHugger

data/test/test_helper.rb

@@ -8,6 +8,7 @@ require 'mocha/mini_test'
 ENV['RAILS_ENV'] = 'test'
 
 require 'active_support'
+require 'active_support/core_ext/string/strip'
 require 'action_controller'
 require 'action_dispatch/middleware/flash'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: has_scope
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - José Valim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-08 00:00:00.000000000 Z
+date: 2015-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,40 +16,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.1'
 description: Maps controller filters to your resource scopes
 email: opensource@plataformatec.com.br
 executables: []
@@ -76,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -91,4 +91,3 @@ summary: Maps controller filters to your resource scopes.
 test_files:
 - test/has_scope_test.rb
 - test/test_helper.rb
-has_rdoc: