lazy-searchlogic 2.4.10

data/lib/searchlogic/named_scopes/or_conditions.rb

@@ -0,0 +1,141 @@
+module Searchlogic
+  module NamedScopes
+    # Handles dynamically creating named scopes for 'OR' conditions. Please see the README for a more
+    # detailed explanation.
+    module OrConditions
+      class NoConditionSpecifiedError < StandardError; end
+      class UnknownConditionError < StandardError; end
+      
+      def condition?(name) # :nodoc:
+        super || or_condition?(name)
+      end
+      
+      def named_scope_options(name) # :nodoc:
+        super || super(or_conditions(name).join("_or_"))
+      end
+      
+      private
+        def or_condition?(name)
+          !or_conditions(name).nil?
+        end
+        
+        def method_missing(name, *args, &block)
+          if conditions = or_conditions(name)
+            create_or_condition(conditions, args)
+            (class << self; self; end).class_eval { alias_method name, conditions.join("_or_") } if !respond_to?(name)
+            send(name, *args)
+          else
+            super
+          end
+        end
+        
+        def or_conditions(name)
+          # First determine if we should even work on the name, we want to be as quick as possible
+          # with this.
+          if (parts = split_or_condition(name)).size > 1
+            conditions = interpolate_or_conditions(parts)
+            if conditions.any?
+              conditions
+            else
+              nil
+            end
+          end
+        end
+        
+        def split_or_condition(name)
+          parts = name.to_s.split("_or_")
+          new_parts = []
+          parts.each do |part|
+            if part =~ /^equal_to(_any|_all)?$/
+              new_parts << new_parts.pop + "_or_equal_to"
+            else
+              new_parts << part
+            end
+          end
+          new_parts
+        end
+        
+        # The purpose of this method is to convert the method name parts into actual condition names.
+        #
+        # Example:
+        #
+        #   ["first_name", "last_name_like"]
+        #   => ["first_name_like", "last_name_like"]
+        #
+        #   ["id_gt", "first_name_begins_with", "last_name", "middle_name_like"]
+        #   => ["id_gt", "first_name_begins_with", "last_name_like", "middle_name_like"]
+        #
+        # Basically if a column is specified without a condition the next condition in the list
+        # is what will be used. Once we are able to get a consistent list of conditions we can easily
+        # create a scope for it.
+        def interpolate_or_conditions(parts)
+          conditions = []
+          last_condition = nil
+
+          parts.reverse.each do |part|
+            if details = condition_details(part)
+              # We are a searchlogic defined scope
+              conditions << "#{details[:column]}_#{details[:condition]}"
+              last_condition = details[:condition]
+            elsif association_details = association_condition_details(part, last_condition)
+              path = full_association_path(part, last_condition, association_details[:association])
+              conditions << "#{path[:path].join("_").to_sym}_#{path[:column]}_#{path[:condition]}"
+              last_condition = path[:condition] || nil
+            elsif local_condition?(part)
+              # We are a custom scope
+              conditions << part
+            elsif column_names.include?(part)
+              # we are a column, use the last condition
+              if last_condition.nil?
+                raise NoConditionSpecifiedError.new("The '#{part}' column doesn't know which condition to use, if you use an exact column " +
+                  "name you need to specify a condition sometime after (ex: id_or_created_at_lt), where id would use the 'lt' condition.")
+              end
+              
+              conditions << "#{part}_#{last_condition}"
+            else
+              raise UnknownConditionError.new("The condition '#{part}' is not a valid condition, we could not find any scopes that match this.")
+            end
+          end
+          
+          conditions.reverse
+        end
+
+        def full_association_path(part, last_condition, given_assoc)
+            path = [given_assoc.name]
+            part.sub!(/^#{given_assoc.name}_/, "")
+            klass = self
+            while klass = klass.send(:reflect_on_association, given_assoc.name)
+              klass = klass.klass
+              if details = klass.send(:association_condition_details, part, last_condition)
+                path << details[:association]
+                part = details[:condition]
+                given_assoc = details[:association]
+              elsif details = klass.send(:condition_details, part)
+                return { :path => path, :column => details[:column], :condition => details[:condition] }
+              end
+            end
+            { :path => path, :column => part, :condition => last_condition }
+        end
+        
+        def create_or_condition(scopes, args)
+          scopes_options = scopes.collect { |scope, *args| send(scope, *args).proxy_options }
+          # We're using first scope to determine column's type
+          scope = named_scope_options(scopes.first)
+          column_type = scope.respond_to?(:searchlogic_arg_type) ? scope.searchlogic_arg_type : :string
+          named_scope scopes.join("_or_"), searchlogic_lambda(column_type) { |*args|
+            merge_scopes_with_or(scopes.collect { |scope| clone.send(scope, *args) })
+          }
+        end
+        
+        def merge_scopes_with_or(scopes)
+          scopes_options = scopes.collect { |scope| scope.scope(:find) }
+          conditions = scopes_options.reject { |o| o[:conditions].nil? }.collect { |o| sanitize_sql(o[:conditions]) }
+          scope = scopes_options.inject(scoped({})) { |current_scope, options| current_scope.scoped(options) }
+          options = {}
+          in_searchlogic_delegation { options = scope.scope(:find) }
+          options.delete(:readonly) unless scopes.any? { |scope| scope.proxy_options.key?(:readonly) }
+          options.merge(:conditions => "(" + conditions.join(") OR (") + ")")
+        end
+    end
+  end
+end

data/lib/searchlogic/named_scopes/ordering.rb

@@ -0,0 +1,48 @@
+module Searchlogic
+  module NamedScopes
+    # Handles dynamically creating named scopes for ordering by columns. Example:
+    #
+    #   User.ascend_by_id
+    #   User.descend_by_username
+    #
+    # See the README for a more detailed explanation.
+    module Ordering
+      def condition?(name) # :nodoc:
+        super || ordering_condition?(name)
+      end
+      
+      private
+        def ordering_condition?(name) # :nodoc:
+          !ordering_condition_details(name).nil?
+        end
+        
+        def method_missing(name, *args, &block)
+          if name == :order
+            named_scope name, lambda { |scope_name|
+              return {} if !condition?(scope_name)
+              send(scope_name).proxy_options
+            }
+            send(name, *args)
+          elsif details = ordering_condition_details(name)
+            create_ordering_conditions(details[:column])
+            send(name, *args)
+          else
+            super
+          end
+        end
+        
+        def ordering_condition_details(name)
+          if name.to_s =~ /^(ascend|descend)_by_(#{column_names.join("|")})$/
+            {:order_as => $1, :column => $2}
+          elsif name.to_s =~ /^order$/
+            {}
+          end
+        end
+        
+        def create_ordering_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,76 @@
+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</tt> - hash with additional params which will be added to generated url
+    # * <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
+      if !options[:as]
+        id = options[:by].to_s.downcase == "id"
+        options[:as] = id ? options[:by].to_s.upcase : options[:by].to_s.humanize
+      end
+      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
+      url_options = {
+        options[:params_scope] => search.conditions.merge( { :order => new_scope } )
+      }.deep_merge(options[:params] || {})
+      link_to options[:as], url_for(url_options), 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(content_tag("div", hidden_field_tag("#{args.first}[order]", search_obj.order)))
+        super
+      else
+        super
+      end
+    end
+  end
+end

data/lib/searchlogic/search.rb

@@ -0,0 +1,209 @@
+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
+      # Additional method, gets aliased as "search" if that method
+      # is available. A lot of other libraries like to use "search"
+      # as well, so if you have a conflict like this, you can use
+      # this method directly.
+      def searchlogic(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
+    undef :id if respond_to?(:id)
+    
+    # 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
+      @conditions ||= {}
+      self.conditions = conditions if conditions.is_a?(Hash)
+    end
+    
+    def clone
+      self.class.new(klass, current_scope && current_scope.clone, conditions.clone)
+    end
+    
+    # Returns a hash of the current conditions set.
+    def conditions
+      mass_conditions.clone.merge(@conditions)
+    end
+    
+    # Accepts a hash of conditions.
+    def conditions=(values)
+      values.each do |condition, value|
+        mass_conditions[condition.to_sym] = value
+        value.delete_if { |v| ignore_value?(v) } if value.is_a?(Array)
+        next if ignore_value?(value)
+        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)
+        condition_name = condition_name(name)
+        scope_name = scope_name(condition_name)
+        
+        if setter?(name)
+          if scope?(scope_name)
+            if args.size == 1
+              write_condition(condition_name, type_cast(args.first, cast_type(scope_name)))
+            else
+              write_condition(condition_name, args)
+            end
+          else
+            raise UnknownConditionError.new(condition_name)
+          end
+        elsif scope?(scope_name) && args.size <= 1
+          if args.size == 0
+            read_condition(condition_name)
+          else
+            send("#{condition_name}=", *args)
+            self
+          end
+        else
+          scope = conditions_array.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
+            elsif arity == -1
+              scope.send(scope_name, *(value.is_a?(Array) ? value : [value]))
+            else
+              scope.send(scope_name, value)
+            end
+          end
+          scope.send(name, *args, &block)
+        end
+      end
+      
+      # This is here as a hook to allow people to modify the order in which the conditions are called, for whatever reason.
+      def conditions_array
+        @conditions.to_a
+      end
+      
+      def normalize_scope_name(scope_name)
+        case
+        when klass.scopes.key?(scope_name.to_sym) then scope_name.to_sym
+        when klass.column_names.include?(scope_name.to_s) then "#{scope_name}_equals".to_sym
+        else scope_name.to_sym
+        end
+      end
+      
+      def setter?(name)
+        !(name.to_s =~ /=$/).nil?
+      end
+      
+      def condition_name(name)
+        condition = name.to_s.match(/(\w+)=?$/)
+        condition ? condition[1].to_sym : nil
+      end
+      
+      def write_condition(name, value)
+        @conditions[name] = value
+      end
+      
+      def read_condition(name)
+        @conditions[name]
+      end
+      
+      def mass_conditions
+        @mass_conditions ||= {}
+      end
+      
+      def scope_name(condition_name)
+        condition_name && normalize_scope_name(condition_name)
+      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_scope_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) }
+        when Range
+          Range.new(type_cast(value.first, type), type_cast(value.last, 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)
+          casted_value = column_for_type_cast.type_cast(value)
+          
+          if Time.zone && casted_value.is_a?(Time)
+            if value.is_a?(String)
+              (casted_value + (Time.zone.utc_offset * -1)).in_time_zone
+            else
+              casted_value.in_time_zone
+            end
+          else
+            casted_value
+          end
+        end
+      end
+      
+      def ignore_value?(value)
+        (value.is_a?(String) && value.blank?) || (value.is_a?(Array) && value.empty?)
+      end
+  end
+end