meta_search 0.5.3 → 0.5.4

data/CHANGELOG

@@ -1,3 +1,8 @@
+Changes since 0.5.3 (2010-07-26):
+ *Add is_true/is_false for boolean columns
+ * Add is_present and is_blank for non-boolean columns
+ * Fix behavior of equals when used with boolean columns.
+
 Changes since 0.5.2 (2010-07-22):
   * Handle nested/namespaced form_for better. Formerly, you could use
     "form_for @search" in a view, but not "form_for [:admin, @search]"

data/VERSION

@@ -1 +1 @@
-0.5.3
+0.5.4

data/lib/meta_search/where.rb

@@ -32,6 +32,16 @@ module MetaSearch
   # * _less_than_ (alias: _lt_) - Less than.
   # * _less_than_or_equal_to_ (aliases: _lte_, _lteq_) - Less than or equal to.
   #
+  # === Booleans
+  #
+  # * _is_true_ - Is true. Useful for a checkbox like "only show admin users".
+  # * _is_false_ - The complement of _is_true_.
+  #
+  # === Non-boolean data types
+  #
+  # * _is_present_ - As with _is_true_, useful with a checkbox. Not NULL or the empty string.
+  # * _is_blank_ - Returns records with a value of NULL or the empty string in the column.
+  #
   # So, given a model like this...
   #
   #   class Article < ActiveRecord::Base
@@ -65,12 +75,17 @@ module MetaSearch
       @validator = where[:validator]
       @formatter = where[:formatter]
       @splat_param = where[:splat_param]
+      @skip_compounds = where[:skip_compounds]
     end
 
     def splat_param?
       !!@splat_param
     end
 
+    def skip_compounds?
+      !!@skip_compounds
+    end
+
     # Format a parameter for searching using the Where's defined formatter.
     def format_param(param)
       formatter.call(param)
@@ -135,25 +150,19 @@ module MetaSearch
       # false, but is used when automatically creating compound Wheres (*_any, *_all) so that the
       # Arel attribute method gets the correct parameter list.
       #
+      # <tt>skip_compounds</tt> will prevent creation of compound condition methods (ending in
+      # _any_ or _all_) for situations where they wouldn't make sense, such as the built-in
+      # conditions <tt>is_true</tt> and <tt>is_false</tt>.
+      #
       # <tt>cast</tt> will override the normal cast of the parameter when using this Where
       # condition. Normally, the value supplied to a condition is cast to the type of the column
       # it's being compared against. In cases where this isn't desirable, because the value you
       # intend to accept isn't the same kind of data you'll be comparing against, you can override
-      # that cast here. For example, this is a Where that you can use with a check_box to allow
-      # searching for records with a blank column. It's important to always cast to integer here,
-      # as otherwise the default checked check_box value, "1", would cast to an invalid date when
-      # searching against date columns, and fall back to nil, making your check_box do nothing:
-      #
-      #   MetaSearch::Where.add :is_blank,
-      #     :predicate => :in,
-      #     :cast => :integer,
-      #     :formatter => Proc.new {|param| [nil, '']},
-      #     :validator => Proc.new {|param|
-      #       !param.zero?
-      #     }
+      # that cast here, using one of the standard DB type symbols such as :integer, :string, :boolean
+      # and so on.
       def add(*args)
         where = create_where_from_args(*args)
-        create_where_compounds_for(where)
+        create_where_compounds_for(where) unless where.skip_compounds?
       end
 
       # Returns the complete array of Wheres
@@ -193,6 +202,7 @@ module MetaSearch
         opts[:cast] = opts[:cast]
         opts[:predicate] ||= :eq
         opts[:splat_param] ||= false
+        opts[:skip_compounds] ||= false
         opts[:formatter] ||= Proc.new {|param| param}
         if opts[:formatter].is_a?(String)
           formatter = opts[:formatter]

data/lib/meta_search.rb

@@ -10,7 +10,7 @@ module MetaSearch
   MAX_JOIN_DEPTH = 5
 
   DEFAULT_WHERES = [
-    ['equals', 'eq'],
+    ['equals', 'eq', {:validator => Proc.new {|param| !param.blank? || (param == false)}}],
     ['does_not_equal', 'ne', 'not_eq', {:types => ALL_TYPES, :predicate => :not_eq}],
     ['contains', 'like', 'matches', {:types => STRINGS, :predicate => :matches, :formatter => '"%#{param}%"'}],
     ['does_not_contain', 'nlike', 'not_matches', {:types => STRINGS, :predicate => :not_matches, :formatter => '"%#{param}%"'}],
@@ -23,7 +23,11 @@ module MetaSearch
     ['greater_than_or_equal_to', 'gte', 'gteq', {:types => (NUMBERS + DATES + TIMES), :predicate => :gteq}],
     ['less_than_or_equal_to', 'lte', 'lteq', {:types => (NUMBERS + DATES + TIMES), :predicate => :lteq}],
     ['in', {:types => ALL_TYPES, :predicate => :in}],
-    ['not_in', 'ni', 'not_in', {:types => ALL_TYPES, :predicate => :not_in}]
+    ['not_in', 'ni', 'not_in', {:types => ALL_TYPES, :predicate => :not_in}],
+    ['is_true', {:types => BOOLEANS, :skip_compounds => true}],
+    ['is_false', {:types => BOOLEANS, :skip_compounds => true, :formatter => Proc.new {|param| !param}}],
+    ['is_present', {:types => (ALL_TYPES - BOOLEANS), :predicate => :not_eq_all, :splat_param => true, :skip_compounds => true, :cast => :boolean, :formatter => Proc.new {|param| [nil, '']}}],
+    ['is_blank', {:types => (ALL_TYPES - BOOLEANS), :predicate => :eq_any, :splat_param => true, :skip_compounds => true, :cast => :boolean, :formatter => Proc.new {|param| [nil, '']}}]
   ]
 
   RELATION_METHODS = [:joins, :includes, :to_a, :all, :count, :to_sql, :paginate, :autojoin, :find_each, :first, :last, :each, :arel]

data/meta_search.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{meta_search}
-  s.version = "0.5.3"
+  s.version = "0.5.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ernie Miller"]
-  s.date = %q{2010-07-26}
+  s.date = %q{2010-07-28}
   s.description = %q{
       Allows simple search forms to be created against an AR3 model
       and its associations, has useful view helpers for sort links
@@ -62,7 +62,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://metautonomo.us/projects/metasearch/}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{ActiveRecord 3 object-based searching for your form_for enjoyment.}
   s.test_files = [
     "test/fixtures/company.rb",
@@ -80,7 +80,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_runtime_dependency(%q<activerecord>, [">= 3.0.0.beta4"])
       s.add_runtime_dependency(%q<activesupport>, [">= 3.0.0.beta4"])

data/test/fixtures/projects.yml

@@ -7,18 +7,28 @@ virus:
   estimated_hours: 80
   name           : Virus
   id             : 2
-  
+
 awesome:
   estimated_hours: 100
   name           : Do something awesome
   id             : 3
-  
+
 metasearch:
   estimated_hours: 100
   name           : MetaSearch Development
   id             : 4
-  
+
 another:
   estimated_hours: 120
   name           : Another Project
-  id             : 5
+  id             : 5
+
+nil:
+  estimated_hours: 1000
+  name           :
+  id             : 6
+
+blank:
+  estimated_hours: 1000
+  name           : ""
+  id             : 7

data/test/test_search.rb

@@ -398,6 +398,48 @@ class TestSearch < Test::Unit::TestCase
         end
       end
 
+      context "where boolean column is_true" do
+        setup do
+          @s.bln_is_true = true
+        end
+
+        should "return five results" do
+          assert_equal 5, @s.all.size
+        end
+
+        should "contain no results with a false boolean column" do
+          assert_does_not_contain @s.all.collect {|r| r.bln}, false
+        end
+      end
+
+      context "where boolean column equals false" do
+        setup do
+          @s.bln_equals = false
+        end
+
+        should "return four results" do
+          assert_equal 4, @s.all.size
+        end
+
+        should "contain no results with a true boolean column" do
+          assert_does_not_contain @s.all.collect {|r| r.bln}, true
+        end
+      end
+
+      context "where boolean column is_false" do
+        setup do
+          @s.bln_is_false = true
+        end
+
+        should "return four results" do
+          assert_equal 4, @s.all.size
+        end
+
+        should "contain no results with a true boolean column" do
+          assert_does_not_contain @s.all.collect {|r| r.bln}, true
+        end
+      end
+
       context "where date column is Christmas 2009 by array" do
         setup do
           @s.dat_equals = [2009, 12, 25]
@@ -600,4 +642,37 @@ class TestSearch < Test::Unit::TestCase
                    @s.first
     end
   end
+
+  [{:name => 'Project', :object => Project},
+   {:name => 'Project as a Relation', :object => Project.scoped}].each do |object|
+    context_a_search_against object[:name], object[:object] do
+      context "where name is present" do
+        setup do
+          @s.name_is_present = true
+        end
+
+        should "return 5 results" do
+          assert_equal 5, @s.all.size
+        end
+
+        should "contain no results with a blank name column" do
+          assert_equal 0, @s.all.select {|r| r.name.blank?}.size
+        end
+      end
+
+      context "where name is blank" do
+        setup do
+          @s.name_is_blank = true
+        end
+
+        should "return 5 results" do
+          assert_equal 2, @s.all.size
+        end
+
+        should "contain no results with a present name column" do
+          assert_equal 0, @s.all.select {|r| r.name.present?}.size
+        end
+      end
+    end
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 5
-  - 3
-  version: 0.5.3
+  - 4
+  version: 0.5.4
 platform: ruby
 authors: 
 - Ernie Miller
@@ -14,13 +14,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-26 00:00:00 -04:00
+date: 2010-07-28 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: shoulda
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -33,6 +34,7 @@ dependencies:
   name: activerecord
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -48,6 +50,7 @@ dependencies:
   name: activesupport
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -63,6 +66,7 @@ dependencies:
   name: actionpack
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -78,6 +82,7 @@ dependencies:
   name: arel
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -145,6 +150,7 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -152,6 +158,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -161,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: ActiveRecord 3 object-based searching for your form_for enjoyment.