joost-searchlogic 2.1.5.2 → 2.1.5.3

data/README.rdoc

@@ -1,6 +1,12 @@
 This is a clone of the original SearchLogic! Only used to apply some fast patches.
 You should probably use the newer original source.
 
+Changes made:
+* Fixed bug #92 (see lighthouse page).
+* Changed order helper.
+* Changed loading of helpers.
+* Added some documentation.
+
 = 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>
@@ -174,6 +180,20 @@ Again, these are all just named scopes, use it in the same way:
 
 Notice we pass true as the value. If a named scope does not accept any parameters (arity == 0) you can simply pass it true or false. If you pass false, the named scope will be ignored. If your named scope accepts a parameter, the value will be passed right to the named scope regardless of the value.
 
+This way you can create more complex searches like:
+
+  User.named_scope :search_who, lambda { |*args|
+    who = "%#{(args.first || '').strip.gsub('%', '')}%"
+    {
+      :conditions => ["users.email LIKE ? OR user_profiles.firstname LIKE ?", who, who],
+      :include => :user_profile
+    }
+  }
+
+Use it, again, very simple:
+
+  User.search(:who_search => 'john')
+
 Now just throw it in your form:
 
   - form_for @search do |f|

data/lib/searchlogic/rails_helpers.rb

@@ -1,5 +1,6 @@
-module Searchlogic
-  module RailsHelpers
+module ActionView
+  class Base
+
     # Creates a link that alternates between acending and descending. It basically
     # alternates between calling 2 named scopes: "ascend_by_*" and "descend_by_*"
     #
@@ -10,6 +11,7 @@ module Searchlogic
     #
     #   order @search, :by => :username
     #   order @search, :by => :created_at, :as => "Created"
+    #   order(@search, {:by => :last_login_at, :as => 'Login time', :arrow => true}, {:class => 'order'})
     #
     # This helper accepts the following options:
     #
@@ -18,31 +20,37 @@ module Searchlogic
     # * <tt>:ascend_scope</tt> - what scope to call for ascending the data, defaults to "ascend_by_:by"
     # * <tt>:descend_scope</tt> - what scope to call for descending the data, defaults to "descend_by_:by"
     # * <tt>:params_scope</tt> - the name of the params key to scope the order condition by, defaults to :search
+    # * <tt>:default_scope</tt> - either :asc or :desc, defaults to ascend_scope
+    # * <tt>:arrow</tt> - set to true if you want an ascii arrow showing the ordering
+    # * <tt>:css_classes</tt> - Array of what css classes you want to add, defaults to [:asc, :desc]. For old behaviour use [:ascending, :descending] here
     def order(search, options = {}, html_options = {})
-      options[:params_scope] ||= :search
-      options[:as] ||= options[:by].to_s.humanize
-      options[:ascend_scope] ||= "ascend_by_#{options[:by]}"
+      options[:params_scope]  ||= :search
+      options[:as]            ||= options[:by].to_s.humanize
+      options[:ascend_scope]  ||= "ascend_by_#{options[:by]}"
       options[:descend_scope] ||= "descend_by_#{options[:by]}"
-      ascending = search.order.to_s == options[:ascend_scope]
-      new_scope = ascending ? options[:descend_scope] : options[:ascend_scope]
+      options[:css_classes]   ||= [:asc, :desc]
       selected = [options[:ascend_scope], options[:descend_scope]].include?(search.order.to_s)
       if selected
+        ascending = search.order.to_s == options[:ascend_scope]
+        new_scope = ascending ? options[:descend_scope] : options[:ascend_scope]
         css_classes = html_options[:class] ? html_options[:class].split(" ") : []
         if ascending
-          options[:as] = "&#9650;&nbsp;#{options[:as]}"
-          css_classes << "ascending"
+          options[:as] = "&#9650;&nbsp;#{options[:as]}" if options[:arrow]
+          css_classes << options[:css_classes].first
         else
-          options[:as] = "&#9660;&nbsp;#{options[:as]}"
-          css_classes << "descending"
+          options[:as] = "&#9660;&nbsp;#{options[:as]}" if options[:arrow]
+          css_classes << options[:css_classes].last
         end
         html_options[:class] = css_classes.join(" ")
+      else
+        new_scope = (options[:default_scope] == :desc) ? options[:descend_scope] : options[:ascend_scope]
       end
       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
     # the params scope to :search
-    def form_for(*args, &block)
+    def form_for_with_searchlogic(*args, &block)
       if search_obj = args.find { |arg| arg.is_a?(Searchlogic::Search) }
         options = args.extract_options!
         options[:html] ||= {}
@@ -51,19 +59,18 @@ module Searchlogic
         args.unshift(:search) if args.first == search_obj
         args << options
       end
-      super
+      form_for_without_searchlogic(*args, &block)
     end
-    
+ 
     # Automatically adds an "order" hidden field in your form to preserve how the data 
     # is being ordered.
-    def fields_for(*args, &block)
+    def fields_for_with_searchlogic(*args, &block)
       if search_obj = args.find { |arg| arg.is_a?(Searchlogic::Search) }
         args.unshift(:search) if args.first == search_obj
         concat(content_tag("div", hidden_field_tag("#{args.first}[order]", search_obj.order)) + "\n")
-        super
-      else
-        super
       end
+      fields_for_without_searchlogic(*args, &block)
     end
+
   end
 end

data/lib/searchlogic.rb

@@ -25,7 +25,8 @@ if !ActiveRecord::Base.respond_to?(:search)
   end
 end
 
-if defined?(ActionController)
+if defined?(ActionView)
   require "searchlogic/rails_helpers"
-  ActionController::Base.helper(Searchlogic::RailsHelpers)
+  ActionView::Base.alias_method_chain :form_for, :searchlogic
+  ActionView::Base.alias_method_chain :fields_for, :searchlogic
 end

data/searchlogic.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{searchlogic}
-  s.version = "2.1.5.2"
+  s.version = "2.1.5.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ben Johnson of Binary Logic"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: joost-searchlogic
 version: !ruby/object:Gem::Version 
-  version: 2.1.5.2
+  version: 2.1.5.3
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic