searchlogic 1.5.6 → 1.5.7

data/CHANGELOG.rdoc

@@ -1,4 +1,9 @@
-== 1.5.6 released 2008-11-17
+== 1.5.7 released 2008-11-30
+
+* Fixed how grouping works, you can now specify "and_group" and "or_group", just like you can with conditions.
+* Specifying a join type will take priority. So "and_name_like" will ALWAYS join with AND, even is any = true for the search.
+
+== 1.5.6 released 2008-11-29
 
 * The order conditions are set is now relevant and will be reflected in the SQL. Setting a condition first will make it first in the SQL, setting a condition last will make it last in the SQL.
 * The above allows for prefixing any condition with and_ or or_. Thus letting you create somewhat more complex queries, since the order matters.

data/README.rdoc

@@ -1,6 +1,17 @@
 = Searchlogic
 
-Searchlogic is object based ActiveRecord searching, ordering, and pagination all in one. It's a simple, quick, all inclusive package for displaying data in your application.
+Searchlogic's goal is to keep your application free of searching clutter. It's is an ActiveRecord extension that allows you to perform simple and complex searches with a hash. Why is this great? Because GET and POST parameters are a hash. This means if you can execute a search with a hash, you can execute a search using GET or POST parameters. This makes searching in your application dead simple and clutter free:
+
+  @search = User.new_search(params[:search])
+  @users = @search.all
+
+Now think about it this way. How are resources / web services used? Through GET and POST. All of a sudden you have a resource that comes preloaded with a *very* flexible searching functionality, all with 2 lines of code.
+
+What about your interface? What is an HTML form's sole purpose? It's to send GET or POST parameters to a URI. Now you can build a form that represents a search. Meaning adding a condition to your search is as easy as adding a field to your form. That's what the @search object above is all about. You can pass that right into your form builder and build a form just like you would for an ActiveRecord object. Now you can use that handy form builder that you like you use and get rid of even more searching clutter in your views.
+
+Searching in your application has never been cleaner, more flexible, or easier.
+
+These are just the basics of Searchlogic, it can do a lot more, including pagination, ordering data, etc. All of these things are just as simple, if not simpler. Keep reading to find out everything it can do.
 
 == Helpful links
 
@@ -238,16 +249,16 @@ Group with a block:
 
 Group with a hash:
 
-  search = User.new_search(:conditions => {
-    :id_gt => 2,
-    :group => [
+  search = User.new_search(:conditions => [
+    {:id_gt => 2},
+    {:group => [
       {:first_name_like => "Ben"},
-      {
-        :last_name_like => "Johnson",
-        :group => {:email_ends_with => "binarylogic.com"}
-      }
-    ]
-  })
+      [
+        {:last_name_like => "Johnson"},
+        {:group => {:email_ends_with => "binarylogic.com"}}
+      ]
+    ]}
+  ])
   # => id > 2 AND (first_name like '%Ben%') AND (last_name like '%Johnson%' AND (email like '%binarylogic.com'))
 
 I want to end this by saying Searchlog was never meant to replace SQL, name_scopes, etc. If you need to perform complex searching there is nothing wrong with resorting to a named scope or using the traditional search methods. In fact, search logic plays nice with named_scopes anyways, so you can combine the 2 if needed:

data/lib/searchlogic/condition/base.rb

@@ -7,7 +7,7 @@ module Searchlogic
     class Base
       include Shared::Utilities
       
-      attr_accessor :any, :column, :column_for_type_cast, :column_sql, :column_sql_format, :klass, :object_name, :table_name
+      attr_accessor :column, :column_for_type_cast, :column_sql, :column_sql_format, :explicit_any, :klass, :object_name, :table_name
       class_inheritable_accessor :handle_array_value, :ignore_meaningless_value, :join_arrays_with_or, :value_type
       self.ignore_meaningless_value = true
     
@@ -61,8 +61,8 @@ module Searchlogic
         end
       end
       
-      def any? # :nodoc:
-        any == true
+      def explicit_any? # :nodoc:
+        explicit_any == true
       end
       
       # Substitutes string vars with table and column name. Allows us to switch the column and table on the fly and have the condition update appropriately.

data/lib/searchlogic/conditions/any_or_all.rb

@@ -2,7 +2,7 @@ module Searchlogic
   module Conditions
     # = Any or All
     #
-    # Adds the ability to join all conditions wth "ANY" or "ALL".
+    # Adds the ability to join all conditions wth "AND" or "OR".
     module AnyOrAll
       # Determines if we should join the conditions with "AND" or "OR".
       #
@@ -11,7 +11,7 @@ module Searchlogic
       #   search.conditions.any = true # will join all conditions with "or", you can also set this to "true", "1", or "yes"
       #   search.conditions.any = false # will join all conditions with "and"
       def any=(value)
-        objects.each { |object| object.any = value }
+        (association_objects + group_objects).each { |object| object.any = value }
         @any = value
       end
       

data/lib/searchlogic/conditions/base.rb

@@ -138,13 +138,19 @@ module Searchlogic
       def sanitize
         return @conditions if @conditions # return the conditions if the user set them with a string, aka sql conditions
         joined_conditions = nil
-        objects.each { |object| joined_conditions = merge_conditions(joined_conditions, object.class == self.class ? scope_condition(object.sanitize) : object.sanitize, :any => object.any?, :scope => false) }
+        objects.each do |object|
+          any = !object.explicit_any.nil? && (condition?(object) || group?(object)) ? object.explicit_any? : any?
+          sanitized_conditions = group?(object) ? scope_condition(object.sanitize) : object.sanitize
+          joined_conditions = merge_conditions(joined_conditions, sanitized_conditions, :any => any)
+        end
         joined_conditions
       end
       
       # Allows you to set the conditions via a hash.
       def conditions=(value)
         case value
+        when Array
+          value.each { |v| self.conditions = v }
         when Hash
           remove_conditions_from_protected_assignement(value).each do |condition, condition_value|
             next if [:conditions].include?(condition.to_sym) # protect sensitive methods
@@ -198,11 +204,19 @@ module Searchlogic
       
       private
         def association_objects
-          objects.select { |object| object.class < Base && object.class != self.class }
+          objects.select { |object| association?(object) }
+        end
+        
+        def association?(object)
+          object.class < Base && object.class != self.class
         end
         
         def condition_objects
-          objects.select { |object| object.class < Condition::Base }
+          objects.select { |object| condition?(object) }
+        end
+        
+        def condition?(object)
+          object.class < Condition::Base
         end
         
         def objects

data/lib/searchlogic/conditions/groups.rb

@@ -10,27 +10,62 @@ module Searchlogic
       end
       
       # Creates a new group object to set condition off of. See examples at top of class on how to use this.
-      def group(&block)
-        obj = self.class.new
-        yield obj if block_given?
-        objects << obj
-        obj
+      def group(conditions = nil, forward_arrays = false, &block)
+        if conditions.is_a?(Array) && !forward_arrays
+          group_objects = []
+          conditions.each { |condition| group_objects << group(condition, true, &block) }
+          group_objects
+        else
+          obj = self.class.new
+          obj.conditions = conditions unless conditions.nil?
+          yield obj if block_given?
+          objects << obj
+          obj
+        end
+      end
+      alias_method :group=, :group
+      
+      def and_group(*args, &block)
+        obj = group(*args, &block)
+        case obj
+        when Array
+          obj.each { |o| o.group_any = false }
+        else
+          obj
+        end
       end
+      alias_method :and_group=, :and_group
       
-      # Lets you conditions to be groups or an array of conditions to be put in their own group. Each item in the array will create a new group. This is nice for using
-      # groups in forms.
-      def group=(value)
-        case value
+      def or_group(*args, &block)
+        obj = group(*args, &block)
+        case obj
         when Array
-          value.each { |v| group.conditions = v }
+          obj.each { |o| o.group_any = true }
         else
-          group.conditions = value
+          obj
         end
       end
+      alias_method :or_group=, :or_group
+      
+      def explicit_any=(value) # :nodoc:
+        @explicit_any = value
+      end
+      
+      def explicit_any # :nodoc
+        @explicit_any
+      end
+      
+      def explicit_any? # :nodoc:
+        ["true", "1", "yes"].include? explicit_any.to_s
+      end
       
       private
         def group_objects
-          objects.select { |object| object.class == self.class }
+          objects.select { |object| group?(object) }
+        end
+        
+        def group?(object)
+          object.class == self.class
         end
     end
   end

data/lib/searchlogic/conditions/magic_methods.rb

@@ -223,6 +223,8 @@ module Searchlogic
               def #{name}
                 #{name}_object.value
               end
+              alias_method :and_#{name}, :#{name}
+              alias_method :or_#{name}, :#{name}
             
               def #{name}=(value)
                 @conditions = nil
@@ -232,12 +234,12 @@ module Searchlogic
               end
             
               def and_#{name}=(value)
-                #{name}_object.any = false
+                #{name}_object.explicit_any = false
                 self.#{name} = value
               end
             
               def or_#{name}=(value)
-                #{name}_object.any = true
+                #{name}_object.explicit_any = true
                 self.#{name} = value
               end
             

data/lib/searchlogic/shared/utilities.rb

@@ -7,7 +7,6 @@ module Searchlogic
           conditions.delete_if { |condition| condition.blank? }
           return if conditions.blank?
           return conditions.first if conditions.size == 1
-          options[:scope] = true unless options.key?(:scope)
         
           conditions_strs = []
           conditions_subs = []
@@ -22,7 +21,7 @@ module Searchlogic
           return if conditions_strs.blank?
         
           join = options[:any] ? " OR " : " AND "
-          conditions_str = options[:scope] ? "(#{conditions_strs.join(")#{join}(")})" : conditions_strs.join(join)
+          conditions_str = conditions_strs.join(join)
         
           return conditions_str if conditions_subs.blank?
         

data/lib/searchlogic/version.rb

@@ -67,7 +67,7 @@ module Searchlogic
 
     MAJOR = 1
     MINOR = 5
-    TINY  = 6
+    TINY  = 7
 
     # The current version as a Version instance
     CURRENT = new(MAJOR, MINOR, TINY)

data/searchlogic.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{searchlogic}
-  s.version = "1.5.6"
+  s.version = "1.5.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Johnson of Binary Logic"]
-  s.date = %q{2008-11-29}
+  s.date = %q{2008-11-30}
   s.description = %q{Object based ActiveRecord searching, ordering, pagination, and more!}
   s.email = %q{bjohnson@binarylogic.com}
   s.extra_rdoc_files = ["CHANGELOG.rdoc", "lib/searchlogic/active_record/associations.rb", "lib/searchlogic/active_record/base.rb", "lib/searchlogic/active_record/connection_adapters/mysql_adapter.rb", "lib/searchlogic/active_record/connection_adapters/postgresql_adapter.rb", "lib/searchlogic/active_record/connection_adapters/sqlite_adapter.rb", "lib/searchlogic/condition/base.rb", "lib/searchlogic/condition/begins_with.rb", "lib/searchlogic/condition/blank.rb", "lib/searchlogic/condition/child_of.rb", "lib/searchlogic/condition/descendant_of.rb", "lib/searchlogic/condition/ends_with.rb", "lib/searchlogic/condition/equals.rb", "lib/searchlogic/condition/greater_than.rb", "lib/searchlogic/condition/greater_than_or_equal_to.rb", "lib/searchlogic/condition/inclusive_descendant_of.rb", "lib/searchlogic/condition/keywords.rb", "lib/searchlogic/condition/less_than.rb", "lib/searchlogic/condition/less_than_or_equal_to.rb", "lib/searchlogic/condition/like.rb", "lib/searchlogic/condition/nil.rb", "lib/searchlogic/condition/not_begin_with.rb", "lib/searchlogic/condition/not_blank.rb", "lib/searchlogic/condition/not_end_with.rb", "lib/searchlogic/condition/not_equal.rb", "lib/searchlogic/condition/not_have_keywords.rb", "lib/searchlogic/condition/not_like.rb", "lib/searchlogic/condition/not_nil.rb", "lib/searchlogic/condition/sibling_of.rb", "lib/searchlogic/condition/tree.rb", "lib/searchlogic/conditions/any_or_all.rb", "lib/searchlogic/conditions/base.rb", "lib/searchlogic/conditions/groups.rb", "lib/searchlogic/conditions/magic_methods.rb", "lib/searchlogic/conditions/protection.rb", "lib/searchlogic/config/helpers.rb", "lib/searchlogic/config/search.rb", "lib/searchlogic/config.rb", "lib/searchlogic/core_ext/hash.rb", "lib/searchlogic/helpers/control_types/link.rb", "lib/searchlogic/helpers/control_types/links.rb", "lib/searchlogic/helpers/control_types/remote_link.rb", "lib/searchlogic/helpers/control_types/remote_links.rb", "lib/searchlogic/helpers/control_types/remote_select.rb", "lib/searchlogic/helpers/control_types/select.rb", "lib/searchlogic/helpers/form.rb", "lib/searchlogic/helpers/utilities.rb", "lib/searchlogic/modifiers/absolute.rb", "lib/searchlogic/modifiers/acos.rb", "lib/searchlogic/modifiers/asin.rb", "lib/searchlogic/modifiers/atan.rb", "lib/searchlogic/modifiers/base.rb", "lib/searchlogic/modifiers/ceil.rb", "lib/searchlogic/modifiers/char_length.rb", "lib/searchlogic/modifiers/cos.rb", "lib/searchlogic/modifiers/cot.rb", "lib/searchlogic/modifiers/day_of_month.rb", "lib/searchlogic/modifiers/day_of_week.rb", "lib/searchlogic/modifiers/day_of_year.rb", "lib/searchlogic/modifiers/degrees.rb", "lib/searchlogic/modifiers/exp.rb", "lib/searchlogic/modifiers/floor.rb", "lib/searchlogic/modifiers/hex.rb", "lib/searchlogic/modifiers/hour.rb", "lib/searchlogic/modifiers/log.rb", "lib/searchlogic/modifiers/log10.rb", "lib/searchlogic/modifiers/log2.rb", "lib/searchlogic/modifiers/lower.rb", "lib/searchlogic/modifiers/ltrim.rb", "lib/searchlogic/modifiers/md5.rb", "lib/searchlogic/modifiers/microseconds.rb", "lib/searchlogic/modifiers/milliseconds.rb", "lib/searchlogic/modifiers/minute.rb", "lib/searchlogic/modifiers/month.rb", "lib/searchlogic/modifiers/octal.rb", "lib/searchlogic/modifiers/radians.rb", "lib/searchlogic/modifiers/round.rb", "lib/searchlogic/modifiers/rtrim.rb", "lib/searchlogic/modifiers/second.rb", "lib/searchlogic/modifiers/sign.rb", "lib/searchlogic/modifiers/sin.rb", "lib/searchlogic/modifiers/square_root.rb", "lib/searchlogic/modifiers/tan.rb", "lib/searchlogic/modifiers/trim.rb", "lib/searchlogic/modifiers/upper.rb", "lib/searchlogic/modifiers/week.rb", "lib/searchlogic/modifiers/year.rb", "lib/searchlogic/search/base.rb", "lib/searchlogic/search/conditions.rb", "lib/searchlogic/search/ordering.rb", "lib/searchlogic/search/pagination.rb", "lib/searchlogic/search/protection.rb", "lib/searchlogic/search/searching.rb", "lib/searchlogic/shared/utilities.rb", "lib/searchlogic/shared/virtual_classes.rb", "lib/searchlogic/version.rb", "lib/searchlogic.rb", "README.rdoc", "TODO.rdoc"]

data/test/condition_tests/inclusive_descendant_of_test.rb

@@ -10,7 +10,7 @@ module ConditionTests
       
       condition = Searchlogic::Condition::InclusiveDescendantOf.new(User)
       condition.value = ben
-      assert_equal ["(\"users\".\"id\" = ?) OR (\"users\".\"id\" = ? OR \"users\".\"id\" = ? OR \"users\".\"id\" = ?)", ben.id, drew.id, tren.id, jennifer.id], condition.sanitize
+      assert_equal ["\"users\".\"id\" = ? OR \"users\".\"id\" = ? OR \"users\".\"id\" = ? OR \"users\".\"id\" = ?", ben.id, drew.id, tren.id, jennifer.id], condition.sanitize
     end
   end
 end

data/test/condition_tests/sibling_of_test.rb

@@ -9,7 +9,7 @@ module ConditionTests
       
       condition = Searchlogic::Condition::SiblingOf.new(User)
       condition.value = drew
-      assert_equal ["(\"users\".\"id\" != ?) AND (\"users\".\"parent_id\" = ?)", drew.id, ben.id], condition.sanitize
+      assert_equal ["\"users\".\"id\" != ? AND \"users\".\"parent_id\" = ?", drew.id, ben.id], condition.sanitize
     end
   end
 end

data/test/conditions_tests/base_test.rb

@@ -73,7 +73,7 @@ module ConditionsTests
       conditions = Searchlogic::Cache::AccountConditions.new
       conditions.name_contains = "Binary"
       conditions.or_id_gt = 5
-      assert conditions.id_gt_object.any?
+      assert conditions.id_gt_object.explicit_any?
       assert_equal ["\"accounts\".\"name\" LIKE ? OR \"accounts\".\"id\" > ?", "%Binary%", 5], conditions.sanitize
       now = Time.now
       conditions.created_at_after = now

data/test/conditions_tests/groups_test.rb

@@ -35,17 +35,20 @@ module ConditionsTests
     
     def test_group_hash
       now = Time.now
-      conditions = Searchlogic::Cache::AccountConditions.new(
-        :id_gt => 3,
-        :group => [
+      conditions = Searchlogic::Cache::AccountConditions.new([
+        {:id_gt => 3},
+        {:group => [
           {:name_like => "Binary"},
-          {
-            :id_gt => 5,
-            :group => {:created_at_after => now}
-          }
-        ]
-      )
-      assert_equal ["\"accounts\".\"id\" > ? AND (\"accounts\".\"name\" LIKE ?) AND (\"accounts\".\"id\" > ? AND (\"accounts\".\"created_at\" > ?))", 3, "%Binary%", 5, now], conditions.sanitize
+          [
+            {:id_gt => 5},
+            {:group => {
+              :id_lt => 20,
+              :created_at_after => now
+            }}
+          ]
+        ]}
+      ])
+      assert_equal ["\"accounts\".\"id\" > ? AND (\"accounts\".\"name\" LIKE ?) AND (\"accounts\".\"id\" > ? AND (\"accounts\".\"id\" < ? AND \"accounts\".\"created_at\" > ?))", 3, "%Binary%", 5, 20, now], conditions.sanitize
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: searchlogic
 version: !ruby/object:Gem::Version 
-  version: 1.5.6
+  version: 1.5.7
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-29 00:00:00 -05:00
+date: 2008-11-30 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency