meta_search 0.5.1 → 0.5.2

data/CHANGELOG

@@ -1,3 +1,8 @@
+Changes since 0.5.1 (2010-07-20):
+  * Fix fallback for failed cast via to_time or to_date
+  * add :cast option for custom Wheres, allowing a where to override
+    the default cast of the incoming parameters.
+
 Changes since 0.5.0 (2010-06-08):
   * Fix searching against relations derived from a has_many :through
     association

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.5.2

data/lib/meta_search/builder.rb

@@ -234,8 +234,8 @@ module MetaSearch
         end
 
         define_method("#{attribute}_#{predicate}=") do |val|
-          search_attributes["#{attribute}_#{predicate}"] = cast_attributes(column_type(attribute), val)
           where = Where.new(predicate)
+          search_attributes["#{attribute}_#{predicate}"] = cast_attributes(where.cast || column_type(attribute), val)
           if where.validate(search_attributes["#{attribute}_#{predicate}"])
             arel_attribute = get_attribute(attribute)
             @relation = where.eval(@relation, arel_attribute, search_attributes["#{attribute}_#{predicate}"])

data/lib/meta_search/utility.rb

@@ -3,15 +3,15 @@ require 'meta_search/exceptions'
 module MetaSearch
   module Utility #:nodoc:
     private
-    
+
     def array_of_arrays?(vals)
       vals.is_a?(Array) && vals.first.is_a?(Array)
     end
-    
+
     def array_of_dates?(vals)
       vals.is_a?(Array) && vals.first.respond_to?(:to_time)
     end
-    
+
     def cast_attributes(type, vals)
       if array_of_arrays?(vals)
         vals.map! {|v| cast_attributes(type, v)}
@@ -29,7 +29,7 @@ module MetaSearch
         val.respond_to?(:to_s) ? val.to_s : String.new(val)
       when *DATES
         if val.respond_to?(:to_date)
-          val.to_date
+          val.to_date rescue nil
         else
           y, m, d = *[val].flatten
           m ||= 1
@@ -38,7 +38,7 @@ module MetaSearch
         end
       when *TIMES
         if val.respond_to?(:to_time)
-          val.to_time
+          val.to_time rescue nil
         else
           y, m, d, hh, mm, ss = *[val].flatten
           Time.zone.local(y, m, d, hh, mm, ss) rescue nil
@@ -55,7 +55,7 @@ module MetaSearch
         raise TypeCastError, "Unable to cast columns of type #{type}"
       end
     end
-    
+
     def collapse_multiparameter_options(opts)
       opts.keys.each do |k|
         if k.include?("(")
@@ -73,11 +73,11 @@ module MetaSearch
       end
       opts
     end
-    
+
     def quote_table_name(name)
       ActiveRecord::Base.connection.quote_table_name(name)
     end
-    
+
     def quote_column_name(name)
       ActiveRecord::Base.connection.quote_column_name(name)
     end

data/lib/meta_search/where.rb

@@ -52,7 +52,7 @@ module MetaSearch
   #
   # will match articles authored by Jimmy, Bobby, or Freddy, but not Winifred.
   class Where
-    attr_reader :name, :aliases, :types, :predicate, :formatter, :validator
+    attr_reader :name, :aliases, :types, :cast, :predicate, :formatter, :validator
     def initialize(where)
       if [String,Symbol].include?(where.class)
         where = Where.get(where) or raise ArgumentError("A where could not be instantiated for the argument #{where}")
@@ -60,26 +60,27 @@ module MetaSearch
       @name = where[:name]
       @aliases = where[:aliases]
       @types = where[:types]
+      @cast = where[:cast]
       @predicate = where[:predicate]
       @validator = where[:validator]
       @formatter = where[:formatter]
       @splat_param = where[:splat_param]
     end
-    
+
     def splat_param?
       !!@splat_param
     end
-    
+
     # Format a parameter for searching using the Where's defined formatter.
     def format_param(param)
       formatter.call(param)
     end
-    
+
     # Validate the parameter for use in a search using the Where's defined validator.
     def validate(param)
       validator.call(param)
     end
-    
+
     # Evaluate the Where for the given relation, attribute, and parameter(s)
     def eval(relation, attribute, param)
       if splat_param?
@@ -88,19 +89,19 @@ module MetaSearch
         relation.where(attribute.send(predicate, format_param(param)))
       end
     end
-    
+
     class << self
       # At application initialization, you can add additional custom Wheres to the mix.
       # in your application's <tt>config/initializers/meta_search.rb</tt>, place lines
       # like this:
       #
-      # MetaSearch::Where.add :between, :btw,
-      #   :predicate => :in,
-      #   :types => [:integer, :float, :decimal, :date, :datetime, :timestamp, :time],
-      #   :formatter => Proc.new {|param| Range.new(param.first, param.last)},
-      #   :validator => Proc.new {|param|
-      #     param.is_a?(Array) && !(param[0].blank? || param[1].blank?)
-      #   }
+      #   MetaSearch::Where.add :between, :btw,
+      #     :predicate => :in,
+      #     :types => [:integer, :float, :decimal, :date, :datetime, :timestamp, :time],
+      #     :formatter => Proc.new {|param| Range.new(param.first, param.last)},
+      #     :validator => Proc.new {|param|
+      #       param.is_a?(Array) && !(param[0].blank? || param[1].blank?)
+      #     }
       #
       # The first options are all names for the where. Well, the first is a name, the rest
       # are aliases, really. They will determine the suffix you will use to access your Where.
@@ -133,16 +134,33 @@ module MetaSearch
       # to be splatted (converted to an argument list). This is not normally useful and defaults to
       # false, but is used when automatically creating compound Wheres (*_any, *_all) so that the
       # Arel attribute method gets the correct parameter list.
+      #
+      # <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?
+      #     }
       def add(*args)
         where = create_where_from_args(*args)
         create_where_compounds_for(where)
       end
-      
+
       # Returns the complete array of Wheres
       def all
         @@wheres
       end
-      
+
       # Get the where matching a method or predicate.
       def get(method_id_or_predicate)
         return nil unless where_key = @@wheres.keys.
@@ -152,7 +170,7 @@ module MetaSearch
         where = @@wheres[where] if where.is_a?(String)
         where
       end
-      
+
       # Set the wheres to their default values, removing any customized settings.
       def initialize_wheres
         @@wheres = {}
@@ -160,9 +178,9 @@ module MetaSearch
           add(*where)
         end
       end
-      
+
       private
-      
+
       # "Creates" the Where by adding it (and its aliases) to the current hash of wheres. It then
       # instantiates a Where and returns it for use.
       def create_where_from_args(*args)
@@ -172,6 +190,7 @@ module MetaSearch
         opts[:name] ||= args.first
         opts[:types] ||= ALL_TYPES
         opts[:types] = [opts[:types]].flatten
+        opts[:cast] = opts[:cast]
         opts[:predicate] ||= :eq
         opts[:splat_param] ||= false
         opts[:formatter] ||= Proc.new {|param| param}
@@ -201,7 +220,7 @@ module MetaSearch
         end
         new(opts[:name])
       end
-      
+
       # Takes the provided +where+ param and derives two additional Wheres from it, with the
       # name appended by _any/_all. These will use Arel's grouped predicate methods (matching
       # the same naming convention) to be invoked instead, with a list of possible/required
@@ -227,6 +246,6 @@ module MetaSearch
       end
     end
   end
-  
+
   Where.initialize_wheres
 end

data/meta_search.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{meta_search}
-  s.version = "0.5.1"
+  s.version = "0.5.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ernie Miller"]
-  s.date = %q{2010-07-20}
+  s.date = %q{2010-07-22}
   s.description = %q{
       Allows simple search forms to be created against an AR3 model
       and its associations, has useful view helpers for sort links

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 5
-  - 1
-  version: 0.5.1
+  - 2
+  version: 0.5.2
 platform: ruby
 authors: 
 - Ernie Miller
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-20 00:00:00 -04:00
+date: 2010-07-22 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency