searchgasm 0.9.4 → 0.9.5

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.9.5. Enhanced searching with conditions only. Updated read me to include example on adding your own conditions.
+
 v0.9.4. Cleaned up search methods, removed reset! method for base and conditions.
 
 v0.9.3. Changed structure of conditions to have their own class. Making it easier to add your own conditions.

data/Manifest

@@ -3,9 +3,9 @@ init.rb
 lib/searchgasm/active_record/associations.rb
 lib/searchgasm/active_record/base.rb
 lib/searchgasm/search/base.rb
+lib/searchgasm/search/condition.rb
 lib/searchgasm/search/condition_types/begins_with_condition.rb
 lib/searchgasm/search/condition_types/child_of_condition.rb
-lib/searchgasm/search/condition_types/condition.rb
 lib/searchgasm/search/condition_types/contains_condition.rb
 lib/searchgasm/search/condition_types/descendant_of_condition.rb
 lib/searchgasm/search/condition_types/does_not_equal_condition.rb

data/README.mdown

@@ -65,7 +65,7 @@ Now go into your console and try out any of these example with your own models.
 
 Instead of using the "all" method you could use any search method: first, find(:all), find(:first), count, sum, average, etc
 
-## Detailed Example w/ object based searching (great for form\_for for fields\_for)
+## Detailed Example w/ object based searching (great for form\_for or fields\_for)
 
     # Instantiate
     @search = User.new_search(
@@ -103,12 +103,12 @@ Take the @search object and pass it right into form\_for or fields\_for (see abo
 
 Using the object from above:
 
-    search.average('id')
-    search.count
-    search.maximum('id')
-    search.minimum('id')
-    search.sum('id')
-    search.calculate(:sum, 'id') # any of the above calculations
+    @search.average('id')
+    @search.count
+    @search.maximum('id')
+    @search.minimum('id')
+    @search.sum('id')
+    @search.calculate(:sum, 'id') # any of the above calculations
 
 Or do it from your model:
 
@@ -250,6 +250,44 @@ Some of these conditions come with aliases, so you have your choice how to call
 
 You will notice above there is "contains" and "keywords". The difference is that "keywords" is an enhanced search. It acts like a real keyword search. It finds those keywords, in any order, and blacklists meaningless words such as "and", "the", etc. "contains" finds the EXACT string in the column you are searching, spaces and all.
 
+### Roll your own conditions
+
+I didn't include this function because its MySQL specific, and it's probably rarely used, but MySQL supports a "SOUNDS LIKE" function.
+
+I want to use it, so let's add it:
+
+    # config/initializers/searchgasm.rb
+    # Actual function for MySQL databases only
+    class SoundsLikeCondition < Searchgasm::Condition
+      class << self
+        # I pass you the column, you tell me what you want the method to be called.
+        # If you don't want to add this condition for that column, return nil
+        # It defaults to "#{column.name}_sounds_like". So if thats what you want you don't even need to do this.
+        def name_for_column(column)
+          super
+        end
+        
+        # Only do this if you want aliases for your condition
+        def aliases_for_column(column)
+          ["#{column.name}_sounds", "#{column.name}_similar_to"]
+        end
+      end
+      
+      def to_conditions(value)
+        ["#{quoted_table_name}.#{quoted_column_name} SOUNDS LIKE ?", value]
+      end
+    end
+    
+    Searchgasm::Condition.register_condition(SoundsLikeCondition)
+
+Now test it out:
+
+    search = User.new_search
+    search.first_name_sounds_like = "Ben"
+    search.all  # will return any user that has a first name that sounds like "Ben"
+
+Pretty nifty, huh? You can create any condition ultimately creating any SQL you want. The sky is the limit.
+
 ## Credits
 
 Author: [Ben Johnson](http://github.com/binarylogic) of [Binary Logic](http://www.binarylogic.com)

data/lib/searchgasm/search/condition.rb

@@ -0,0 +1,105 @@
+module BinaryLogic
+  module Searchgasm
+    module Search
+      class Condition
+        include Utilities
+      
+        attr_accessor :column, :klass
+        attr_reader :value
+      
+        class << self
+          def condition_name
+            name.split("::").last.scan(/(.*)Condition/)[0][0].underscore
+          end
+          
+          def name_for_column(column)
+            "#{column.name}_#{condition_name}"
+          end
+          
+          def aliases_for_column(column)
+            []
+          end
+          
+          def name_for_klass(klass)
+            nil
+          end
+          
+          def aliases_for_klass(klass)
+            []
+          end
+          
+          def string_column?(column)
+            [:string, :text].include?(column.type)
+          end
+
+          def comparable_column?(column)
+            [:integer, :float, :decimal, :datetime, :timestamp, :time, :date].include?(column.type)
+          end
+        end
+      
+        def initialize(klass, column = nil)          
+          self.klass = klass
+          self.column = column.is_a?(String) ? klass.columns_hash[column] : column
+        end
+      
+        def explicitly_set_value=(value)
+          @explicitly_set_value = value
+        end
+      
+        # Need this if someone wants to actually use nil in a meaningful way
+        def explicitly_set_value?
+          @explicitly_set_value == true
+        end
+      
+        def ignore_blanks?
+          true
+        end
+        
+        def name
+          column ? self.class.name_for_column(column) : self.class.name_for_klass(klass)
+        end
+        
+        def condition_name
+          self.class.condition_name
+        end
+      
+        def quote_column_name(column_name)
+          klass.connection.quote_column_name(column_name)
+        end
+        
+        def quoted_column_name
+          quote_column_name(column.name)
+        end
+        
+        def quote_table_name(table_name)
+          klass.connection.quote_table_name(table_name)
+        end
+        
+        def quoted_table_name
+          quote_table_name(klass.table_name)
+        end
+        
+        def sanitize(alt_value = nil)
+          return unless explicitly_set_value?
+          v = alt_value || value
+          if v.is_a?(Array) && !["equals", "does_not_equal"].include?(condition_name)
+            merge_conditions(*v.collect { |i| sanitize(i) })
+          else
+            v = v.utc if column && [:time, :timestamp, :datetime].include?(column.type) && klass.time_zone_aware_attributes && !klass.skip_time_zone_conversion_for_attributes.include?(column.name.to_sym)
+            to_conditions(v)
+          end
+        end
+      
+        def value
+          @value.is_a?(String) ? column.type_cast(@value) : @value
+        end
+      
+        def value=(v)
+          return if ignore_blanks? && v.blank?
+          self.explicitly_set_value = true
+          @value = v
+        end
+      end
+    end
+  end
+end

data/lib/searchgasm/search/condition_types/begins_with_condition.rb

@@ -23,6 +23,4 @@ module BinaryLogic
       Conditions.register_condition(ConditionTypes::BeginsWithCondition)
     end
   end
-end
-
-BinaryLogic::Searchgasm::Search::Conditions.register_condition(BinaryLogic::Searchgasm::Search::ConditionTypes::BeginsWithCondition)
+end

data/lib/searchgasm/search/conditions.rb

@@ -8,8 +8,8 @@ module BinaryLogic
         
         class << self
           def register_condition(klass)
-            raise(ArgumentError, "You can only register conditions that extend BinaryLogic::Searchgasm::Search::ConditionTypes::Condition") unless klass.ancestors.include?(ConditionTypes::Condition)
-            conditions << klass
+            raise(ArgumentError, "You can only register conditions that extend BinaryLogic::Searchgasm::Search::ConditionTypes::Condition") unless klass.ancestors.include?(Condition)
+            conditions << klass unless conditions.include?(klass)
           end
           
           def conditions
@@ -25,6 +25,17 @@ module BinaryLogic
           self.value = init_values
         end
         
+        # Setup methods for searching
+        [:all, :average, :calculate, :count, :find, :first, :maximum, :minimum, :sum].each do |method|
+          class_eval <<-end_eval
+            def #{method}(*args)
+              self.value = args.extract_options!
+              args << {:conditions => sanitize}
+              klass.#{method}(*args)
+            end
+          end_eval
+        end
+        
         def assert_valid_values(values)
           keys = condition_names.collect { |condition_name| condition_name.to_sym }
           keys += klass.reflect_on_all_associations.collect { |association| association.name }

data/lib/searchgasm/version.rb

@@ -68,7 +68,7 @@ module BinaryLogic
 
       MAJOR = 0
       MINOR = 9
-      TINY  = 4
+      TINY  = 5
 
       # The current version as a Version instance
       CURRENT = new(MAJOR, MINOR, TINY)

data/lib/searchgasm.rb

@@ -5,11 +5,11 @@ require "searchgasm/active_record/associations"
 
 require "searchgasm/version"
 require "searchgasm/search/utilities"
+require "searchgasm/search/condition"
 require "searchgasm/search/conditions"
 require "searchgasm/search/base"
 
 # Regular conidtion types
-require "searchgasm/search/condition_types/condition"
 require "searchgasm/search/condition_types/begins_with_condition"
 require "searchgasm/search/condition_types/contains_condition"
 require "searchgasm/search/condition_types/does_not_equal_condition"

data/searchgasm.gemspec

@@ -1,11 +1,11 @@
 
-# Gem::Specification for Searchgasm-0.9.4
+# Gem::Specification for Searchgasm-0.9.5
 # Originally generated by Echoe
 
 --- !ruby/object:Gem::Specification 
 name: searchgasm
 version: !ruby/object:Gem::Version 
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic
@@ -56,9 +56,9 @@ extra_rdoc_files:
 - lib/searchgasm/active_record/associations.rb
 - lib/searchgasm/active_record/base.rb
 - lib/searchgasm/search/base.rb
+- lib/searchgasm/search/condition.rb
 - lib/searchgasm/search/condition_types/begins_with_condition.rb
 - lib/searchgasm/search/condition_types/child_of_condition.rb
-- lib/searchgasm/search/condition_types/condition.rb
 - lib/searchgasm/search/condition_types/contains_condition.rb
 - lib/searchgasm/search/condition_types/descendant_of_condition.rb
 - lib/searchgasm/search/condition_types/does_not_equal_condition.rb
@@ -83,9 +83,9 @@ files:
 - lib/searchgasm/active_record/associations.rb
 - lib/searchgasm/active_record/base.rb
 - lib/searchgasm/search/base.rb
+- lib/searchgasm/search/condition.rb
 - lib/searchgasm/search/condition_types/begins_with_condition.rb
 - lib/searchgasm/search/condition_types/child_of_condition.rb
-- lib/searchgasm/search/condition_types/condition.rb
 - lib/searchgasm/search/condition_types/contains_condition.rb
 - lib/searchgasm/search/condition_types/descendant_of_condition.rb
 - lib/searchgasm/search/condition_types/does_not_equal_condition.rb

data/test/test_searchgasm_base.rb

@@ -76,6 +76,10 @@ class TestSearchgasmBase < Test::Unit::TestCase
     
     search.conditions = {:name_like => "Binary"}
     assert_kind_of BinaryLogic::Searchgasm::Search::Conditions, search.conditions
+    
+    conditions = BinaryLogic::Searchgasm::Search::Conditions.new(Account, :id_greater_than => 8)
+    search.conditions = conditions
+    assert_equal conditions, search.conditions
   end
   
   def test_include

data/test/test_searchgasm_conditions.rb

@@ -140,6 +140,22 @@ class TestSearchgasmConditions < Test::Unit::TestCase
     assert_equal scope2, conditions.scope
   end
   
+  def test_searching
+    conditions = BinaryLogic::Searchgasm::Search::Conditions.new(Account)
+    conditions.name_contains = "Binary"
+    assert_equal Account.find(1, 3), conditions.all
+    assert_equal Account.find(1, 3), conditions.find(:all)
+    assert_equal Account.find(1), conditions.first
+    assert_equal Account.find(1), conditions.find(:first)
+    assert_equal 2, conditions.average('id')
+    assert_equal 2, conditions.calculate(:avg, 'id')
+    assert_equal 3, conditions.calculate(:max, 'id')
+    assert_equal 2, conditions.count
+    assert_equal 3, conditions.maximum('id')
+    assert_equal 1, conditions.minimum('id')
+    assert_equal 4, conditions.sum('id')
+  end
+  
   def test_protection
     assert_raise(ArgumentError) { Account.new_conditions("(DELETE FROM users)") }
     assert_nothing_raised { Account.build_conditions!("(DELETE FROM users)") }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: searchgasm
 version: !ruby/object:Gem::Version 
-  version: 0.9.4
+  version: 0.9.5
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic
@@ -53,9 +53,9 @@ extra_rdoc_files:
 - lib/searchgasm/active_record/associations.rb
 - lib/searchgasm/active_record/base.rb
 - lib/searchgasm/search/base.rb
+- lib/searchgasm/search/condition.rb
 - lib/searchgasm/search/condition_types/begins_with_condition.rb
 - lib/searchgasm/search/condition_types/child_of_condition.rb
-- lib/searchgasm/search/condition_types/condition.rb
 - lib/searchgasm/search/condition_types/contains_condition.rb
 - lib/searchgasm/search/condition_types/descendant_of_condition.rb
 - lib/searchgasm/search/condition_types/does_not_equal_condition.rb
@@ -80,9 +80,9 @@ files:
 - lib/searchgasm/active_record/associations.rb
 - lib/searchgasm/active_record/base.rb
 - lib/searchgasm/search/base.rb
+- lib/searchgasm/search/condition.rb
 - lib/searchgasm/search/condition_types/begins_with_condition.rb
 - lib/searchgasm/search/condition_types/child_of_condition.rb
-- lib/searchgasm/search/condition_types/condition.rb
 - lib/searchgasm/search/condition_types/contains_condition.rb
 - lib/searchgasm/search/condition_types/descendant_of_condition.rb
 - lib/searchgasm/search/condition_types/does_not_equal_condition.rb

data/lib/searchgasm/search/condition_types/condition.rb

@@ -1,107 +0,0 @@
-module BinaryLogic
-  module Searchgasm
-    module Search
-      module ConditionTypes
-        class Condition
-          include Utilities
-        
-          attr_accessor :column, :klass
-          attr_reader :value
-        
-          class << self
-            def condition_name
-              name.split("::").last.scan(/(.*)Condition/)[0][0].underscore
-            end
-            
-            def name_for_column(column)
-              "#{column.name}_#{condition_name}"
-            end
-            
-            def aliases_for_column(column)
-              []
-            end
-            
-            def name_for_klass(klass)
-              nil
-            end
-            
-            def aliases_for_klass(klass)
-              []
-            end
-            
-            def string_column?(column)
-              [:string, :text].include?(column.type)
-            end
-
-            def comparable_column?(column)
-              [:integer, :float, :decimal, :datetime, :timestamp, :time, :date].include?(column.type)
-            end
-          end
-        
-          def initialize(klass, column = nil)          
-            self.klass = klass
-            self.column = column.is_a?(String) ? klass.columns_hash[column] : column
-          end
-        
-          def explicitly_set_value=(value)
-            @explicitly_set_value = value
-          end
-        
-          # Need this if someone wants to actually use nil in a meaningful way
-          def explicitly_set_value?
-            @explicitly_set_value == true
-          end
-        
-          def ignore_blanks?
-            true
-          end
-          
-          def name
-            column ? self.class.name_for_column(column) : self.class.name_for_klass(klass)
-          end
-          
-          def condition_name
-            self.class.condition_name
-          end
-        
-          def quote_column_name(column_name)
-            klass.connection.quote_column_name(column_name)
-          end
-          
-          def quoted_column_name
-            quote_column_name(column.name)
-          end
-          
-          def quote_table_name(table_name)
-            klass.connection.quote_table_name(table_name)
-          end
-          
-          def quoted_table_name
-            quote_table_name(klass.table_name)
-          end
-          
-          def sanitize(alt_value = nil)
-            return unless explicitly_set_value?
-            v = alt_value || value
-            if v.is_a?(Array) && !["equals", "does_not_equal"].include?(condition_name)
-              merge_conditions(*v.collect { |i| sanitize(i) })
-            else
-              v = v.utc if column && [:time, :timestamp, :datetime].include?(column.type) && klass.time_zone_aware_attributes && !klass.skip_time_zone_conversion_for_attributes.include?(column.name.to_sym)
-              to_conditions(v)
-            end
-          end
-        
-          def value
-            @value.is_a?(String) ? column.type_cast(@value) : @value
-          end
-        
-          def value=(v)
-            return if ignore_blanks? && v.blank?
-            self.explicitly_set_value = true
-            @value = v
-          end
-        end
-      end
-    end
-  end
-end