searchgasm 1.3.4 → 1.3.5

data/CHANGELOG.rdoc

@@ -1,4 +1,8 @@
-== 1.3.4 released 2008-10-03
+== 1.3.5 released 2008-10-08
+
+* Since joins are now strings, AR doesn't know how to merge them properly. So searchgasm now checks which joins to skip over to avoid conflicts.
+
+== 1.3.4 released 2008-10-07
 
 * Fixed method names creation for conditions with modifiers
 * Create local column conditions, incase there are method conflicts. Such as "id".

data/lib/searchgasm/active_record/base.rb

@@ -108,6 +108,7 @@ module Searchgasm
           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 search
           search.acting_as_filter = true
+          search.scope = scope(:find)
           conditions = options.delete(:conditions) || options.delete("conditions") || {}
           if conditions
             case conditions
@@ -120,7 +121,7 @@ module Searchgasm
           search.options = options
           search.sanitize(searching)
         end
-      
+        
         def searchgasm_search(options = {})
           scope = {}
           current_scope = scope(:find) && scope(:find).deep_dup

data/lib/searchgasm/helpers/control_types/link.rb

@@ -78,10 +78,10 @@ module Searchgasm
         # * <tt>:html</tt> -- html arrtributes for the <a> tag.
         #
         # === Advanced Options
-        # * <tt>:params_scope</tt> -- default: :search, this is the scope in which your search params will be preserved (params[:search]). If you don't want a scope and want your options to be at base leve in params such as params[:page], params[:per_page], etc, then set this to nil.
+        # * <tt>:params_scope</tt> -- default: :search, this is the scope in which your search params will be preserved (params[:search]). If you don't want a scope and want your options to be at base level in params such as params[:page], params[:per_page], etc, then set this to nil.
         # * <tt>:search_obj</tt> -- default: @#{params_scope}, this is your search object, everything revolves around this. It will try to infer the name from your params_scope. If your params_scope is :search it will try to get @search, etc. If it can not be inferred by this, you need to pass the object itself.
         # * <tt>:params</tt> -- default: nil, Additional params to add to the url, must be a hash
-        # * <tt>:exclude_params</tt> -- default: nil, params you want to exclude. This is nifty because it does a "deep delete". So you can pass {:param1 => {:param2 => :param3}} and it will make sure param3 does not get include. param1 and param2 will not be touched. This also accepts an array or just a symbol or string.
+        # * <tt>:exclude_params</tt> -- default: nil, params you want to exclude. This is nifty because it does a "deep delete". So you can pass {:param1 => {:param2 => :param3}} and it will make sure param3 does not get included. param1 and param2 will not be touched. This also accepts an array or just a symbol or string.
         # * <tt>:search_params</tt> -- default: nil, Additional search params to add to the url, must be a hash. Adds the options into the :params_scope.
         # * <tt>:exclude_search_params</tt> -- default: nil, Same as :exclude_params but for the :search_params.
         def order_by_link(order_by, options = {})
@@ -97,7 +97,7 @@ module Searchgasm
           html
         end
         
-        # Creates a link for ascending or descending data, pretty self e
+        # Creates a link for ascending or descending data.
         #
         # === Example uses
         #
@@ -110,10 +110,10 @@ module Searchgasm
         # * <tt>:html</tt> -- html arrtributes for the <a> tag.
         #
         # === Advanced Options
-        # * <tt>:params_scope</tt> -- default: :search, this is the scope in which your search params will be preserved (params[:search]). If you don't want a scope and want your options to be at base leve in params such as params[:page], params[:per_page], etc, then set this to nil.
+        # * <tt>:params_scope</tt> -- default: :search, this is the scope in which your search params will be preserved (params[:search]). If you don't want a scope and want your options to be at base level in params such as params[:page], params[:per_page], etc, then set this to nil.
         # * <tt>:search_obj</tt> -- default: @#{params_scope}, this is your search object, everything revolves around this. It will try to infer the name from your params_scope. If your params_scope is :search it will try to get @search, etc. If it can not be inferred by this, you need to pass the object itself.
         # * <tt>:params</tt> -- default: nil, Additional params to add to the url, must be a hash
-        # * <tt>:exclude_params</tt> -- default: nil, params you want to exclude. This is nifty because it does a "deep delete". So you can pass {:param1 => {:param2 => :param3}} and it will make sure param3 does not get include. param1 and param2 will not be touched. This also accepts an array or just a symbol or string.
+        # * <tt>:exclude_params</tt> -- default: nil, params you want to exclude. This is nifty because it does a "deep delete". So you can pass {:param1 => {:param2 => :param3}} and it will make sure param3 does not get included. param1 and param2 will not be touched. This also accepts an array or just a symbol or string.
         # * <tt>:search_params</tt> -- default: nil, Additional search params to add to the url, must be a hash. Adds the options into the :params_scope.
         # * <tt>:exclude_search_params</tt> -- default: nil, Same as :exclude_params but for the :search_params.
         def order_as_link(order_as, options = {})
@@ -151,10 +151,10 @@ module Searchgasm
         # * <tt>:html</tt> -- html arrtributes for the <a> tag.
         #
         # === Advanced Options
-        # * <tt>:params_scope</tt> -- default: :search, this is the scope in which your search params will be preserved (params[:search]). If you don't want a scope and want your options to be at base leve in params such as params[:page], params[:per_page], etc, then set this to nil.
+        # * <tt>:params_scope</tt> -- default: :search, this is the scope in which your search params will be preserved (params[:search]). If you don't want a scope and want your options to be at base level in params such as params[:page], params[:per_page], etc, then set this to nil.
         # * <tt>:search_obj</tt> -- default: @#{params_scope}, this is your search object, everything revolves around this. It will try to infer the name from your params_scope. If your params_scope is :search it will try to get @search, etc. If it can not be inferred by this, you need to pass the object itself.
         # * <tt>:params</tt> -- default: nil, Additional params to add to the url, must be a hash
-        # * <tt>:exclude_params</tt> -- default: nil, params you want to exclude. This is nifty because it does a "deep delete". So you can pass {:param1 => {:param2 => :param3}} and it will make sure param3 does not get include. param1 and param2 will not be touched. This also accepts an array or just a symbol or string.
+        # * <tt>:exclude_params</tt> -- default: nil, params you want to exclude. This is nifty because it does a "deep delete". So you can pass {:param1 => {:param2 => :param3}} and it will make sure param3 does not get included. param1 and param2 will not be touched. This also accepts an array or just a symbol or string.
         # * <tt>:search_params</tt> -- default: nil, Additional search params to add to the url, must be a hash. Adds the options into the :params_scope.
         # * <tt>:exclude_search_params</tt> -- default: nil, Same as :exclude_params but for the :search_params.
         def priority_order_by_link(priority_order_by, priority_order_as, options = {})
@@ -185,10 +185,10 @@ module Searchgasm
         # * <tt>:html</tt> -- html arrtributes for the <a> tag.
         #
         # === Advanced Options
-        # * <tt>:params_scope</tt> -- default: :search, this is the scope in which your search params will be preserved (params[:search]). If you don't want a scope and want your options to be at base leve in params such as params[:page], params[:per_page], etc, then set this to nil.
+        # * <tt>:params_scope</tt> -- default: :search, this is the scope in which your search params will be preserved (params[:search]). If you don't want a scope and want your options to be at base level in params such as params[:page], params[:per_page], etc, then set this to nil.
         # * <tt>:search_obj</tt> -- default: @#{params_scope}, this is your search object, everything revolves around this. It will try to infer the name from your params_scope. If your params_scope is :search it will try to get @search, etc. If it can not be inferred by this, you need to pass the object itself.
         # * <tt>:params</tt> -- default: nil, Additional params to add to the url, must be a hash
-        # * <tt>:exclude_params</tt> -- default: nil, params you want to exclude. This is nifty because it does a "deep delete". So you can pass {:param1 => {:param2 => :param3}} and it will make sure param3 does not get include. param1 and param2 will not be touched. This also accepts an array or just a symbol or string.
+        # * <tt>:exclude_params</tt> -- default: nil, params you want to exclude. This is nifty because it does a "deep delete". So you can pass {:param1 => {:param2 => :param3}} and it will make sure param3 does not get included. param1 and param2 will not be touched. This also accepts an array or just a symbol or string.
         # * <tt>:search_params</tt> -- default: nil, Additional search params to add to the url, must be a hash. Adds the options into the :params_scope.
         # * <tt>:exclude_search_params</tt> -- default: nil, Same as :exclude_params but for the :search_params.
         def per_page_link(per_page, options = {})
@@ -217,10 +217,10 @@ module Searchgasm
         # * <tt>:html</tt> -- html arrtributes for the <a> tag.
         #
         # === Advanced Options
-        # * <tt>:params_scope</tt> -- default: :search, this is the scope in which your search params will be preserved (params[:search]). If you don't want a scope and want your options to be at base leve in params such as params[:page], params[:per_page], etc, then set this to nil.
+        # * <tt>:params_scope</tt> -- default: :search, this is the scope in which your search params will be preserved (params[:search]). If you don't want a scope and want your options to be at base level in params such as params[:page], params[:per_page], etc, then set this to nil.
         # * <tt>:search_obj</tt> -- default: @#{params_scope}, this is your search object, everything revolves around this. It will try to infer the name from your params_scope. If your params_scope is :search it will try to get @search, etc. If it can not be inferred by this, you need to pass the object itself.
         # * <tt>:params</tt> -- default: nil, Additional params to add to the url, must be a hash
-        # * <tt>:exclude_params</tt> -- default: nil, params you want to exclude. This is nifty because it does a "deep delete". So you can pass {:param1 => {:param2 => :param3}} and it will make sure param3 does not get include. param1 and param2 will not be touched. This also accepts an array or just a symbol or string.
+        # * <tt>:exclude_params</tt> -- default: nil, params you want to exclude. This is nifty because it does a "deep delete". So you can pass {:param1 => {:param2 => :param3}} and it will make sure param3 does not get included. param1 and param2 will not be touched. This also accepts an array or just a symbol or string.
         # * <tt>:search_params</tt> -- default: nil, Additional search params to add to the url, must be a hash. Adds the options into the :params_scope.
         # * <tt>:exclude_search_params</tt> -- default: nil, Same as :exclude_params but for the :search_params.
         def page_link(page, options = {})

data/lib/searchgasm/search/base.rb

@@ -43,7 +43,7 @@ module Searchgasm #:nodoc:
       end
       
       # Flag to determine if searchgasm is acting as a filter for the ActiveRecord search methods.
-      # The purpose of this is to determine if Config.per_page should be implemented.
+      # By filter it means that searchgasm is being used on the default ActiveRecord search methods, like all, count, find(:all), first, etc.
       def acting_as_filter=(value)
         @acting_as_filter = value
       end
@@ -79,7 +79,8 @@ module Searchgasm #:nodoc:
         "#<#{klass}Search #{current_find_options.inspect}>"
       end
       
-      # Searchgasm requires that all joins be left outer joins for conditions and ordering to work properly
+      # The method is unique in the fact that if searchgasm is acting_as_filter? then auto joins are not included. Searchgasm should not change the default ActiveRecord behavior.
+      # If you are running a search via new_search or build_search then auto joins are included.
       def joins
         joins_sql = ""
         all_joins = auto_joins
@@ -92,14 +93,33 @@ module Searchgasm #:nodoc:
         end
         
         return if joins_sql.blank? && all_joins.blank?
+        return joins_sql if all_joins.blank?
         
-        unless all_joins.blank?
-          join_dependency = ::ActiveRecord::Associations::ClassMethods::JoinDependency.new(klass, all_joins, nil)
-          joins_sql += " " unless joins_sql.blank?
-          joins_sql += join_dependency.join_associations.collect { |assoc| assoc.association_join }.join
+        # convert scopes joins to sql, so we can determine which joins to skip
+        scope_joins_sql = nil
+        if scope && !scope[:joins].blank?
+          case scope[:joins]
+          when String
+            scope_joins_sql = scope[:joins]
+          else
+            join_dependency = ::ActiveRecord::Associations::ClassMethods::JoinDependency.new(klass, scope[:joins], nil)
+            scope_joins_sql = join_dependency.join_associations.collect { |assoc| assoc.association_join }.join
+          end
+        end
+
+        join_dependency = ::ActiveRecord::Associations::ClassMethods::JoinDependency.new(klass, all_joins, nil)
+        safe_joins = []
+        join_dependency.join_associations.each do |assoc|
+          join_sql = assoc.association_join
+          
+          #debugger if scope && scope[:joins].include?("LEFT OUTER JOIN \"users\"")
+          safe_joins << join_sql if scope_joins_sql.blank? || !scope_joins_sql.include?(join_sql.gsub(/(LEFT OUTER JOIN|INNER JOIN)/i, "").strip)
         end
         
-        joins_sql
+        
+        
+        joins_sql += " " unless joins_sql.blank?
+        joins_sql += safe_joins.join
       end
       
       def limit=(value)
@@ -123,7 +143,7 @@ module Searchgasm #:nodoc:
       end
       
       # Sanitizes everything down into options ActiveRecord::Base.find can understand
-      def sanitize(searching = true)
+      def sanitize(searching = true)  
         find_options = {}
         
         (searching ? AR_FIND_OPTIONS : AR_CALCULATIONS_OPTIONS).each do |find_option|

data/lib/searchgasm/search/searching.rb

@@ -20,7 +20,7 @@ module Searchgasm
           def #{method}(*args)
             find_options = {}
             options = args.extract_options! # can't pass options, your options are in the search
-            klass.send(:with_scope, :find => scope) do
+            klass.send(:with_scope, :find => acting_as_filter? ? {} : scope) do
               options = sanitize(#{SEARCH_METHODS.include?(method)})
               if #{CALCULATION_METHODS.include?(method)}
                 options[:distinct] = true

data/lib/searchgasm/version.rb

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

data/searchgasm.gemspec

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

data/test/test_active_record_base.rb

@@ -51,6 +51,8 @@ class TestActiveRecordBase < Test::Unit::TestCase
     
     assert_equal Account.find(1, 3), Account.all(:conditions => {:name_contains => "Binary"}, :page => 2)
     assert_equal [], Account.all(:conditions => {:name_contains => "Binary"}, :page => 2, :per_page => 20)
+    
+    assert_equal [Account.find(1)], Account.scope1.all(:conditions => {:users => {:first_name_starts_with => "Ben"}})
   end
   
   def test_searchgasm_counting

data/test/test_conditions_base.rb

@@ -10,7 +10,7 @@ class TestConditionsBase < Test::Unit::TestCase
   end
   
   def test_association_names
-    assert_equal ["account", "parent", "orders", "user_groups", "children"], Searchgasm::Cache::UserConditions.association_names
+    assert_equal ["children", "orders", "account", "parent", "user_groups"], Searchgasm::Cache::UserConditions.association_names
     assert_equal ["admin", "orders", "users"], Searchgasm::Cache::AccountConditions.association_names
   end
   

data/test/test_helper.rb

@@ -13,6 +13,8 @@ class Account < ActiveRecord::Base
   has_one :admin, :class_name => "User", :conditions => {:first_name => "Ben"}
   has_many :users, :dependent => :destroy
   has_many :orders, :through => :users
+  
+  named_scope :scope1, :conditions => {:users => {:first_name_contains => "Ben"}}
 end
 
 class UserGroup < ActiveRecord::Base

data/test/test_search_base.rb

@@ -185,6 +185,8 @@ class TestSearchBase < Test::Unit::TestCase
     search = Account.new_search
     search.select = "id, name"
     assert_equal Account.all, search.all
+    
+    assert_equal [Account.find(1)], Account.scope1.new_search(:conditions => {:users => {:first_name_starts_with => "Ben"}}).all
   end
 
   def test_calculations

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: searchgasm
 version: !ruby/object:Gem::Version 
-  version: 1.3.4
+  version: 1.3.5
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-07 00:00:00 -04:00
+date: 2008-10-08 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency