has_scope 0.4.2 → 0.5.0

data/README.rdoc

@@ -20,6 +20,7 @@ Now, if you want to apply them to an specific resource, you just need to call <t
   class GraduationsController < ApplicationController
     has_scope :featured, :type => :boolean
     has_scope :by_degree
+    has_scope :by_period, :using => [:started_at, :ended_at]
 
     def index
       @graduations = apply_scopes(Graduation).all
@@ -37,6 +38,9 @@ Then for each request:
   /graduations?featured=true&by_degree=phd
   #=> brings featured graduations with phd degree
 
+  /graduations?params[by_period][started_at]=20100701&params[by_period][ended_at]=20101013
+  #=> brings graduations in the given period
+
 You can retrieve all the scopes applied in one action with <tt>current_scopes</tt> method.
 In the last case, it would return: { :featured => true, :by_degree => "phd" }.
 
@@ -62,6 +66,8 @@ HasScope supports several options:
 
 * <tt>:as</tt> - The key in the params hash expected to find the scope. Defaults to the scope name.
 
+* <tt>:using</tt> - The subkeys to be used as args when type is a hash.
+
 * <tt>:if</tt> - Specifies a method, proc or string to call to determine if the scope should apply.
 
 * <tt>:unless</tt> - Specifies a method, proc or string to call to determine if the scope should NOT apply.

data/Rakefile

@@ -27,7 +27,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |s|
     s.name = "has_scope"
-    s.version = "0.4.2"
+    s.version = "0.5.0"
     s.summary = "Maps controller filters to your resource scopes"
     s.email = "contact@plataformatec.com.br"
     s.homepage = "http://github.com/plataformatec/has_scope"

data/lib/has_scope.rb

@@ -33,6 +33,9 @@ module HasScope
     # * <tt>:as</tt> - The key in the params hash expected to find the scope.
     #                  Defaults to the scope name.
     #
+    # * <tt>:using</tt> - If type is a hash, you can provide :using to convert the hash to
+    #                     a named scope call with several arguments.
+    #
     # * <tt>:if</tt> - Specifies a method, proc or string to call to determine
     #                  if the scope should apply
     #
@@ -61,7 +64,17 @@ module HasScope
     def has_scope(*scopes, &block)
       options = scopes.extract_options!
       options.symbolize_keys!
-      options.assert_valid_keys(:type, :only, :except, :if, :unless, :default, :as, :allow_blank)
+      options.assert_valid_keys(:type, :only, :except, :if, :unless, :default, :as, :using, :allow_blank)
+
+      if options.key?(:using)
+        if options.key?(:type) && options[:type] != :hash
+          raise "You cannot use :using with another :type different than :hash"
+        else
+          options[:type] = :hash
+        end
+
+        options[:using] = Array(options[:using])
+      end
 
       options[:only]   = Array(options[:only])
       options[:except] = Array(options[:except])
@@ -80,7 +93,7 @@ module HasScope
   # Receives an object where scopes will be applied to.
   #
   #   class GraduationsController < InheritedResources::Base
-  #     has_scope :featured, :boolean => true, :only => :index
+  #     has_scope :featured, :type => true, :only => :index
   #     has_scope :by_degree, :only => :index
   #
   #     def index
@@ -88,23 +101,25 @@ module HasScope
   #     end
   #   end
   #
-  def apply_scopes(target)
+  def apply_scopes(target, hash=params)
     return target unless scopes_configuration
 
     self.scopes_configuration.each do |scope, options|
       next unless apply_scope_to_action?(options)
       key = options[:as]
 
-      if params.key?(key)
-        value, call_scope = params[key], true
+      if hash.key?(key)
+        value, call_scope = hash[key], true
       elsif options.key?(:default)
         value, call_scope = options[:default], true
         value = value.call(self) if value.is_a?(Proc)
       end
 
+      value = parse_value(options[:type], key, value)
+
       if call_scope && (value.present? || options[:allow_blank])
-        set_current_scope(options[:type], key, value)
-        target = apply_scope_by_type(options[:type], scope, target, current_scopes[key], options[:block])
+        current_scopes[key] = value
+        target = call_scope_by_type(options[:type], scope, target, value, options)
       end
     end
 
@@ -112,24 +127,25 @@ module HasScope
   end
 
   # Set the real value for the current scope if type check.
-  def set_current_scope(type, key, value) #:nodoc:
+  def parse_value(type, key, value) #:nodoc:
     if type == :boolean
-      current_scopes[key] = TRUE_VALUES.include?(value)
-    elsif ALLOWED_TYPES[type].none?{ |klass| value.is_a?(klass) }
+      TRUE_VALUES.include?(value)
+    elsif value && ALLOWED_TYPES[type].none?{ |klass| value.is_a?(klass) }
       raise "Expected type :#{type} in params[:#{key}], got #{value.class}"
     else
-      current_scopes[key] = value
+      value
     end
   end
 
-  # Apply the scope taking into account its type.
-  def apply_scope_by_type(type, scope, target, value, block) #:nodoc:
+  # Call the scope taking into account its type.
+  def call_scope_by_type(type, scope, target, value, options) #:nodoc:
+    block = options[:block]
+
     if type == :boolean
-      if value
-        block ? block.call(self, target) : target.send(scope)
-      else
-        target
-      end
+      block ? block.call(self, target) : target.send(scope)
+    elsif value && options.key?(:using)
+      value = value.values_at(*options[:using])
+      block ? block.call(self, target, value) : target.send(scope, *value)
     else
       block ? block.call(self, target, value) : target.send(scope, value)
     end

data/test/has_scope_test.rb

@@ -10,6 +10,7 @@ class TreesController < ApplicationController
   has_scope :root_type, :as => :root, :allow_blank => true
   has_scope :calculate_height, :default => proc {|c| c.session[:height] || 20 }, :only => :new
   has_scope :paginate, :type => :hash
+  has_scope :args_paginate, :type => :hash, :using => [:page, :per_page]
   has_scope :categories, :type => :array
 
   has_scope :only_short, :type => :boolean do |controller, scope|
@@ -63,7 +64,7 @@ class HasScopeTest < ActionController::TestCase
     Tree.expects(:all).returns([mock_tree])
     get :index, :only_tall => 'false'
     assert_equal([mock_tree], assigns(:trees))
-    assert_equal({ :only_tall => false }, current_scopes)
+    assert_equal({}, current_scopes)
   end
 
   def test_scope_is_called_only_on_index
@@ -134,7 +135,7 @@ class HasScopeTest < ActionController::TestCase
   end
 
   def test_scope_of_type_hash
-    hash = { "page" => "1", "per_page" => "1" }
+    hash = { "page" => "1", "per_page" => "10" }
     Tree.expects(:paginate).with(hash).returns(Tree)
     Tree.expects(:all).returns([mock_tree])
     get :index, :paginate => hash
@@ -142,6 +143,15 @@ class HasScopeTest < ActionController::TestCase
     assert_equal({ :paginate => hash }, current_scopes)
   end
 
+  def test_scope_of_type_hash_with_using
+    hash = { "page" => "1", "per_page" => "10" }
+    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({ :args_paginate => hash }, current_scopes)
+  end
+
   def test_scope_of_type_array
     array = %w(book kitchen sport)
     Tree.expects(:categories).with(array).returns(Tree)

data/test/test_helper.rb

@@ -19,14 +19,21 @@ RAILS_ROOT = "anywhere"
 
 require 'active_support'
 require 'action_controller'
-require 'action_controller/test_case'
-require 'action_controller/test_process'
+require 'action_dispatch/middleware/flash'
 
 class ApplicationController < ActionController::Base; end
 
 $:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 require 'has_scope'
 
-ActionController::Routing::Routes.draw do |map|
+HasScope::Router = ActionDispatch::Routing::RouteSet.new
+HasScope::Router.draw do |map|
   map.connect ':controller/:action/:id'
-end
+  map.connect ':controller/:action'
+end
+
+class ActiveSupport::TestCase
+  setup do
+    @router = HasScope::Router
+  end
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: has_scope
 version: !ruby/object:Gem::Version 
-  version: 0.4.2
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - "Jos\xC3\xA9 Valim"
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-05 00:00:00 +01:00
+date: 2010-03-23 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -40,18 +45,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Maps controller filters to your resource scopes