scoped_from 0.2 → 0.3

data/Gemfile.lock

@@ -8,39 +8,39 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    actionpack (3.1.1)
-      activemodel (= 3.1.1)
-      activesupport (= 3.1.1)
+    actionpack (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       i18n (~> 0.6)
-      rack (~> 1.3.2)
+      rack (~> 1.3.5)
       rack-cache (~> 1.1)
       rack-mount (~> 0.8.2)
       rack-test (~> 0.6.1)
-      sprockets (~> 2.0.2)
-    activemodel (3.1.1)
-      activesupport (= 3.1.1)
+      sprockets (~> 2.0.3)
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
       builder (~> 3.0.0)
       i18n (~> 0.6)
-    activerecord (3.1.1)
-      activemodel (= 3.1.1)
-      activesupport (= 3.1.1)
+    activerecord (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
       arel (~> 2.2.1)
       tzinfo (~> 0.3.29)
-    activesupport (3.1.1)
+    activesupport (3.1.3)
       multi_json (~> 1.0)
     arel (2.2.1)
     builder (3.0.0)
-    columnize (0.3.4)
+    columnize (0.3.5)
     diff-lcs (1.1.3)
     erubis (2.7.0)
     hike (1.2.1)
     i18n (0.6.0)
-    json (1.6.1)
+    json (1.6.2)
     linecache (0.46)
       rbx-require-relative (> 0.0.4)
-    multi_json (1.0.3)
+    multi_json (1.0.4)
     rack (1.3.5)
     rack-cache (1.1)
       rack (>= 0.4)
@@ -50,9 +50,9 @@ GEM
       rack
     rack-test (0.6.1)
       rack (>= 1.0)
-    railties (3.1.1)
-      actionpack (= 3.1.1)
-      activesupport (= 3.1.1)
+    railties (3.1.3)
+      actionpack (= 3.1.3)
+      activesupport (= 3.1.3)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
@@ -88,7 +88,7 @@ GEM
       sqlite3 (>= 1.3.3)
     thor (0.14.6)
     tilt (1.3.3)
-    tzinfo (0.3.30)
+    tzinfo (0.3.31)
 
 PLATFORMS
   ruby

data/README.mdown

@@ -66,6 +66,8 @@ All scopes can be mapped with `scoped_from` method **except** scopes taking a
 Scopes with no argument are invoked if parameter value is evaluated as `true`.
 It includes `"true"`, `"yes"`, `"y"`, `"on"`, and `"1"` strings.
 
+Columns are also automatically scoped.
+
 ## Scopes restriction
 
 You can restrict mapping to some scopes with `:only` option:
@@ -100,14 +102,10 @@ is equivalent to
     
     @posts = Post.search('bar').search('foo')
 
-By default, blank parameter values are ignored, you can include them with
-`:include_blank` option:
-
-    @posts = Post.scoped_from(params, :include_blank => true)
-
-You may also want to filter on columns, just specify `:include_columns` option:
+You may also not want to filter on columns, just specify `:exclude_columns`
+option:
 
-    @posts = Post.scoped_from(params, :include_columns => true)
+    @posts = Post.scoped_from(params, :exclude_columns => true)
 
 A query string can also be given to `scoped_from` method:
 

data/VERSION

@@ -1 +1 @@
-0.2
+0.3

data/lib/scoped_from/query.rb

@@ -2,6 +2,7 @@ module ScopedFrom
   
   class Query
 
+    FALSE_VALUES = %w( false no n off 0 ).freeze
     ORDER_DIRECTIONS = %w( asc desc ).freeze
     TRUE_VALUES = %w( true yes y on 1 ).freeze
     
@@ -9,8 +10,6 @@ module ScopedFrom
     
     # Available options are: - :only : to restrict to specified keys.
     #                        - :except : to ignore specified keys.
-    #                        - :include_blank : to include blank values
-    #                                           (default false).
     def initialize(scope, params, options = {})
       @scope = scope.scoped
       @options = options
@@ -46,6 +45,10 @@ module ScopedFrom
       scope
     end
     
+    def false?(value)
+      FALSE_VALUES.include?(value.to_s.strip.downcase)
+    end
+    
     def order_to_sql(value)
       order = parse_order(value)
       "#{order[:column]} #{order[:direction].upcase}" if order.present?
@@ -71,16 +74,23 @@ module ScopedFrom
       @params = ActiveSupport::HashWithIndifferentAccess.new
       params.each do |name, value|
         values = [value].flatten
-        values.delete_if(&:blank?) unless @options[:include_blank]
         next if values.empty?
         if name.to_s == 'order'
           order = parse_order(values.last)
           @params[name] = "#{order[:column]}.#{order[:direction]}" if order.present?
         elsif @scope.scope_without_argument?(name)
-          @params[name] = true if values.any? { |value| true?(value) }
-        elsif @scope.scope_with_one_argument?(name) || @options[:include_columns].present? && @scope.column_names.include?(name.to_s)
+          @params[name] = true if values.all? { |value| true?(value) }
+        elsif @scope.scope_with_one_argument?(name)
           value = values.many? ? values : values.first
           @params[name] = @params[name] ? [@params[name], value].flatten : value
+        elsif @options[:exclude_columns].blank? && @scope.column_names.include?(name.to_s)
+          if @scope.columns_hash[name.to_s].type == :boolean
+            @params[name] = true if values.all? { |value| true?(value) }
+            @params[name] = false if values.all? { |value| false?(value) }
+          else
+            value = values.many? ? values : values.first
+            @params[name] = @params[name] ? [@params[name], value].flatten : value
+          end
         end
       end
       @params.slice!(*[@options[:only]].flatten) if @options[:only].present?

data/spec/scoped_from/query_spec.rb

@@ -6,6 +6,61 @@ describe ScopedFrom::Query do
     ScopedFrom::Query.new(scope, params, options)
   end
   
+  describe '#false?' do
+    
+    it 'is true if false is given' do
+      query.send(:false?, false).should be_true
+    end
+    
+    it 'is true if "false" is given' do
+      query.send(:false?, 'false').should be_true
+      query.send(:false?, 'False').should be_true
+    end
+    
+    it 'is true if "0" is given' do
+      query.send(:false?, '0').should be_true
+    end
+    
+    it 'is true if "off" is given' do
+      query.send(:false?, 'off').should be_true
+      query.send(:false?, 'OFF ').should be_true
+    end
+    
+    it 'is true if "no" is given' do
+      query.send(:false?, 'no').should be_true
+      query.send(:false?, ' No ').should be_true
+    end
+    
+    it 'is true if "n" is given' do
+      query.send(:false?, 'n').should be_true
+      query.send(:false?, 'N ').should be_true
+    end
+    
+    it 'is false if true is given' do
+      query.send(:false?, true).should be_false
+    end
+    
+    it 'is false if "true" is given' do
+      query.send(:false?, 'true').should be_false
+      query.send(:false?, 'TrUe').should be_false
+    end
+    
+    it 'is false if "1" is given' do
+      query.send(:false?, '1').should be_false
+    end
+    
+    it 'is false if "on" is given' do
+      query.send(:false?, "on").should be_false
+      query.send(:false?, "On").should be_false
+    end
+    
+    it 'is false otherwise' do
+      query.send(:false?, 42).should be_false
+      query.send(:false?, 'bam').should be_false
+    end
+    
+  end
+  
   describe '#initialize' do
     
     it 'invokes #scoped method on specified scope' do
@@ -90,10 +145,6 @@ describe ScopedFrom::Query do
       query(User, :foo => 'bar', 'search' => 'foo', :enabled => true).params.should == { 'search' => 'foo', 'enabled' => true }
     end
     
-    it 'removes blank values' do
-      query(User, 'enabled' => true, 'search' => " \n").params.should == { 'enabled' => true }
-    end
-    
     it 'is case sensitive' do
       query(User, 'Enabled' => true, "SEARCH" => 'bar').params.should be_empty
     end
@@ -118,27 +169,32 @@ describe ScopedFrom::Query do
       query(User, 'search=bar&search=baz').params.should == { 'search' => ['bar', 'baz'] }
     end
     
-    it 'removes blank values from array' do
-      query(User, :search => [nil, 'bar', "\n ", 'baz']).params.should == { 'search' => ['bar', 'baz'] }
-    end
-    
     it 'converts value to true (or remove it) if scope takes no argument' do
       query(User, :latest => 'y').params.should == { 'latest' => true }
       query(User, :latest => 'no').params.should == {}
     end
     
+    it 'converts value to true (or false) if column is a boolean one' do
+      query(User, :admin => 'y').params.should == { 'admin' => true }
+      query(User, :admin => 'False').params.should == { 'admin' => false }
+      query(User, :admin => 'bar').params.should == {}
+      query(User, :admin => ['y', false]).params.should == {}
+    end
+    
     it 'converts array value to true (or remove it) if scope takes no argument' do
-      query(User, :latest => ['no', 'yes']).params.should == { 'latest' => true }
+      query(User, :latest => true).params.should == { 'latest' => true }
+      query(User, :latest => ['Yes']).params.should == { 'latest' => true }
+      query(User, :latest => ['no', 'yes']).params.should == {}
       query(User, :latest => ['no', nil]).params.should == {}
       query(User, :latest => ['fo']).params.should == {}
     end
     
     it 'flats array' do
-      query(User, :search => [nil, ['bar', '', 'foo', ["\n ", 'baz']]]).params.should == { 'search' => ['bar', 'foo', 'baz'] }
+      query(User, :search => [nil, ['bar', '', 'foo', ["\n ", 'baz']]]).params.should == { 'search' => [nil, 'bar', '', 'foo', "\n ", 'baz'] }
     end
     
     it 'change array with a single value in one value' do
-      query(User, :search => [nil, 'bar', "\n"]).params.should == { 'search' => 'bar' }
+      query(User, :search => ['bar']).params.should == { 'search' => 'bar' }
     end
     
     it 'does not modify given hash' do
@@ -156,40 +212,46 @@ describe ScopedFrom::Query do
     it 'accepts :only option' do
       query(User, { :search => 'bar', :enabled => 'true' }, :only => [:search]).params.should == { 'search' => 'bar' }
       query(User, { :search => 'bar', :enabled => 'true' }, :only => 'search').params.should == { 'search' => 'bar' }
+      query(User, { :search => 'bar', :firstname => 'Jane', :enabled => 'true' }, :only => 'search').params.should == { 'search' => 'bar' }
+      query(User, { :search => 'bar', :firstname => 'Jane', :enabled => 'true' }, :only => ['search', :firstname]).params.should == { 'search' => 'bar', 'firstname' => 'Jane' }
     end
     
     it 'accepts :except option' do
       query(User, { :search => 'bar', :enabled => true }, :except => [:search]).params.should == { 'enabled' => true }
       query(User, { :search => 'bar', :enabled => true }, :except => 'search').params.should == { 'enabled' => true }
+      query(User, { :search => 'bar', :firstname => 'Jane', :enabled => true }, :except => 'search').params.should == { 'enabled' => true, 'firstname' => 'Jane' }
+      query(User, { :search => 'bar', :firstname => 'Jane', :enabled => true }, :except => ['search', :firstname]).params.should == { 'enabled' => true }
     end
     
     it 'accepts a query instance' do
       query(User, query(User, :search => 'toto')).params.should == { 'search' => 'toto' }
     end
     
-    it 'preserve blank values if :include_blank option is true' do
-      query(User, { :search => "\n ", 'enabled' => true }, :include_blank => true).params.should == { 'search' => "\n ", 'enabled' => true }
+    it 'preserve blank values' do
+      query(User, { :search => "\n ", 'enabled' => true }).params.should == { 'search' => "\n ", 'enabled' => true }
+    end
+    
+    it 'preserve blank values from array' do
+      query(User, { 'search' => ["\n ", 'toto', 'titi'] }).params.should == { 'search' => ["\n ", 'toto', 'titi'] }
+      query(User, { 'search' => [] }).params.should == {}
     end
     
-    it 'preserve blank values from array if :include_blank option is true' do
-      query(User, { 'search' => ["\n ", 'toto', 'titi'] }, :include_blank => true).params.should == { 'search' => ["\n ", 'toto', 'titi'] }
-      query(User, { 'search' => [] }, :include_blank => true).params.should == {}
+    it 'also preserve blank on query string' do
+      query(User, 'search=%20&enabled=true&search=foo').params.should == { 'search' => [' ', 'foo'], 'enabled' => true }
     end
     
-    it 'also preserve blank on query string if :include_blank option is true' do
-      query(User, 'search=%20&enabled=true&search=foo', :include_blank => true).params.should == { 'search' => [' ', 'foo'], 'enabled' => true }
+    it 'includes column values' do
+      query(User, 'firstname' => 'Jane', 'foo' => 'bar').params.should == { 'firstname' => 'Jane' }
+      query(User, :firstname => 'Jane', 'foo' => 'bar').params.should == { 'firstname' => 'Jane' }
     end
     
-    it 'removes column values' do
-      query(User, 'firstname' => 'Jane', 'foo' => 'bar').params.should == {}
+    it 'exclude column values if :exclude_columns option is specified' do
+      query(User, { :enabled => true, 'firstname' => 'Jane', 'foo' => 'bar' }, :exclude_columns => true).params.should == { 'enabled' => true }
+      query(User, { :enabled => true, :firstname => 'Jane', :foo => 'bar' }, :exclude_columns => true).params.should == { 'enabled' => true }
     end
     
-    it 'include column values if :include_columns option is specified' do
-      query(User, { 'firstname' => 'Jane', 'foo' => 'bar' }, :include_columns => true).params.should == { 'firstname' => 'Jane' }
-      query(User, { :firstname => 'Jane', :foo => 'bar' }, :include_columns => true).params.should == { 'firstname' => 'Jane' }
-      query(User, { 'firstname' => ['Jane', 'John'], 'foo' => 'bar' }, :include_columns => true).params.should == { 'firstname' => ['Jane', 'John'] }
-      query(User, { 'firstname' => "\n ", 'foo' => 'bar' }, :include_columns => true).params.should == {}
-      query(User, { 'firstname' => "\n ", 'foo' => 'bar' }, :include_columns => true, :include_blank => true).params.should == { 'firstname' => "\n " }
+    it 'scopes have priority on columns' do
+      query(User, :enabled => false).params.should == {}
     end
     
     it 'maps an "order"' do
@@ -345,7 +407,7 @@ describe ScopedFrom::Query do
       query.send(:scoped, User, :created_between, true).should == User
     end
     
-    it 'invokes scope without arguments if scope takes not argument' do
+    it 'invokes scope without arguments if scope takes no arguments' do
       query.send(:scoped, User.scoped, :enabled, true).should == [users(:john)]
       query.send(:scoped, User.scoped, :enabled, ' 1 ').should == [users(:john)]
       query.send(:scoped, User.scoped, :enabled, 'off').should == [users(:john)]

data/spec/spec_helper.rb

@@ -19,7 +19,7 @@ RSpec.configure do |config|
     User.delete_all
     Vote.delete_all
     
-    create_user(:john, :firstname => 'John', :lastname => 'Doe', :enabled => true)
-    create_user(:jane, :firstname => 'Jane', :lastname => 'Doe', :enabled => false)
+    create_user(:john, :firstname => 'John', :lastname => 'Doe', :enabled => true, :admin => true)
+    create_user(:jane, :firstname => 'Jane', :lastname => 'Doe', :enabled => false, :admin => false)
   end
 end

data/spec/support/bootsrap/database.rb

@@ -5,7 +5,8 @@ ActiveRecord::Base.connection.create_table(:posts, :force => true)
 ActiveRecord::Base.connection.create_table(:users, :force => true) do |t|
   t.string :firstname, :null => false
   t.string :lastname, :null => false
-  t.boolean :enabled, :null => false
+  t.boolean :enabled, :null => false, :default => false
+  t.boolean :admin, :null => false, :default => false
   t.timestamps
 end
 ActiveRecord::Base.connection.create_table(:votes, :force => true)

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: scoped_from
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
-  - 2
-  version: "0.2"
+  - 3
+  version: "0.3"
 platform: ruby
 authors: 
 - Alexis Toulotte
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-27 00:00:00 Z
+date: 2011-11-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord