searchgasm 1.1.0 → 1.1.1

data/CHANGELOG.rdoc

@@ -1,3 +1,11 @@
+== 1.1.1 released 2008-09-19
+
+* Fixed typo in "next page" button.
+* Updated valid options for searching and performing calculations, fixed some bugs when searching and performing calculations with advanced options.
+* Fixed bug in ordering where table name was assumed by the hash. Now assumed by the reflection.
+* Added default for per_page, so pagination comes implemented by default
+* On mass assignments blank strings for *any* conditions are ignored. Sometimes blank strings are meaningful for "equals" and "does not equal", those only takes effect if you explicitly call these conditions: search.conditions.name = "". User.new_search(:conditions => {:name => ""}) will be ignored. Also, Searchgasm should never change how ActiveRecord behaves by default. So User.all(:conditions => {:name => ""}) will NOT be ignored.
+
 == 1.1.0 released 2008-09-18
 
 * Added the options :inner_spread and :outer_spread to the page_links helper. Also added various config options for setting page_links defaults.

data/lib/searchgasm/active_record/associations.rb

@@ -8,7 +8,7 @@ module Searchgasm
         # This needs to be implemented because AR doesn't leverage scopes with this method like it probably should
         def find_with_searchgasm(*args)
           options = args.extract_options!
-          args << sanitize_options_with_searchgasm(options)
+          args << filter_options_with_searchgasm(options)
           find_without_searchgasm(*args)
         end
       
@@ -36,7 +36,7 @@ module Searchgasm
       module Shared
         def count_with_searchgasm(*args)
           options = args.extract_options!
-          args << sanitize_options_with_searchgasm(options)
+          args << filter_options_with_searchgasm(options)
           count_without_searchgasm(*args)
         end
       end

data/lib/searchgasm/active_record/base.rb

@@ -6,21 +6,15 @@ module Searchgasm
       # This is an alias method chain. It hook into ActiveRecord's "calculate" method and checks to see if Searchgasm should get involved.
       def calculate_with_searchgasm(*args)
         options = args.extract_options!
-        options = sanitize_options_with_searchgasm(options)
+        options = filter_options_with_searchgasm(options)
         args << options
         calculate_without_searchgasm(*args)
       end
       
-      def total(*args)
-        options = args.extract_options!
-        searcher = searchgasm_searcher(options)
-        searcher.total
-      end
-      
       # This is an alias method chain. It hooks into ActiveRecord's "find" method and checks to see if Searchgasm should get involved.
       def find_with_searchgasm(*args)
         options = args.extract_options!
-        options = sanitize_options_with_searchgasm(options)
+        options = filter_options_with_searchgasm(options)
         args << options
         find_without_searchgasm(*args)
       end
@@ -45,7 +39,7 @@ module Searchgasm
       #     build_search
       #   end
       def with_scope_with_searchgasm(method_scoping = {}, action = :merge, &block)
-        method_scoping[:find] = sanitize_options_with_searchgasm(method_scoping[:find]) if method_scoping[:find]
+        method_scoping[:find] = filter_options_with_searchgasm(method_scoping[:find]) if method_scoping[:find]
         with_scope_without_searchgasm(method_scoping, action, &block)
       end
       
@@ -130,10 +124,19 @@ module Searchgasm
       end
     
       private
-        def sanitize_options_with_searchgasm(options = {})
+        def filter_options_with_searchgasm(options = {})
           return options unless Searchgasm::Search::Base.needed?(self, options)
           search = Searchgasm::Search::Base.create_virtual_class(self).new # call explicitly to avoid merging the scopes into the searcher
           search.acting_as_filter = true
+          conditions = options.delete(:conditions) || options.delete("conditions") || {}
+          if conditions
+            case conditions
+            when Hash
+              conditions.each { |condition, value| search.conditions.send("#{condition}=", value) } # explicitly call to enforce blanks
+            else
+              search.conditions = conditions
+            end
+          end
           search.options = options
           search.sanitize
         end
@@ -181,8 +184,12 @@ module ActiveRecord #:nodoc: all
       alias_method :new_search!, :build_search!
       
       def valid_find_options
