has_scope 0.5.1 → 0.6.0.rc

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb5c20d9ff1cb1bbd626b15574b9159fd50dfa47
+  data.tar.gz: 783dd0bc45a0bf8d97a16c77bdee0f24a52c926a
+SHA512:
+  metadata.gz: 56bc3e1fc2043a227dd8bf18e34896e6b5c6d5693a61be1ef45b49f13cf035157a572efffdde6b3e95ef1f230cd498a8d044a004689635eb0367d7cdbf607efc
+  data.tar.gz: 9cd682408a65660d72646f32a9447ceca58d498af77fdc502ea7ad0f9c39ff2aaa3f5a3fcb0f907c75ec99f6c62e7af3837c762b70e5dd1836c0b902b3a5b643

data/.gitignore

@@ -1,2 +1,2 @@
 .bundle
-Gemfile.lock
+gemfiles/*.lock

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - Gemfile
+  - gemfiles/Gemfile-rails.3.2.x
+notifications:
+  email: false
+  campfire:
+    on_success: change
+    on_failure: always
+    rooms:
+      - secure: "kysymH2KAtGgNLcWPaNLVENtghORHJC6yUxGzJ5y+JrzUwkr4gTOv0nMyw5k\nsHCN1F1mJtbiXxFOZpxDaWMSGVhP7ThRy0esovkfzkAHihbyPClX241eJcyD\nI3f7/BZN4gfiR+Mbml2frLKHOtEtrm2h0gIEsXJ/YL+Ysf0nxHw="

data/Gemfile

@@ -1,13 +1,8 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec
 
-gem "rails", "~> 3.0.3"
-
-if RUBY_VERSION < "1.9"
-	gem "ruby-debug"
-else
-  gem "test-unit"
-end
-
-gem "mocha"
+gem 'actionpack', '~> 4.0.0.rc1'
+gem 'activesupport', '~> 4.0.0.rc1'
+gem 'mocha', '~> 0.13.2', require: false
+gem 'rake'

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    has_scope (0.6.0.rc)
+      actionpack (>= 3.2, < 5)
+      activesupport (>= 3.2, < 5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.0.0.rc1)
+      activesupport (= 4.0.0.rc1)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activesupport (4.0.0.rc1)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.9)
+    builder (3.1.4)
+    erubis (2.7.0)
+    i18n (0.6.4)
+    metaclass (0.0.1)
+    minitest (4.7.4)
+    mocha (0.13.3)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.3)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.0.4)
+    thread_safe (0.1.0)
+      atomic
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 4.0.0.rc1)
+  activesupport (~> 4.0.0.rc1)
+  has_scope!
+  mocha (~> 0.13.2)
+  rake

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2009 Plataforma Tecnologia. http://blog.plataformatec.com.br
+Copyright 2009-2013 Plataforma Tecnologia. http://blog.plataformatec.com.br
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,115 @@
+## HasScope
+
+[![Gem Version](https://fury-badge.herokuapp.com/rb/has_scope.png)](http://badge.fury.io/rb/has_scope)
+[![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.
+Imagine the following model called graduations:
+
+```ruby
+class Graduation < ActiveRecord::Base
+  scope :featured, -> { where(:featured => true) }
+  scope :by_degree, -> degree { where(:degree => degree) }
+end
+```
+
+You can use those named scopes as filters by declaring them on your controller:
+
+```ruby
+class GraduationsController < ApplicationController
+  has_scope :featured, :type => :boolean
+  has_scope :by_degree
+end
+```
+
+Now, if you want to apply them to an specific resource, you just need to call `apply_scopes`:
+
+```ruby
+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
+  end
+end
+```
+
+Then for each request:
+
+```
+/graduations
+#=> acts like a normal request
+
+/graduations?featured=true
+#=> calls the named scope and bring featured graduations
+
+/graduations?params[by_period][started_at]=20100701&params[by_period][ended_at]=20101013
+#=> brings graduations in the given period
+
+/graduations?featured=true&by_degree=phd
+#=> brings featured graduations with phd degree
+```
+
+You can retrieve all the scopes applied in one action with `current_scopes` method.
+In the last case, it would return: { :featured => true, :by_degree => "phd" }.
+
+## Installation
+
+Add `has_scope` to your Gemfile or install it from Rubygems.
+
+```ruby
+gem 'has_scope'
+```
+
+## Options
+
+HasScope supports several options:
+
+* `:type` - Checks the type of the parameter sent. If set to :boolean it just calls the named scope, without any argument. By default, it does not allow hashes or arrays to be given, except if type :hash or :array are set.
+
+* `:only` - In which actions the scope is applied.
+
+* `:except` - In which actions the scope is not applied.
+
+* `:as` - The key in the params hash expected to find the scope. Defaults to the scope name.
+
+* `:using` - The subkeys to be used as args when type is a hash.
+
+* `:if` - Specifies a method, proc or string to call to determine if the scope should apply.
+
+* `:unless` - Specifies a method, proc or string to call to determine if the scope should NOT apply.
+
+* `:default` - Default value for the scope. Whenever supplied the scope is always called.
+
+* `:allow_blank` - Blank values are not sent to scopes by default. Set to true to overwrite.
+
+## Block usage
+
+`has_scope` also accepts a block. The controller, current scope and value are yielded
+to the block so the user can apply the scope on its own. This is useful in case we
+need to manipulate the given value:
+
+```ruby
+has_scope :category do |controller, scope, value|
+  value != "all" ? scope.by_category(value) : scope
+end
+```
+
+When used with booleans, it just receives two arguments and is just invoked if true is given:
+
+```ruby
+has_scope :not_voted_by_me, :type => :boolean do |controller, scope|
+  scope.not_voted_by(controller.current_user.id)
+end
+```
+
+## Bugs and Feedback
+
+If you discover any bugs or want to drop a line, feel free to create an issue on GitHub.
+
+http://github.com/plataformatec/has_scope/issues
+
+MIT License. Copyright 2009-2013 Plataformatec. http://blog.plataformatec.com.br

data/Rakefile

@@ -1,5 +1,7 @@
 # encoding: UTF-8
-require 'rake'
+
+require 'bundler/gem_tasks'
+
 require 'rake/testtask'
 require 'rdoc/task'
 
@@ -19,6 +21,6 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'HasScope'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')
-end
+end

data/gemfiles/Gemfile-rails.3.2.x

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'has_scope', path: '..'
+
+gem 'actionpack', '~> 3.2.0'
+gem 'activesupport', '~> 3.2.0'
+gem 'mocha', '~> 0.13.2', require: false
+gem 'rake'

data/has_scope.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/plataformatec/has_scope"
   s.description = "Maps controller filters to your resource scopes"
   s.authors     = ['José Valim']
+  s.license     = 'MIT'
 
   s.rubyforge_project = "has_scope"
 
@@ -21,6 +22,9 @@ Gem::Specification.new do |s|
 
   s.rdoc_options = ["--charset=UTF-8"]
   s.extra_rdoc_files = [
-    "README.rdoc"
+    "README.md"
   ]
-end
+
+  s.add_runtime_dependency "actionpack", ">= 3.2", "< 5"
+  s.add_runtime_dependency "activesupport", ">= 3.2", "< 5"
+end

data/lib/has_scope.rb

@@ -11,7 +11,6 @@ module HasScope
   def self.included(base)
     base.class_eval do
       extend ClassMethods
-      helper_method :current_scopes
       class_attribute :scopes_configuration, :instance_writer => false
     end
   end
@@ -116,6 +115,7 @@ module HasScope
       end
 
       value = parse_value(options[:type], key, value)
+      value = normalize_blanks(value)
 
       if call_scope && (value.present? || options[:allow_blank])
         current_scopes[key] = value
@@ -130,8 +130,18 @@ module HasScope
   def parse_value(type, key, value) #:nodoc:
     if type == :boolean
       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}"
+    elsif value && ALLOWED_TYPES[type].any?{ |klass| value.is_a?(klass) }
+      value
+    end
+  end
+
+  # Screens pseudo-blank params.
+  def normalize_blanks(value) #:nodoc:
+    return value if value.nil?
+    if value.is_a?(Array)
+      value.select { |v| v.present? }
+    elsif value.is_a?(Hash)
+      value.select { |k, v| normalize_blanks(v).present? }.with_indifferent_access
     else
       value
     end
@@ -184,4 +194,7 @@ module HasScope
   end
 end
 
-ActionController::Base.send :include, HasScope
+ActiveSupport.on_load :action_controller do
+  include HasScope
+  helper_method :current_scopes
+end

data/lib/has_scope/version.rb

@@ -1,3 +1,3 @@
 module HasScope
-  VERSION = "0.5.1"
-end
+  VERSION = "0.6.0.rc"
+end

data/test/has_scope_test.rb

@@ -161,6 +161,33 @@ class HasScopeTest < ActionController::TestCase
     assert_equal({ :args_paginate => hash }, current_scopes)
   end
 
+  def test_hash_with_blank_values_is_ignored
+    hash = { "page" => "", "per_page" => "" }
+    Tree.expects(:paginate).never
+    Tree.expects(:all).returns([mock_tree])
+    get :index, :paginate => hash
+    assert_equal([mock_tree], assigns(:trees))
+    assert_equal({ }, current_scopes)
+  end
+
+  def test_nested_hash_with_blank_values_is_ignored
+    hash = { "parent" => {"children" => ""} }
+    Tree.expects(:paginate).never
+    Tree.expects(:all).returns([mock_tree])
+    get :index, :paginate => hash
+    assert_equal([mock_tree], assigns(:trees))
+    assert_equal({ }, current_scopes)
+  end
+
+  def test_nested_blank_array_param_is_ignored
+    hash = { "parent" => [""] }
+    Tree.expects(:paginate).never
+    Tree.expects(:all).returns([mock_tree])
+    get :index, :paginate => hash
+    assert_equal([mock_tree], assigns(:trees))
+    assert_equal({ }, current_scopes)
+  end
+
   def test_scope_of_type_array
     array = %w(book kitchen sport)
     Tree.expects(:categories).with(array).returns(Tree)
@@ -170,16 +197,19 @@ class HasScopeTest < ActionController::TestCase
     assert_equal({ :categories => array }, current_scopes)
   end
 
-  def test_invalid_type_hash_for_default_type_scope
-    assert_raise RuntimeError do
-      get :index, :color => { :blue => :red }
-    end
+  def test_array_of_blank_values_is_ignored
+    Tree.expects(:categories).never
+    Tree.expects(:all).returns([mock_tree])
+    get :index, :categories => [""]
+    assert_equal([mock_tree], assigns(:trees))
+    assert_equal({ }, current_scopes)
   end
 
-  def test_invalid_type_string_for_hash_type_scope
-    assert_raise RuntimeError do
-      get :index, :paginate => "1"
-    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({}, current_scopes)
   end
 
   def test_scope_is_called_with_default_value
@@ -247,3 +277,22 @@ class HasScopeTest < ActionController::TestCase
     end
 end
 
+class TreeHugger
+  include HasScope
+
+  has_scope :color
+
+  def by_color
+    apply_scopes(Tree, :color => 'blue')
+  end
+
+end
+
+class HasScopeOutsideControllerTest < ActiveSupport::TestCase
+
+  def test_has_scope_usable_outside_controller
+    Tree.expects(:color).with('blue')
+    TreeHugger.new.by_color
+  end
+
+end

data/test/test_helper.rb

@@ -1,9 +1,8 @@
-require 'rubygems'
 require 'bundler'
 
 Bundler.setup
 require 'test/unit'
-require 'mocha'
+require 'mocha/setup'
 
 # Configure Rails
 ENV["RAILS_ENV"] = "test"
@@ -17,7 +16,7 @@ require 'has_scope'
 
 HasScope::Routes = ActionDispatch::Routing::RouteSet.new
 HasScope::Routes.draw do
-  match '/:controller(/:action(/:id))'
+  get '/:controller(/:action(/:id))'
 end
 
 class ApplicationController < ActionController::Base

metadata

@@ -1,78 +1,100 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: has_scope
-version: !ruby/object:Gem::Version 
-  hash: 9
-  prerelease: 
-  segments: 
-  - 0
-  - 5
-  - 1
-  version: 0.5.1
+version: !ruby/object:Gem::Version
+  version: 0.6.0.rc
 platform: ruby
-authors: 
-- "Jos\xC3\xA9 Valim"
+authors:
+- José Valim
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-02 00:00:00 +02:00
-default_executable: 
-dependencies: []
-
+date: 2013-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5'
 description: Maps controller filters to your resource scopes
 email: developers@plataformatec.com.br
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-files: 
+extra_rdoc_files:
+- README.md
+files:
 - .gitignore
+- .travis.yml
 - Gemfile
+- Gemfile.lock
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
+- gemfiles/Gemfile-rails.3.2.x
 - has_scope.gemspec
-- init.rb
 - lib/has_scope.rb
 - lib/has_scope/version.rb
 - test/has_scope_test.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: http://github.com/plataformatec/has_scope
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
 requirements: []
-
 rubyforge_project: has_scope
-rubygems_version: 1.6.2
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Maps controller filters to your resource scopes.
-test_files: 
+test_files:
 - test/has_scope_test.rb
 - test/test_helper.rb

data/README.rdoc

@@ -1,101 +0,0 @@
-== HasScope
-
-Has scope allows you to easily create controller filters based on your resources named scopes.
-Imagine the following model called graduations:
-
-  class Graduation < ActiveRecord::Base
-    named_scope :featured, :conditions => { :featured => true }
-    named_scope :by_degree, proc {|degree| { :conditions => { :degree => degree } } }
-  end
-
-You can use those named scopes as filters by declaring them on your controller:
-
-  class GraduationsController < ApplicationController
-    has_scope :featured, :type => :boolean
-    has_scope :by_degree
-  end
-
-Now, if you want to apply them to an specific resource, you just need to call <tt>apply_scopes</tt>:
-
-  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
-    end
-  end
-
-Then for each request:
-
-  /graduations
-  #=> acts like a normal request
-
-  /graduations?featured=true
-  #=> calls the named scope and bring featured graduations
-
-  /graduations?params[by_period][started_at]=20100701&params[by_period][ended_at]=20101013
-  #=> brings graduations in the given period
-
-  /graduations?featured=true&by_degree=phd
-  #=> brings featured graduations with phd degree
-
-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" }.
-
-== Installation
-
-HasScope is available as gem on Gemcutter, so just run the following:
-
-    sudo gem install has_scope
-
-If you want it as plugin, just do:
-
-    script/plugin install git://github.com/plataformatec/has_scope.git
-
-== Options
-
-HasScope supports several options:
-
-* <tt>:type</tt> - Checks the type of the parameter sent. If set to :boolean it just calls the named scope, without any argument. By default, it does not allow hashes or arrays to be given, except if type :hash or :array are set.
-
-* <tt>:only</tt> - In which actions the scope is applied.
-
-* <tt>:except</tt> - In which actions the scope is not applied.
-
-* <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.
-
-* <tt>:default</tt> - Default value for the scope. Whenever supplied the scope is always called.
-
-* <tt>:allow_blank</tt> - Blank values are not sent to scopes by default. Set to true to overwrite.
-
-== Block usage
-
-has_scope also accepts a block. The controller, current scope and value are yielded
-to the block so the user can apply the scope on its own. This is useful in case we
-need to manipulate the given value:
-
-  has_scope :category do |controller, scope, value|
-    value != "all" ? scope.by_category(value) : scope
-  end
-
-When used with booleans, it just receives two arguments and is just invoked if true is given:
-
-  has_scope :not_voted_by_me, :type => :boolean do |controller, scope|
-    scope.not_voted_by(controller.current_user.id) 
-  end
-
-== Bugs and Feedback
-
-If you discover any bugs or want to drop a line, feel free to create an issue on GitHub.
-
-http://github.com/plataformatec/has_scope/issues
-
-MIT License. Copyright 2009 Plataforma Tecnologia. http://blog.plataformatec.com.br

data/init.rb

@@ -1 +0,0 @@
-require 'has_scope'