binarylogic-searchlogic 2.0.1 → 2.1.0

data/CHANGELOG.rdoc

@@ -1,4 +1,10 @@
-== 2.0.1
+== 2.0.2
+
+* Added a delete method to the Search class to allow the deleting of conditions off of the object.
+* Add alias_scope feature, lets your create "named scopes" that represent a procedure of named scopes, while at the same time telling Searchlogic it is safe to use in the Search class.
+* Use url_for as the default with form_for since rails does some magic to determine the url to use.
+
+== 2.0.1 released 2009-06-20
 
 * Allow the chaining of conditions off of a search object. Ex: search.username_like("bjohnson").age_gt(20).all
 * Split out left outer join creation into its own method, allowing you to use it in your own named scopes.

data/README.rdoc

@@ -85,7 +85,7 @@ You also get named scopes for any of your associations:
   User.ascend_by_order_total
   User.descend_by_orders_line_items_price
 
-Again these are just named scopes. You can chain them together, call methods off of them, etc. What's great about these named scopes is that they do NOT use the :include option, making them <em>much</em> faster. Instead they create a LEFT OUTER JOIN and pass it to the :joins option, which is great for performance. To prove my point here is a quick benchmark from an application I am working on:
+Again these are just named scopes. You can chain them together, call methods off of them, etc. What's great about these named scopes is that they do NOT use the :include option, making them <em>much</em> faster. Instead they create a INNER JOIN and pass it to the :joins option, which is great for performance. To prove my point here is a quick benchmark from an application I am working on:
 
   Benchmark.bm do |x|
     x.report { 10.times { Event.tickets_id_gt(10).all(:include => :tickets) } }
@@ -101,8 +101,6 @@ If you want to use the :include option, just specify it:
 
 Obviously, only do this if you want to actually use the included objects.
 
-Lastly, because we are using ActiveRecord, named scopes, combining conditions, and ordering based on associated columns, the decision was made to use left outer joins instead of inner joins. This allows us to be consistent, include optional associations when ordering, and avoid duplicate joins when eager loading associations. If we use an inner join and combine any of these things we will get an "ambiguous name" sql error for the table being joined twice. Just like anything, be mindful of the SQL being produced in your application. If you are joining beyond 4 or 5 levels deep then you might consider looking at the query and optimizing it. Part of that optimization may require the use of inner joins depending on the query.
-
 == Make searching and ordering data in your application trivial
 
 The above is great, but what about tying all of this in with a search form in your application? What would be really nice is if we could use an object that represented a single search. Like this...
@@ -192,7 +190,7 @@ Before I use a library in my application I like to glance at the source and try
 
 Searchlogic utilizes method_missing to create all of these named scopes. When it hits method_missing it creates a named scope to ensure it will never hit method missing for that named scope again. Sort of a caching mechanism. It works in the same fashion as ActiveRecord's "find_by_*" methods. This way only the named scopes you need are created and nothing more.
 
-That's about it, the named scope options are pretty bare bones and created just like you would manually. The only big difference being the use of LEFT OUTER JOINS on associated conditions instead of INNER JOINS.
+That's about it, the named scope options are pretty bare bones and created just like you would manually.
 
 == Credit
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 2
-:minor: 0
-:patch: 1
+:minor: 1
+:patch: 0

data/lib/searchlogic/named_scopes/alias_scope.rb

@@ -0,0 +1,63 @@
+module Searchlogic
+  module NamedScopes
+    # Adds the ability to create alias scopes that allow you to alias a named
+    # scope or create a named scope procedure, while at the same time letting
+    # Searchlogic know that this is a safe method.
+    module AliasScope
+      # The searchlogic Search class takes a hash and chains the values together as named scopes.
+      # For security reasons the only hash keys that are allowed must be mapped to named scopes.
+      # You can not pass the name of a class method and expect that to be called. In some instances
+      # you might create a class method that essentially aliases a named scope or represents a
+      # named scope procedure. Ex:
+      #
+      #   User.named_scope :teenager, :conditions => ["age >= ? AND age <= ?", 13, 19]
+      #
+      # This is obviously a very basic example, but there is logic that is duplicated here. For
+      # more complicated named scopes this might make more sense, but to make my point you could
+      # do something like this instead
+      #
+      #   class User
+      #     def teenager
+      #       age_gte(13).age_lte(19)
+      #     end
+      #   end
+      #
+      # As I stated above, you could not use this method with the Searchlogic::Search class because
+      # there is no way to tell that this is actually a named scope. Instead, Searchlogic lets you
+      # do something like this:
+      #
+      #   User.alias_scope :teenager, lambda { age_gte(13).age_lte(19) }
+      #
+      # It fits in better, at the same time Searchlogic will know this is an acceptable named scope.
+      def alias_scope(name, options = nil)
+        alias_scopes[name.to_sym] = options
+        (class << self; self end).instance_eval do
+          define_method name do |*args|
+            case options
+            when Symbol
+              send(options)
+            else
+              options.call(*args)
+            end
+          end
+        end
+      end
+      
+      def alias_scopes # :nodoc:
+        @alias_scopes ||= {}
+      end
+      
+      def alias_scope?(name) # :nodoc:
+        alias_scopes.key?(name.to_sym)
+      end
+      
+      def condition?(name) # :nodoc:
+        super || alias_scope?(name)
+      end
+      
+      def named_scope_options(name) # :nodoc:
+        super || alias_scopes[name.to_sym]
+      end
+    end
+  end
+end

data/lib/searchlogic/named_scopes/associations.rb

@@ -29,24 +29,6 @@ module Searchlogic
         !association_alias_condition_details(name).nil?
       end
       
-      # Leverages ActiveRecord's JoinDependency class to create a left outer join. Searchlogic uses left outer joins so that
-      # records with no associations are included in the result when the association is optional. You can use this method
-      # internally when creating your own named scopes that need joins. You need to do this because then ActiveRecord will
-      # remove any duplicate joins for you when you chain named scopes that require the same join. If you are using a
-      # LEFT OUTER JOIN and an INNER JOIN, ActiveRecord will add both to the query, causing SQL errors.
-      #
-      # Bottom line, this is convenience method that you can use when creating your own named scopes. Ex:
-      #
-      #   named_scope :orders_line_items_price_expensive, :joins => left_out_joins(:orders => :line_items), :conditions => "line_items.price > 100"
-      #
-      # Now your joins are consistent with Searchlogic allowing you to avoid SQL errors with duplicate joins.
-      def left_outer_joins(association_name)
-        ActiveRecord::Associations::ClassMethods::JoinDependency.new(self, association_name, nil).join_associations.collect do |assoc|
-          sql = assoc.association_join.strip
-          sql.split(/LEFT OUTER JOIN/).delete_if { |join| join.strip.blank? }.collect { |join| "LEFT OUTER JOIN #{join.strip}"}
-        end.flatten
-      end
-      
       private
         def method_missing(name, *args, &block)
           if details = association_condition_details(name)
@@ -110,7 +92,8 @@ module Searchlogic
             # The underlying condition doesn't require any parameters, so let's just create a simple
             # named scope that is based on a hash.
             options = scope.proxy_options
-            add_left_outer_joins(options, association)
+            options[:joins] = options[:joins].blank? ? association.name : {association.name => options[:joins]}
+            #add_left_outer_joins(options, association)
             options
           else
             # The underlying condition requires parameters, let's match the parameters it requires
@@ -132,31 +115,12 @@ module Searchlogic
             eval <<-"end_eval"
               searchlogic_lambda(:#{scope_options.searchlogic_arg_type}) { |#{proc_args.join(",")}|
                 options = association.klass.named_scope_options(association_condition).call(#{proc_args.join(",")})
-                add_left_outer_joins(options, association)
+                options[:joins] = options[:joins].blank? ? association.name : {association.name => options[:joins]}
                 options
               }
             end_eval
           end
         end
-        
-        # In a named scope you have 2 options for adding joins: :include and :joins.
-        #
-        # :include will execute multiple queries for each association and instantiate objects for each association.
-        # This is not what we want when we are searching. The only other option left is :joins. We can pass the
-        # name of the association directly, but AR creates an INNER JOIN. If we are ordering by an association's
-        # attribute, and that association is optional, the records without an association will be omitted. Again,
-        # not what we want.
-        #
-        # So the only option left is to use :joins with manually written SQL. We can still have AR generate this SQL
-        # for us by leveraging it's join dependency classes. Instead of using the InnerJoinDependency we use the regular
-        # JoinDependency which creates a LEFT OUTER JOIN, which is what we want.
-        #
-        # The code below was extracted out of AR's add_joins! method and then modified.
-        def add_left_outer_joins(options, association)
-          joins = left_outer_joins(association.name)
-          options[:joins] ||= []
-          options[:joins] = joins + options[:joins]
-        end
     end
   end
 end

data/lib/searchlogic/rails_helpers.rb

@@ -6,6 +6,11 @@ module Searchlogic
     # By default Searchlogic gives you these named scopes for all of your columns, but
     # if you wanted to create your own, it will work with those too.
     #
+    # Examples:
+    #
+    #   order @search, :by => :username
+    #   order @search, :by => :created_at, :as => "Created"
+    #
     # This helper accepts the following options:
     #
     # * <tt>:by</tt> - the name of the named scope. This helper will prepend this value with "ascend_by_" and "descend_by_"
@@ -32,7 +37,7 @@ module Searchlogic
         end
         html_options[:class] = css_classes.join(" ")
       end
-      link_to options[:as], url_for(options[:params_scope] => {:order => new_scope}), html_options
+      link_to options[:as], url_for(options[:params_scope] => search.conditions.merge( { :order => new_scope } ) ), html_options
     end
 
     # Automatically makes the form method :get if a Searchlogic::Search and sets
@@ -42,6 +47,7 @@ module Searchlogic
         options = args.extract_options!
         options[:html] ||= {}
         options[:html][:method] ||= :get
+        options[:url] ||= url_for
         args.unshift(:search) if args.first == search_obj
         args << options
       end

data/lib/searchlogic/search.rb

@@ -64,6 +64,15 @@ module Searchlogic
       end
     end
     
+    # Delete a condition from the search. Since conditions map to named scopes,
+    # if a named scope accepts a parameter there is no way to actually delete
+    # the scope if you do not want it anymore. A nil value might be meaningful
+    # to that scope.
+    def delete(*names)
+      names.each { |name| @conditions.delete(name.to_sym) }
+      self
+    end
+    
     private
       def method_missing(name, *args, &block)
         if name.to_s =~ /(\w+)=$/

data/lib/searchlogic.rb

@@ -3,6 +3,7 @@ require "searchlogic/core_ext/object"
 require "searchlogic/named_scopes/conditions"
 require "searchlogic/named_scopes/ordering"
 require "searchlogic/named_scopes/associations"
+require "searchlogic/named_scopes/alias_scope"
 require "searchlogic/search"
 
 Proc.send(:include, Searchlogic::CoreExt::Proc)
@@ -10,6 +11,7 @@ Object.send(:include, Searchlogic::CoreExt::Object)
 ActiveRecord::Base.extend(Searchlogic::NamedScopes::Conditions)
 ActiveRecord::Base.extend(Searchlogic::NamedScopes::Ordering)
 ActiveRecord::Base.extend(Searchlogic::NamedScopes::Associations)
+ActiveRecord::Base.extend(Searchlogic::NamedScopes::AliasScope)
 ActiveRecord::Base.extend(Searchlogic::Search::Implementation)
 
 if defined?(ActionController)

data/searchlogic.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{searchlogic}
-  s.version = "2.0.1"
+  s.version = "2.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Johnson of Binary Logic"]
-  s.date = %q{2009-06-20}
+  s.date = %q{2009-06-27}
   s.email = %q{bjohnson@binarylogic.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
      "lib/searchlogic.rb",
      "lib/searchlogic/core_ext/object.rb",
      "lib/searchlogic/core_ext/proc.rb",
+     "lib/searchlogic/named_scopes/alias_scope.rb",
      "lib/searchlogic/named_scopes/associations.rb",
      "lib/searchlogic/named_scopes/conditions.rb",
      "lib/searchlogic/named_scopes/ordering.rb",
@@ -32,6 +33,7 @@ Gem::Specification.new do |s|
      "searchlogic.gemspec",
      "spec/core_ext/object_spec.rb",
      "spec/core_ext/proc_spec.rb",
+     "spec/named_scopes/alias_scope_spec.rb",
      "spec/named_scopes/associations_spec.rb",
      "spec/named_scopes/conditions_spec.rb",
      "spec/named_scopes/ordering_spec.rb",
@@ -46,6 +48,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/core_ext/object_spec.rb",
      "spec/core_ext/proc_spec.rb",
+     "spec/named_scopes/alias_scope_spec.rb",
      "spec/named_scopes/associations_spec.rb",
      "spec/named_scopes/conditions_spec.rb",
      "spec/named_scopes/ordering_spec.rb",

data/spec/named_scopes/alias_scope_spec.rb

@@ -0,0 +1,15 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe "AliasScope" do
+  it "should allow alias scopes" do
+    User.create(:username => "bjohnson")
+    User.create(:username => "thunt")
+    User.username_has("bjohnson").all.should == User.find_all_by_username("bjohnson")
+  end
+  
+  it "should allow alias scopes from the search object" do
+    search = User.search
+    search.username_has = "bjohnson"
+    search.username_has.should == "bjohnson"
+  end
+end

data/spec/named_scopes/associations_spec.rb

@@ -1,17 +1,12 @@
 require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
 
 describe "Associations" do
-  before(:each) do
-    @users_join_sql = ["LEFT OUTER JOIN \"users\" ON users.company_id = companies.id"]
-    @orders_join_sql = ["LEFT OUTER JOIN \"users\" ON users.company_id = companies.id", "LEFT OUTER JOIN \"orders\" ON orders.user_id = users.id"]
-  end
-  
   it "should create a named scope" do
-    Company.users_username_like("bjohnson").proxy_options.should == User.username_like("bjohnson").proxy_options.merge(:joins => @users_join_sql)
+    Company.users_username_like("bjohnson").proxy_options.should == User.username_like("bjohnson").proxy_options.merge(:joins => :users)
   end
   
   it "should create a deep named scope" do
-    Company.users_orders_total_greater_than(10).proxy_options.should == Order.total_greater_than(10).proxy_options.merge(:joins => @orders_join_sql)
+    Company.users_orders_total_greater_than(10).proxy_options.should == Order.total_greater_than(10).proxy_options.merge(:joins => {:users => :orders})
   end
   
   it "should not allowed named scopes on non existent association columns" do
@@ -23,13 +18,13 @@ describe "Associations" do
   end
   
   it "should allow named scopes to be called multiple times and reflect the value passed" do
-    Company.users_username_like("bjohnson").proxy_options.should == User.username_like("bjohnson").proxy_options.merge(:joins => @users_join_sql)
-    Company.users_username_like("thunt").proxy_options.should == User.username_like("thunt").proxy_options.merge(:joins => @users_join_sql)
+    Company.users_username_like("bjohnson").proxy_options.should == User.username_like("bjohnson").proxy_options.merge(:joins => :users)
+    Company.users_username_like("thunt").proxy_options.should == User.username_like("thunt").proxy_options.merge(:joins => :users)
   end
   
   it "should allow deep named scopes to be called multiple times and reflect the value passed" do
-    Company.users_orders_total_greater_than(10).proxy_options.should == Order.total_greater_than(10).proxy_options.merge(:joins => @orders_join_sql)
-    Company.users_orders_total_greater_than(20).proxy_options.should == Order.total_greater_than(20).proxy_options.merge(:joins => @orders_join_sql)
+    Company.users_orders_total_greater_than(10).proxy_options.should == Order.total_greater_than(10).proxy_options.merge(:joins => {:users => :orders})
+    Company.users_orders_total_greater_than(20).proxy_options.should == Order.total_greater_than(20).proxy_options.merge(:joins => {:users => :orders})
   end
   
   it "should have an arity of 1 if the underlying scope has an arity of 1" do
@@ -48,30 +43,31 @@ describe "Associations" do
   end
   
   it "should allow aliases" do
-    Company.users_username_contains("bjohnson").proxy_options.should == User.username_contains("bjohnson").proxy_options.merge(:joins => @users_join_sql)
+    Company.users_username_contains("bjohnson").proxy_options.should == User.username_contains("bjohnson").proxy_options.merge(:joins => :users)
   end
   
   it "should allow deep aliases" do
-    Company.users_orders_total_gt(10).proxy_options.should == Order.total_gt(10).proxy_options.merge(:joins => @orders_join_sql)
+    Company.users_orders_total_gt(10).proxy_options.should == Order.total_gt(10).proxy_options.merge(:joins => {:users => :orders})
   end
   
   it "should allow ascending" do
-    Company.ascend_by_users_username.proxy_options.should == User.ascend_by_username.proxy_options.merge(:joins => @users_join_sql)
+    Company.ascend_by_users_username.proxy_options.should == User.ascend_by_username.proxy_options.merge(:joins => :users)
   end
   
   it "should allow descending" do
-    Company.descend_by_users_username.proxy_options.should == User.descend_by_username.proxy_options.merge(:joins => @users_join_sql)
+    Company.descend_by_users_username.proxy_options.should == User.descend_by_username.proxy_options.merge(:joins => :users)
   end
   
   it "should allow deep ascending" do
-    Company.ascend_by_users_orders_total.proxy_options.should == Order.ascend_by_total.proxy_options.merge(:joins => @orders_join_sql)
+    Company.ascend_by_users_orders_total.proxy_options.should == Order.ascend_by_total.proxy_options.merge(:joins => {:users => :orders})
   end
   
   it "should allow deep descending" do
-    Company.descend_by_users_orders_total.proxy_options.should == Order.descend_by_total.proxy_options.merge(:joins => @orders_join_sql)
+    Company.descend_by_users_orders_total.proxy_options.should == Order.descend_by_total.proxy_options.merge(:joins => {:users => :orders})
   end
   
   it "should include optional associations" do
+    pending # this is a problem with using inner joins and left outer joins
     Company.create
     company = Company.create
     user = company.users.create

data/spec/search_spec.rb

@@ -40,6 +40,12 @@ describe "Search" do
     search1.all.should == [user2]
   end
   
+  it "should delete the condition" do
+    search = User.search(:username_like => "bjohnson")
+    search.delete("username_like")
+    search.username_like.should be_nil
+  end
+  
   context "conditions" do
     it "should set the conditions and be accessible individually" do
       search = User.search

data/spec/spec_helper.rb

@@ -51,6 +51,7 @@ Spec::Runner.configure do |config|
     class User < ActiveRecord::Base
       belongs_to :company
       has_many :orders, :dependent => :destroy
+      alias_scope :username_has, lambda { |value| username_like(value) }
     end
     
     class Order < ActiveRecord::Base

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: binarylogic-searchlogic
 version: !ruby/object:Gem::Version 
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-20 00:00:00 -07:00
+date: 2009-06-27 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -33,6 +33,7 @@ files:
 - lib/searchlogic.rb
 - lib/searchlogic/core_ext/object.rb
 - lib/searchlogic/core_ext/proc.rb
+- lib/searchlogic/named_scopes/alias_scope.rb
 - lib/searchlogic/named_scopes/associations.rb
 - lib/searchlogic/named_scopes/conditions.rb
 - lib/searchlogic/named_scopes/ordering.rb
@@ -42,6 +43,7 @@ files:
 - searchlogic.gemspec
 - spec/core_ext/object_spec.rb
 - spec/core_ext/proc_spec.rb
+- spec/named_scopes/alias_scope_spec.rb
 - spec/named_scopes/associations_spec.rb
 - spec/named_scopes/conditions_spec.rb
 - spec/named_scopes/ordering_spec.rb
@@ -76,6 +78,7 @@ summary: Searchlogic provides common named scopes and object based searching for
 test_files: 
 - spec/core_ext/object_spec.rb
 - spec/core_ext/proc_spec.rb
+- spec/named_scopes/alias_scope_spec.rb
 - spec/named_scopes/associations_spec.rb
 - spec/named_scopes/conditions_spec.rb
 - spec/named_scopes/ordering_spec.rb