-         VALID_FIND_OPTIONS
-       end
+        VALID_FIND_OPTIONS
+      end
+      
+      def valid_calculations_options
+        Calculations::CALCULATIONS_OPTIONS
+      end
     end
   end
 end

data/lib/searchgasm/conditions/base.rb

@@ -135,7 +135,10 @@ module Searchgasm
         case conditions
         when Hash
           assert_valid_conditions(conditions)
-          remove_conditions_from_protected_assignement(conditions).each { |condition, value| send("#{condition}=", value) }
+          remove_conditions_from_protected_assignement(conditions).each do |condition, value|
+            next if value.blank? # ignore blanks on mass assignments
+            send("#{condition}=", value)
+          end
         else
           self.sql = conditions
         end

data/lib/searchgasm/config.rb

@@ -92,12 +92,12 @@ module Searchgasm
       end
       
       def page_links_next # :nodoc:
-        @page_links_next ||= "< Next"
+        @page_links_next ||= "Next >"
       end
       
       # The default for the :next option for the page_links helper.
       #
-      # * <tt>Default:</tt> "< Next"
+      # * <tt>Default:</tt> "Next >"
       # * <tt>Accepts:</tt> Anything you want, text, html, etc. nil to disable
       def page_links_next=(value)
         @page_links_next = value
@@ -116,14 +116,14 @@ module Searchgasm
       end
       
       def per_page # :nodoc:
-        @per_page
+        @per_page ||= per_page_choices[2]
       end
       
       # The default for per page. This is only applicaple for protected searches. Meaning you start the search with new_search or new_conditions.
       # The reason for this not to disturb regular queries such as Whatever.find(:all). You would not expect that to be limited.
       #
-      # * <tt>Default:</tt> nil, nil means "show all"
-      # * <tt>Accepts:</tt> Any value in your per_page choices
+      # * <tt>Default:</tt> The 3rd option in your per_page_choices, default of 50
+      # * <tt>Accepts:</tt> Any value in your per_page choices, nil means "show all"
       def per_page=(value)
         @per_page = value
       end

data/lib/searchgasm/search/base.rb

@@ -9,13 +9,21 @@ module Searchgasm #:nodoc:
       include Searchgasm::Shared::Searching
       include Searchgasm::Shared::VirtualClasses
       
+      # Options ActiveRecord allows when searching
+      AR_FIND_OPTIONS = ::ActiveRecord::Base.valid_find_options
+      
+      # Options ActiveRecord allows when performing calculations
+      AR_CALCULATIONS_OPTIONS = ::ActiveRecord::Base.valid_calculations_options
+      
+      AR_OPTIONS = (AR_FIND_OPTIONS + AR_CALCULATIONS_OPTIONS).uniq
+      
       # Options that ActiveRecord doesn't suppport, but Searchgasm does
       SPECIAL_FIND_OPTIONS = [:order_by, :order_as, :page, :per_page]
       
       # Valid options you can use when searching
-      VALID_FIND_OPTIONS = SPECIAL_FIND_OPTIONS + ::ActiveRecord::Base.valid_find_options # the order is very important, these options get set in this order
+      OPTIONS = SPECIAL_FIND_OPTIONS + AR_OPTIONS # the order is very important, these options get set in this order
       
-      attr_accessor *::ActiveRecord::Base.valid_find_options
+      attr_accessor *AR_OPTIONS
       
       class << self
         # Used in the ActiveRecord methods to determine if Searchgasm should get involved or not.
@@ -47,7 +55,7 @@ module Searchgasm #:nodoc:
       # Makes using searchgasm in the console less annoying and keeps the output meaningful and useful
       def inspect
         current_find_options = {}
-        ::ActiveRecord::Base.valid_find_options.each do |option|
+        AR_OPTIONS.each do |option|
           value = send(option)
           next if value.nil?
           current_find_options[option] = value
@@ -72,10 +80,9 @@ module Searchgasm #:nodoc:
       
       def options=(values)
         return unless values.is_a?(Hash)
-        values.symbolize_keys.fast_assert_valid_keys(VALID_FIND_OPTIONS)
+        values.symbolize_keys.fast_assert_valid_keys(OPTIONS)
         
-        # Do the special options first, and then the core options last, since the core options take precendence
-        VALID_FIND_OPTIONS.each do |option|
+        OPTIONS.each do |option|
           next unless values.has_key?(option)
           send("#{option}=", values[option])
         end
@@ -84,9 +91,9 @@ module Searchgasm #:nodoc:
       end
       
       # Sanitizes everything down into options ActiveRecord::Base.find can understand
-      def sanitize
+      def sanitize(searching = true)
         find_options = {}
-        ::ActiveRecord::Base.valid_find_options.each do |find_option|
+        (searching ? AR_FIND_OPTIONS : AR_CALCULATIONS_OPTIONS).each do |find_option|
           value = send(find_option)
           next if value.blank?
           find_options[find_option] = value

data/lib/searchgasm/search/conditions.rb

@@ -51,8 +51,8 @@ module Searchgasm
         includes.blank? ? nil : (includes.size == 1 ? includes.first : includes)
       end
       
-      def sanitize_with_conditions # :nodoc:
-        find_options = sanitize_without_conditions
+      def sanitize_with_conditions(searching = true) # :nodoc:
+        find_options = sanitize_without_conditions(searching)
         if conditions_obj = find_options.delete(:conditions)
           new_conditions = conditions_obj.sanitize
           find_options[:conditions] = new_conditions unless new_conditions.blank?

data/lib/searchgasm/search/ordering.rb

@@ -115,7 +115,8 @@ module Searchgasm
       
       private
         def order_by_to_order(order_by, order_as, alt_klass = nil, new_includes = [])
-          table_name = (alt_klass || klass).table_name
+          k = alt_klass || klass
+          table_name = k.table_name
           sql_parts = []
           
           case order_by
@@ -123,10 +124,11 @@ module Searchgasm
             order_by.each { |part| sql_parts << order_by_to_order(part, order_as) }
           when Hash
             raise(ArgumentError, "when passing a hash to order_by you must only have 1 key: {:user_group => :name} not {:user_group => :name, :user_group => :id}. The latter should be [{:user_group => :name}, {:user_group => :id}]") if order_by.keys.size != 1
-            k = order_by.keys.first
-            v = order_by.values.first
-            new_includes << k.to_sym
-            sql_parts << order_by_to_order(v, order_as, eval(k.to_s.classify), new_includes) # using eval, better performance, protection makes sure nothing fishy goes on here
+            key = order_by.keys.first
+            reflection = k.reflect_on_association(key.to_sym)
+            value = order_by.values.first
+            new_includes << key.to_sym
+            sql_parts << order_by_to_order(value, order_as, reflection.klass, new_includes) # using eval, better performance, protection makes sure nothing fishy goes on here
           when Symbol, String
             new_include = build_order_by_includes(new_includes)
             self.order_by_includes << new_include if new_include

data/lib/searchgasm/search/protection.rb

@@ -24,8 +24,12 @@ module Searchgasm
       # Options that are allowed when protecting against SQL injections (still checked though)
       SAFE_OPTIONS = Base::SPECIAL_FIND_OPTIONS + [:conditions, :limit, :offset]
       
+      VULNERABLE_FIND_OPTIONS = Base::AR_FIND_OPTIONS - SAFE_OPTIONS
+      
+      VULNERABLE_CALCULATIONS_OPTIONS = Base::AR_CALCULATIONS_OPTIONS - SAFE_OPTIONS
+      
       # Options that are not allowed, at all, when protecting against SQL injections
-      VULNERABLE_OPTIONS = Base::VALID_FIND_OPTIONS - SAFE_OPTIONS
+      VULNERABLE_OPTIONS = Base::OPTIONS - SAFE_OPTIONS
       
       def self.included(klass)
         klass.class_eval do
@@ -59,12 +63,13 @@ module Searchgasm
           
           k = alt_klass || klass
           column_names = k.column_names
-          
+                    
           [order_by].flatten.each do |column|
             case column
             when Hash
-              return false unless k.reflect_on_association(column.keys.first.to_sym)
-              return false unless order_by_safe?(column.values.first, column.keys.first.to_s.classify.constantize)
+              reflection = k.reflect_on_association(column.keys.first.to_sym)
+              return false unless reflection
+              return false unless order_by_safe?(column.values.first, reflection.klass)
             when Array
               return false unless order_by_safe?(column)
             else

data/lib/searchgasm/shared/searching.rb

@@ -21,17 +21,15 @@ module Searchgasm
           end
         end_eval
       end
-      
+
       # Setup methods for calculating
       CALCULATION_METHODS.each do |method|
         class_eval <<-"end_eval", __FILE__, __LINE__
           def #{method}(*args)
             options = args.extract_options!
             klass.send(:with_scope, :find => options) do
-              find_options = (self.class < Searchgasm::Conditions::Base ? {:conditions => sanitize} : sanitize)
-              find_options.delete(:select)
-              find_options.delete(:limit)
-              find_options.delete(:offset)
+              find_options = (self.class < Searchgasm::Conditions::Base ? {:conditions => sanitize} : sanitize(false))
+              [:select, :limit, :offset].each { |option| find_options.delete(option) }
               args << find_options
               klass.#{method}(*args)
             end

data/lib/searchgasm/version.rb

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

data/searchgasm.gemspec

@@ -1,18 +1,18 @@
 
-# Gem::Specification for Searchgasm-1.1.0
+# Gem::Specification for Searchgasm-1.1.1
 # Originally generated by Echoe
 
 --- !ruby/object:Gem::Specification 
 name: searchgasm
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic
 autorequire: 
 bindir: bin
 
-date: 2008-09-18 00:00:00 -04:00
+date: 2008-09-19 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 

data/test/test_active_record_base.rb

@@ -28,8 +28,9 @@ class TestActiveRecordBase < Test::Unit::TestCase
     assert_nothing_raised { Account.sum("id", {}) }
   end
   
-  def test_valid_find_options
+  def test_ar_options
     assert_equal [ :conditions, :include, :joins, :limit, :offset, :order, :select, :readonly, :group, :from, :lock ], ActiveRecord::Base.valid_find_options
+    assert_equal [:conditions, :joins, :order, :select, :group, :having, :distinct, :limit, :offset, :include, :from], ActiveRecord::Base.valid_calculations_options
   end
   
   def test_build_search

data/test/test_conditions_base.rb

@@ -185,4 +185,13 @@ class TestConditionsBase < Test::Unit::TestCase
     conditions.any = false
     assert_equal [Account.find(1)], conditions.all
   end
+  
+  def test_ignoring_blanks
+    conditions = Account.new_conditions(:name => "", :created_after => nil)
+    assert_equal({}, conditions.conditions)
+    conditions.name = ""
+    assert_equal({:name_equals => ""}, conditions.conditions)
+    conditions.created_after = ""
+    assert_equal({:name_equals => ""}, conditions.conditions)
+  end
 end

data/test/test_conditions_protection.rb

@@ -20,5 +20,8 @@ class TestConditionsProtection < Test::Unit::TestCase
     
     assert_raise(ArgumentError) { account.users.build_conditions("(DELETE FROM users)") }
     assert_nothing_raised { account.users.build_conditions!("(DELETE FROM users)") }
+    
+    #search = Account.new_search
+    #assert_nothing_raised { search.conditions = "(DELETE FROM users)" }
   end
 end

data/test/test_helper.rb

@@ -9,6 +9,7 @@ require File.dirname(__FILE__) + '/../lib/searchgasm'
 ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
 
 class Account < ActiveRecord::Base
+  has_one :admin, :class_name => "User", :conditions => {:first_name => "Ben"}
   has_many :users, :dependent => :destroy
   has_many :orders, :through => :users
 end
@@ -17,6 +18,7 @@ class User < ActiveRecord::Base
   acts_as_tree
   belongs_to :account
   has_many :orders, :dependent => :destroy
+  has_one :cool_order, :class_name => "Order", :conditions => {:total => 100}
 end
 
 class Order < ActiveRecord::Base

