searchlogic 2.1.12 → 2.1.13

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+== 2.1.13 released 2009-07-29
+
+* Applied bug fix from http://github.com/skanev/searchlogic to make #order work with association ordering.
+* Applied bug fix to allow for custom ordering conditions.
+
 == 2.1.12 released 2009-07-28
 
 * Fixed bug when dealing with scopes that return nil.

data/README.rdoc

@@ -1,7 +1,5 @@
 = Searchlogic
 
-<b>Searchlogic has been <em>completely</em> rewritten for v2. It is much simpler and has taken an entirely new approach. To give you an idea, v1 had ~2300 lines of code, v2 has ~420 lines of code.</b>
-
 Searchlogic provides common named scopes and object based searching for ActiveRecord.
 
 == Helpful links

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 12
+:patch: 13
 :major: 2
 :minor: 1

data/lib/searchlogic/active_record_consistency.rb

@@ -8,9 +8,10 @@ module Searchlogic
       end
     end
     
-    # In AR multiple joins are sometimes in a single join query, and other time they
+    # In AR multiple joins are sometimes in a single join query, and other times they
     # are not. The merge_joins method in AR should account for this, but it doesn't.
-    # This fixes that problem.
+    # This fixes that problem. This way there is one join per string, which allows
+    # the merge_joins method to delete duplicates.
     def merge_joins_with_searchlogic(*args)
       joins = merge_joins_without_searchlogic(*args)
       joins.collect { |j| j.is_a?(String) ? j.split("  ") : j }.flatten.uniq

data/lib/searchlogic/core_ext/object.rb

@@ -27,8 +27,10 @@ module Searchlogic
       #
       #   named_scope :id_gt, searchlogic_lambda(:integer) { |value| {:conditions => ["id > ?", value]} }
       #
-      # If you are wanting a string, you don't have to do anything, because Searchlogic assumes you are want a string.
-      # If you want something else, you need to specify it as I did in the above example.
+      # If you are wanting a string, you don't have to do anything, because Searchlogic assumes you want a string.
+      # If you want something else, you need to specify it as I did in the above example. Comments are appreciated
+      # on this, if you know of a better solution please let me know. But this is the best I could come up with,
+      # without being intrusive and altering default behavior.
       def searchlogic_lambda(type = :string, &block)
         proc = lambda(&block)
         proc.searchlogic_arg_type = type

data/lib/searchlogic/named_scopes/association_conditions.rb

@@ -23,14 +23,17 @@ module Searchlogic
         !association_condition_details(name).nil?
       end
       
-      # Is the ane of the method a valie name for an association alias condition?
+      # Is the named of the method a valid name for an association alias condition?
       # An alias being "gt" for "greater_than", etc.
       def association_alias_condition?(name)
         !association_alias_condition_details(name).nil?
       end
       
       # A convenience method for creating inner join sql to that your inner joins
-      # are consistent with how Active Record creates them.
+      # are consistent with how Active Record creates them. Basically a tool for
+      # you to use when writing your own named scopes. This way you know for sure
+      # that duplicate joins will be removed when chaining scopes together that
+      # use the same join.
       def inner_joins(association_name)
         ActiveRecord::Associations::ClassMethods::InnerJoinDependency.new(self, association_name, nil).join_associations.collect { |assoc| assoc.association_join }
       end

data/lib/searchlogic/named_scopes/association_ordering.rb

@@ -2,6 +2,10 @@ module Searchlogic
   module NamedScopes
     # Handles dynamically creating named scopes for associations.
     module AssociationOrdering
+      def association_ordering_condition?(name)
+        !association_ordering_condition_details(name).nil?
+      end
+      
       private
         def method_missing(name, *args, &block)
           if details = association_ordering_condition_details(name)

data/lib/searchlogic/named_scopes/conditions.rb

@@ -28,6 +28,7 @@ module Searchlogic
       
       CONDITIONS = {}
       
+      # Add any / all variations to every comparison and wildcard condition
       COMPARISON_CONDITIONS.merge(WILDCARD_CONDITIONS).each do |condition, aliases|
         CONDITIONS[condition] = aliases
         CONDITIONS["#{condition}_any".to_sym] = aliases.collect { |a| "#{a}_any".to_sym }
@@ -47,7 +48,7 @@ module Searchlogic
       #
       #   :conditions => {:column => value}
       #
-      # ActiveRecord hides this internally, so we have to try and pull it out with this
+      # ActiveRecord hides this internally in a Proc, so we have to try and pull it out with this
       # method.
       def named_scope_options(name)
         key = scopes.key?(name.to_sym) ? name.to_sym : primary_condition_name(name)
@@ -68,7 +69,8 @@ module Searchlogic
       #   User.search(:age_is_4 => true) == User.all(:conditions => {:age => 4})
       #
       # We also use it when trying to "copy" the underlying named scope for association
-      # conditions.
+      # conditions. This way our aliased scope accepts the same number of parameters for
+      # the underlying scope.
       def named_scope_arity(name)
         options = named_scope_options(name)
         options.respond_to?(:arity) ? options.arity : nil

data/lib/searchlogic/named_scopes/ordering.rb

@@ -19,12 +19,16 @@ module Searchlogic
       def order_condition?(name) # :nodoc:
         !order_condition_details(name).nil?
       end
+
+      def custom_order_condition?(name) # :nodoc:
+        !custom_order_condition_details(name).nil?
+      end
       
       private
         def method_missing(name, *args, &block)
           if name == :order
             named_scope name, lambda { |scope_name|
-              return {} if !order_condition?(scope_name)
+              return {} if !order_condition?(scope_name) && !custom_order_condition?(scope_name) && !association_ordering_condition?(scope_name)
               send(scope_name).proxy_options
             }
             send(name, *args)
@@ -43,6 +47,12 @@ module Searchlogic
             {}
           end
         end
+
+        def custom_order_condition_details(name)
+          if name.to_s =~ /^(ascend|descend)_by_(.+)$/
+            {:order_as => $1, :scope => name.to_sym}
+          end
+        end
         
         def create_order_conditions(column)
           named_scope("ascend_by_#{column}".to_sym, {:order => "#{table_name}.#{column} ASC"})

data/searchlogic.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{searchlogic}
-  s.version = "2.1.12"
+  s.version = "2.1.13"
 
   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-07-28}
+  s.date = %q{2009-07-29}
   s.description = %q{Searchlogic provides common named scopes and object based searching for ActiveRecord.}
   s.email = %q{bjohnson@binarylogic.com}
   s.extra_rdoc_files = [

data/spec/named_scopes/association_ordering_spec.rb

@@ -20,4 +20,8 @@ describe "Association Ordering" do
   it "should ascend with a belongs to" do
     User.ascend_by_company_name.proxy_options.should == Company.ascend_by_name.proxy_options.merge(:joins => :company)
   end
+  
+  it "should work through #order" do
+    Company.order('ascend_by_users_username').proxy_options.should == Company.ascend_by_users_username.proxy_options
+  end
 end

data/spec/named_scopes/ordering_spec.rb

@@ -20,6 +20,13 @@ describe "Ordering" do
   it "should have order" do
     User.order("ascend_by_username").proxy_options.should == User.ascend_by_username.proxy_options
   end
+
+  it "should have order by custom scope" do
+    User.column_names.should_not include("custom")
+    %w(bjohnson thunt fisons).each { |username| User.create(:username => username) }
+    User.named_scope(:ascend_by_custom, :order => "username ASC, name DESC")
+    User.order("ascend_by_custom").proxy_options.should == User.ascend_by_custom.proxy_options
+  end
   
   it "should have priorty to columns over conflicting association columns" do
     Company.ascend_by_users_count

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: searchlogic
 version: !ruby/object:Gem::Version 
-  version: 2.1.12
+  version: 2.1.13
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-28 00:00:00 -04:00
+date: 2009-07-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency