searchlogic 1.6.6 → 2.1.0

data/lib/searchlogic/named_scopes/conditions.rb

@@ -0,0 +1,215 @@
+module Searchlogic
+  module NamedScopes
+    # Handles dynamically creating named scopes for columns.
+    module Conditions
+      COMPARISON_CONDITIONS = {
+        :equals => [:is, :eq],
+        :does_not_equal => [:not_equal_to, :is_not, :not, :ne],
+        :less_than => [:lt, :before],
+        :less_than_or_equal_to => [:lte],
+        :greater_than => [:gt, :after],
+        :greater_than_or_equal_to => [:gte],
+      }
+      
+      WILDCARD_CONDITIONS = {
+        :like => [:contains, :includes],
+        :begins_with => [:bw],
+        :ends_with => [:ew],
+      }
+      
+      BOOLEAN_CONDITIONS = {
+        :null => [:nil],
+        :empty => []
+      }
+      
+      CONDITIONS = {}
+      
+      COMPARISON_CONDITIONS.merge(WILDCARD_CONDITIONS).each do |condition, aliases|
+        CONDITIONS[condition] = aliases
+        CONDITIONS["#{condition}_any".to_sym] = aliases.collect { |a| "#{a}_any".to_sym }
+        CONDITIONS["#{condition}_all".to_sym] = aliases.collect { |a| "#{a}_all".to_sym }
+      end
+      
+      BOOLEAN_CONDITIONS.each { |condition, aliases| CONDITIONS[condition] = aliases }
+      
+      PRIMARY_CONDITIONS = CONDITIONS.keys
+      ALIAS_CONDITIONS = CONDITIONS.values.flatten
+      
+      # Retrieves the options passed when creating the respective named scope. Ex:
+      #
+      #   named_scope :whatever, :conditions => {:column => value}
+      #
+      # This method will return:
+      #
+      #   :conditions => {:column => value}
+      #
+      # ActiveRecord hides this internally, 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)
+        
+        if key
+          eval("options", scopes[key])
+        else
+          nil
+        end
+      end
+      
+      # The arity for a named scope's proc is important, because we use the arity
+      # to determine if the condition should be ignored when calling the search method.
+      # If the condition is false and the arity is 0, then we skip it all together. Ex:
+      #
+      #   User.named_scope :age_is_4, :conditions => {:age => 4}
+      #   User.search(:age_is_4 => false) == User.all
+      #   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.
+      def named_scope_arity(name)
+        options = named_scope_options(name)
+        options.respond_to?(:arity) ? options.arity : nil
+      end
+      
+      # Returns the primary condition for the given alias. Ex:
+      #
+      #   primary_condition(:gt) => :greater_than
+      def primary_condition(alias_condition)
+        CONDITIONS.find { |k, v| k == alias_condition.to_sym || v.include?(alias_condition.to_sym) }.first
+      end
+      
+      # Returns the primary name for any condition on a column. You can pass it
+      # a primary condition, alias condition, etc, and it will return the proper
+      # primary condition name. This helps simply logic throughout Searchlogic. Ex:
+      #
+      #   primary_condition_name(:id_gt) => :id_greater_than
+      #   primary_condition_name(:id_greater_than) => :id_greater_than
+      def primary_condition_name(name)
+        if primary_condition?(name)
+          name.to_sym
+        elsif details = alias_condition_details(name)
+          "#{details[:column]}_#{primary_condition(details[:condition])}".to_sym
+        else
+          nil
+        end
+      end
+      
+      # Is the name of the method a valid condition that can be dynamically created?
+      def condition?(name)
+        primary_condition?(name) || alias_condition?(name)
+      end
+      
+      # Is the name of the method a valid condition that can be dynamically created,
+      # AND is it a primary condition (not an alias). "greater_than" not "gt".
+      def primary_condition?(name)
+        !primary_condition_details(name).nil?
+      end
+      
+      # Is the name of the method a valid condition that can be dynamically created,
+      # AND is it an alias condition. "gt" not "greater_than".
+      def alias_condition?(name)
+        !alias_condition_details(name).nil?
+      end
+      
+      private
+        def method_missing(name, *args, &block)
+          if details = primary_condition_details(name)
+            create_primary_condition(details[:column], details[:condition])
+            send(name, *args)
+          elsif details = alias_condition_details(name)
+            create_alias_condition(details[:column], details[:condition], args)
+            send(name, *args)
+          else
+            super
+          end
+        end
+        
+        def primary_condition_details(name)
+          if name.to_s =~ /^(#{column_names.join("|")})_(#{PRIMARY_CONDITIONS.join("|")})$/
+            {:column => $1, :condition => $2}
+          end
+        end
+        
+        def create_primary_condition(column, condition)
+          column_type = columns_hash[column.to_s].type
+          scope_options = case condition.to_s
+          when /^equals/
+            scope_options(condition, column_type, "#{table_name}.#{column} = ?")
+          when /^does_not_equal/
+            scope_options(condition, column_type, "#{table_name}.#{column} != ?")
+          when /^less_than_or_equal_to/
+            scope_options(condition, column_type, "#{table_name}.#{column} <= ?")
+          when /^less_than/
+            scope_options(condition, column_type, "#{table_name}.#{column} < ?")
+          when /^greater_than_or_equal_to/
+            scope_options(condition, column_type, "#{table_name}.#{column} >= ?")
+          when /^greater_than/
+            scope_options(condition, column_type, "#{table_name}.#{column} > ?")
+          when /^like/
+            scope_options(condition, column_type, "#{table_name}.#{column} LIKE ?", :like)
+          when /^begins_with/
+            scope_options(condition, column_type, "#{table_name}.#{column} LIKE ?", :begins_with)
+          when /^ends_with/
+            scope_options(condition, column_type, "#{table_name}.#{column} LIKE ?", :ends_with)
+          when "null"
+            {:conditions => "#{table_name}.#{column} IS NULL"}
+          when "empty"
+            {:conditions => "#{table_name}.#{column} = ''"}
+          end
+          
+          named_scope("#{column}_#{condition}".to_sym, scope_options)
+        end
+        
+        # This method helps cut down on defining scope options for conditions that allow *_any or *_all conditions.
+        # Kepp in mind that the lambdas get cached in a method, so you want to keep the contents of the lambdas as
+        # fast as possible, which is why I didn't do the case statement inside of the lambda.
+        def scope_options(condition, column_type, sql, value_modifier = nil)
+          case condition.to_s
+          when /_(any|all)$/
+            searchlogic_lambda(column_type) { |*values|
+              return {} if values.empty?
+              values = values.flatten
+              
+              values_to_sub = nil
+              if value_modifier.nil?
+                values_to_sub = values
+              else
+                values_to_sub = values.collect { |value| value_with_modifier(value, value_modifier) }
+              end
+              
+              join = $1 == "any" ? " OR " : " AND "
+              {:conditions => [values.collect { |value| sql }.join(join), *values_to_sub]}
+            }
+          else
+            searchlogic_lambda(column_type) { |value| {:conditions => [sql, value_with_modifier(value, value_modifier)]} }
+          end
+        end
+        
+        def value_with_modifier(value, modifier)
+          case modifier
+          when :like
+            "%#{value}%"
+          when :begins_with
+            "#{value}%"
+          when :ends_with
+            "%#{value}"
+          else
+            value
+          end
+        end
+        
+        def alias_condition_details(name)
+          if name.to_s =~ /^(#{column_names.join("|")})_(#{ALIAS_CONDITIONS.join("|")})$/
+            {:column => $1, :condition => $2}
+          end
+        end
+        
+        def create_alias_condition(column, condition, args)
+          primary_condition = primary_condition(condition)
+          alias_name = "#{column}_#{condition}"
+          primary_name = "#{column}_#{primary_condition}"
+          send(primary_name, *args) # go back to method_missing and make sure we create the method
+          (class << self; self; end).class_eval { alias_method alias_name, primary_name }
+        end
+    end
+  end
+end

data/lib/searchlogic/named_scopes/ordering.rb

@@ -0,0 +1,53 @@
+module Searchlogic
+  module NamedScopes
+    # Handles dynamically creating named scopes for orderin by columns.
+    module Ordering
+      def condition?(name) # :nodoc:
+        super || order_condition?(name)
+      end
+      
+      def primary_condition_name(name) # :nodoc
+        if result = super
+          result
+        elsif order_condition?(name)
+          name.to_sym
+        else
+          nil
+        end
+      end
+      
+      def order_condition?(name) # :nodoc:
+        !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)
+              send(scope_name).proxy_options
+            }
+            send(name, *args)
+          elsif details = order_condition_details(name)
+            create_order_conditions(details[:column])
+            send(name, *args)
+          else
+            super
+          end
+        end
+        
+        def order_condition_details(name)
+          if name.to_s =~ /^(ascend|descend)_by_(\w+)$/
+            {:order_as => $1, :column => $2}
+          elsif name.to_s =~ /^order$/
+            {}
+          end
+        end
+        
+        def create_order_conditions(column)
+          named_scope("ascend_by_#{column}".to_sym, {:order => "#{table_name}.#{column} ASC"})
+          named_scope("descend_by_#{column}".to_sym, {:order => "#{table_name}.#{column} DESC"})
+        end
+    end
+  end
+end

data/lib/searchlogic/rails_helpers.rb

@@ -0,0 +1,69 @@
+module Searchlogic
+  module RailsHelpers
+    # Creates a link that alternates between acending and descending. It basically
+    # alternates between calling 2 named scopes: "ascend_by_*" and "descend_by_*"
+    #
+    # 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_"
+    # * <tt>:as</tt> - the text used in the link, defaults to whatever is passed to :by
+    # * <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
+    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[:descend_scope] ||= "descend_by_#{options[:by]}"
+      ascending = search.order.to_s == options[:ascend_scope]
+      new_scope = ascending ? options[:descend_scope] : options[:ascend_scope]
+      selected = [options[:ascend_scope], options[:descend_scope]].include?(search.order.to_s)
+      if selected
+        css_classes = html_options[:class] ? html_options[:class].split(" ") : []
+        if ascending
+          options[:as] = "&#9650;&nbsp;#{options[:as]}"
+          css_classes << "ascending"
+        else
+          options[:as] = "&#9660;&nbsp;#{options[:as]}"
+          css_classes << "descending"
+        end
+        html_options[:class] = css_classes.join(" ")
+      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)
+      if search_obj = args.find { |arg| arg.is_a?(Searchlogic::Search) }
+        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
+      super
+    end
+    
+    # Automatically adds an "order" hidden field in your form to preserve how the data 
+    # is being ordered.
+    def fields_for(*args, &block)
+      if search_obj = args.find { |arg| arg.is_a?(Searchlogic::Search) }
+        args.unshift(:search) if args.first == search_obj
+        concat(hidden_field_tag("#{args.first}[order]", search_obj.order) + "\n")
+        super
+      else
+        super
+      end
+    end
+  end
+end

data/lib/searchlogic/search.rb

@@ -0,0 +1,146 @@
+module Searchlogic
+  # A class that acts like a model, creates attr_accessors for named_scopes, and then
+  # chains together everything when an "action" method is called. It basically makes
+  # implementing search forms in your application effortless:
+  #
+  #   search = User.search
+  #   search.username_like = "bjohnson"
+  #   search.all
+  #
+  # Is equivalent to:
+  #
+  #   User.search(:username_like => "bjohnson").all
+  #
+  # Is equivalent to:
+  #
+  #   User.username_like("bjohnson").all
+  class Search
+    # Responsible for adding a "search" method into your models.
+    module Implementation
+      # Returns a new Search object for the given model.
+      def search(conditions = {})
+        Search.new(self, scope(:find), conditions)
+      end
+    end
+    
+    # Is an invalid condition is used this error will be raised. Ex:
+    #
+    #   User.search(:unkown => true)
+    #
+    # Where unknown is not a valid named scope for the User model.
+    class UnknownConditionError < StandardError
+      def initialize(condition)
+        msg = "The #{condition} is not a valid condition. You may only use conditions that map to a named scope"
+        super(msg)
+      end
+    end
+    
+    attr_accessor :klass, :current_scope, :conditions
+    
+    # Creates a new search object for the given class. Ex:
+    #
+    #   Searchlogic::Search.new(User, {}, {:username_like => "bjohnson"})
+    def initialize(klass, current_scope, conditions = {})
+      self.klass = klass
+      self.current_scope = current_scope
+      self.conditions = conditions if conditions.is_a?(Hash)
+    end
+    
+    def clone
+      self.class.new(klass, current_scope.clone, conditions.clone)
+    end
+    
+    # Returns a hash of the current conditions set.
+    def conditions
+      @conditions ||= {}
+    end
+    
+    # Accepts a hash of conditions.
+    def conditions=(values)
+      values.each do |condition, value|
+        value.delete_if { |v| v.blank? } if value.is_a?(Array)
+        next if value.blank?
+        send("#{condition}=", value)
+      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+)=$/
+          condition = $1.to_sym
+          scope_name = normalize_scope_name($1)
+          if scope?(scope_name)
+            conditions[condition] = type_cast(args.first, cast_type(scope_name))
+          else
+            raise UnknownConditionError.new(name)
+          end
+        elsif scope?(normalize_scope_name(name))
+          if args.size > 0
+            send("#{name}=", *args)
+            self
+          else
+            conditions[name]
+          end
+        else
+          scope = conditions.inject(klass.scoped(current_scope)) do |scope, condition|
+            scope_name, value = condition
+            scope_name = normalize_scope_name(scope_name)
+            klass.send(scope_name, value) if !klass.respond_to?(scope_name)
+            arity = klass.named_scope_arity(scope_name)
+            
+            if !arity || arity == 0
+              if value == true
+                scope.send(scope_name)
+              else
+                scope
+              end
+            else
+              scope.send(scope_name, value)
+            end
+          end
+          scope.send(name, *args, &block)
+        end
+      end
+      
+      def normalize_scope_name(scope_name)
+        klass.column_names.include?(scope_name.to_s) ? "#{scope_name}_equals".to_sym : scope_name.to_sym
+      end
+      
+      def scope?(scope_name)
+        klass.scopes.key?(scope_name) || klass.condition?(scope_name)
+      end
+      
+      def cast_type(name)
+        klass.send(name, nil) if !klass.respond_to?(name) # We need to set up the named scope if it doesn't exist, so we can get a value for named_ssope_options
+        named_scope_options = klass.named_scope_options(name)
+        arity = klass.named_scope_arity(name)
+        if !arity || arity == 0
+          :boolean
+        else
+          named_scope_options.respond_to?(:searchlogic_arg_type) ? named_scope_options.searchlogic_arg_type : :string
+        end
+      end
+      
+      def type_cast(value, type)
+        case value
+        when Array
+          value.collect { |v| type_cast(v, type) }
+        else
+          # Let's leverage ActiveRecord's type casting, so that casting is consistent
+          # with the other models.
+          column_for_type_cast = ActiveRecord::ConnectionAdapters::Column.new("", nil)
+          column_for_type_cast.instance_variable_set(:@type, type)
+          column_for_type_cast.type_cast(value)
+        end
+      end
+  end
+end