data/test/test_search_base.rb

@@ -39,7 +39,19 @@ class TestSearchBase < Test::Unit::TestCase
   end
 
   def test_setting_first_level_options
-    search = Account.new_search
+    search = Account.new_search!(:include => :users, :joins => :test, :offset => 5, :limit => 20, :order => "name ASC", :select => "name", :readonly => true, :group => "name", :from => "accounts", :lock => true)
+    assert_equal :users, search.include
+    assert_equal :test, search.joins
+    assert_equal 5, search.offset
+    assert_equal 20, search.limit
+    assert_equal "name ASC", search.order
+    assert_equal "name", search.select
+    assert_equal true, search.readonly
+    assert_equal "name", search.group
+    assert_equal "accounts", search.from
+    assert_equal true, search.lock
+    
+    search = Account.new_search(:per_page => nil)
   
     search.include = :users
     assert_equal :users, search.include
@@ -190,6 +202,9 @@ class TestSearchBase < Test::Unit::TestCase
     assert_equal 3, search.maximum('id')
     assert_equal 1, search.minimum('id')
     assert_equal 4, search.sum('id')
+    
+    search.readonly = true
+    assert_equal 4, search.sum('id')
   end
   
   def test_method_creation_in_scope

data/test/test_search_pagination.rb

@@ -29,7 +29,7 @@ class TestSearchPagination < Test::Unit::TestCase
   end
   
   def test_page
-    search = Account.new_search
+    search = Account.new_search(:per_page => nil)
     search.page = 2
     assert_equal 1, search.page
     search.per_page = 20

data/test/test_search_protection.rb

@@ -14,18 +14,18 @@ class TestSearchProtection < Test::Unit::TestCase
 
   def test_protection
     assert_raise(ArgumentError) { Account.build_search(:conditions => "(DELETE FROM users)", :page => 2, :per_page => 15) }
-    Searchgasm::Search::Base::VULNERABLE_OPTIONS.each { |option| assert_raise(ArgumentError) { Account.build_search(option => "(DELETE FROM users)") } }
+    Searchgasm::Search::Base::VULNERABLE_FIND_OPTIONS.each { |option| assert_raise(ArgumentError) { Account.build_search(option => "(DELETE FROM users)") } }
   
     assert_nothing_raised { Account.build_search!(:conditions => "(DELETE FROM users)", :page => 2, :per_page => 15) }
-    Searchgasm::Search::Base::VULNERABLE_OPTIONS.each { |option| assert_nothing_raised { Account.build_search!(option => "(DELETE FROM users)") } }
+    Searchgasm::Search::Base::VULNERABLE_FIND_OPTIONS.each { |option| assert_nothing_raised { Account.build_search!(option => "(DELETE FROM users)") } }
   
     account = Account.first
   
     assert_raise(ArgumentError) { account.users.build_search(:conditions => "(DELETE FROM users)", :page => 2, :per_page => 15) }
-    Searchgasm::Search::Base::VULNERABLE_OPTIONS.each { |option| assert_raise(ArgumentError) { account.users.build_search(option => "(DELETE FROM users)") } }
+    Searchgasm::Search::Base::VULNERABLE_FIND_OPTIONS.each { |option| assert_raise(ArgumentError) { account.users.build_search(option => "(DELETE FROM users)") } }
   
     assert_nothing_raised { account.users.build_search!(:conditions => "(DELETE FROM users)", :page => 2, :per_page => 15) }
-    Searchgasm::Search::Base::VULNERABLE_OPTIONS.each { |option| assert_nothing_raised { account.users.build_search!(option => "(DELETE FROM users)") } }
+    Searchgasm::Search::Base::VULNERABLE_FIND_OPTIONS.each { |option| assert_nothing_raised { account.users.build_search!(option => "(DELETE FROM users)") } }
   
     assert_raise(ArgumentError) { Account.build_search(:order_by => "unknown_column") }
     assert_nothing_raised { Account.build_search!(:order_by => "unknown_column") }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: searchgasm
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-18 00:00:00 -04:00
+date: 2008-09-19 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency