searchlogic 1.5.3

data/lib/searchlogic/conditions/protection.rb

@@ -0,0 +1,36 @@
+module Searchlogic
+  module Conditions
+    # = Conditions Protection
+    #
+    # Adds protection from SQL injections. Just set protect = true and it will limit what kind of conditions it will accept.
+    module Protection
+      def self.included(klass)
+        klass.class_eval do
+          attr_reader :protect
+          alias_method_chain :conditions=, :protection
+        end
+      end
+      
+      def conditions_with_protection=(conditions)
+        unless conditions.is_a?(Hash)
+          if protect?
+            return if conditions.blank?
+            raise(ArgumentError, "You can not pass SQL as conditions while the search is being protected, you can only pass a hash")
+          end
+        end
+        
+        self.conditions_without_protection = conditions
+      end
+      
+      def protect=(value)
+        associations.each { |name, obj| obj.protect = value }
+        @protect = value
+      end
+      
+      def protect?
+        protect == true
+      end
+      alias_method :protected?, :protect?
+    end
+  end
+end

data/lib/searchlogic/config.rb

@@ -0,0 +1,31 @@
+module Searchlogic
+  # = Config
+  # Adds default configuration for all of searchlogic. For rails the best place to do this is in config/initializers. Create a file in there called searchlogic.rb with the following content:
+  #
+  # === Example
+  #
+  #   # config/iniitializers/searchlogic.rb
+  #   Searchlogic::Config.configure do |config|
+  #     config.search.per_page = 25
+  #     config.helpers.order_by_link_asc_indicator = "My indicator"
+  #   end
+  #
+  # For a list of all configuration options see Searchlogic::Config::Search and Searchlogic::Config::Helpers
+  class Config
+    class << self
+      # Convenience method for setting configuration
+      # See example at top of class.
+      def configure
+        yield self
+      end
+      
+      def search # :nodoc:
+        Search
+      end
+      
+      def helpers # :nodoc:
+        Helpers
+      end
+    end
+  end
+end

data/lib/searchlogic/config/helpers.rb

@@ -0,0 +1,289 @@
+module Searchlogic
+  class Config
+    # = Helpers Configuration
+    # Provide configuration for searchlogic's rails helpers
+    #
+    # === Example
+    #   Searchlogic::Config.configure do |config|
+    #     config.helpers.order_by_link_asc_indicator = "ASC"
+    #   end
+    class Helpers
+      class << self
+        # Which hidden fields to automatically include when creating a form with a Searchlogic object. See Searchlogic::Helpers::Form for more info.
+        #
+        # * <tt>Default:</tt> [:order_by, :order_as, :per_page]
+        # * <tt>Accepts:</tt> Array, nil, false
+        def hidden_fields
+          @hidden_fields ||= (Searchlogic::Search::Base::SPECIAL_FIND_OPTIONS - [:page, :priority_order])
+        end
+        attr_writer :hidden_fields
+        
+        # Searchlogic does some javascript magic when you use the form helpers with a Searchlogic object. To make configuration easier Searchlogic checks for the existence of Prototype and jQuery and uses the first
+        # one it finds. To cut back on the javascript output you can specify your library here.
+        #
+        # * <tt>Default:</tt> nil
+        # * <tt>Accepts:</tt> :prototype or :jquery
+        def javascript_library
+          @javascript_library
+        end
+        attr_writer :javascript_library
+      
+        # The class name for used in the order_as_link helper
+        #
+        # * <tt>Default:</tt> "order_as"
+        # * <tt>Accepts:</tt> String
+        def order_as_link_class_name
+          @order_as_link_class_name ||= "order_as"
+        end
+        attr_writer :order_as_link_class_name
+        
+        # The class name for used in the order_as_select helper
+        #
+        # * <tt>Default:</tt> "order_as"
+        # * <tt>Accepts:</tt> String
+        def order_as_select_class_name
+          @order_as_select_class_name ||= "order_as"
+        end
+        attr_writer :order_as_select_class_name
+        
+        # The indicator that is used when the sort of a column is ascending
+        #
+        # * <tt>Default:</tt> &nbsp;&#9650;
+        # * <tt>Accepts:</tt> String or a Proc.
+        #
+        # === Examples
+        #
+        #   config.asc_indicator = "(ASC)"
+        #   config.asc_indicator = Proc.new { |template| template.image_tag("asc.jpg") }
+        def order_by_link_asc_indicator
+          @order_by_link_asc_indicator ||= "&nbsp;&#9650;"
+        end
+        attr_writer :order_by_link_asc_indicator
+      
+        # The class name for used in the order_by_link helper
+        #
+        # * <tt>Default:</tt> "order_by"
+        # * <tt>Accepts:</tt> String
+        def order_by_link_class_name
+          @order_by_link_class_name ||= "order_by"
+        end
+        attr_writer :order_by_link_class_name
+      
+        # See order_by_link_asc_indicator=
+        def order_by_link_desc_indicator
+          @order_by_link_desc_indicator ||= "&nbsp;&#9660;"
+        end
+        attr_writer :order_by_link_desc_indicator
+        
+        # The class name used in order_by_links for the link that it is currently ordering by
+        #
+        # * <tt>Default:</tt> "# The class name for used in the page_link helper
+        #
+        # * <tt>Default:</tt> "page"
+        # * <tt>Accepts:</tt> String
+        def order_by_links_ordering_by_class_name
+          @order_by_links_ordering_by_class_name ||= "ordering_by"
+        end
+        attr_writer :order_by_links_ordering_by_class_name
+        
+        # The class name for used in the order_by_select helper
+        #
+        # * <tt>Default:</tt> "order_by"
+        # * <tt>Accepts:</tt> String
+        def order_by_select_class_name
+          @order_by_select_class_name ||= "order_by"
+        end
+        attr_writer :order_by_select_class_name
+        
+        # The class name for used in the page_link helper
+        #
+        # * <tt>Default:</tt> "page"
+        # * <tt>Accepts:</tt> String
+        def page_link_class_name
+          @page_link_class_name ||= "page"
+        end
+        attr_writer :page_link_class_name
+        
+        # The choices used in the per_page_links helper. Works just like per_page_select_choices.
+        def per_page_links_choices
+          @per_page_links_choices ||= per_page_select_choices
+        end
+        attr_writer :per_page_links_choices
+        
+        # The class that the current page link gets.
+        #
+        # * <tt>Default:</tt> "current_page"
+        # * <tt>Accepts:</tt> String, set to nil to disable
+        def page_links_current_page_class_name
+          @page_links_current_page_class_name ||= "current_page"
+        end
+        attr_writer :page_links_current_page_class_name
+        
+        # The class that disabled page links get. Including the current page, prev page, next page, first page, and last page.
+        #
+        # * <tt>Default:</tt> "disabled_page"
+        # * <tt>Accepts:</tt> String, set to nil to disable
+        def page_links_disabled_class_name
+          @page_links_disabled_class_name ||= "disabled_page"
+        end
+        attr_writer :page_links_disabled_class_name
+        
+        # The default for the :first option for the page_links helper.
+        #
+        # * <tt>Default:</tt> nil
+        # * <tt>Accepts:</tt> Anything you want, text, html, etc. nil to disable
+        def page_links_first
+          @page_links_first
+        end
+        attr_writer :page_links_first
+        
+        # The default for the :inner_spread option for the page_links helper.
+        #
+        # * <tt>Default:</tt> 3
+        # * <tt>Accepts:</tt> Any integer >= 1, set to nil to show all pages
+        def page_links_inner_spread
+          @page_links_inner_spread ||= 3
+        end
+        attr_writer :page_links_inner_spread
+        
+        # The class for the first page link
+        #
+        # * <tt>Default:</tt> "first_page"
+        # * <tt>Accepts:</tt> String, nil to disable
+        def page_links_first_page_class_name
+          @page_links_first_page_class_name ||= "first_page"
+        end
+        attr_writer :page_links_first_page_class_name
+        
+        # The default for the :last option for the page_links helper.
+        #
+        # * <tt>Default:</tt> nil
+        # * <tt>Accepts:</tt> Anything you want, text, html, etc. nil to disable
+        def page_links_last
+          @page_links_last
+        end
+        attr_writer :page_links_last
+        
+        # The class for the last page link
+        #
+        # * <tt>Default:</tt> "last_page"
+        # * <tt>Accepts:</tt> String, nil to disable
+        def page_links_last_page_class_name
+          @page_links_last_page_class_name ||= "last_page"
+        end
+        attr_writer :page_links_last_page_class_name
+        
+        # The default for the :next option for the page_links helper.
+        #
+        # * <tt>Default:</tt> "Next >"
+        # * <tt>Accepts:</tt> Anything you want, text, html, etc. nil to disable
+        def page_links_next
+          @page_links_next ||= "Next &gt;"
+        end
+        attr_writer :page_links_next
+        
+        # The class for the next page link
+        #
+        # * <tt>Default:</tt> "next_page"
+        # * <tt>Accepts:</tt> String, nil to disable
+        def page_links_next_page_class_name
+          @page_links_next_page_class_name ||= "next_page"
+        end
+        attr_writer :page_links_next_page_class_name
+        
+        # The default for the :outer_spread option for the page_links helper.
+        #
+        # * <tt>Default:</tt> 2
+        # * <tt>Accepts:</tt> Any integer >= 1, set to nil to display, 0 to only show the "..." separator
+        def page_links_outer_spread
+          @page_links_outer_spread ||= 1
+        end
+        attr_writer :page_links_outer_spread
+        
+        # The class for the previous page link
+        #
+        # * <tt>Default:</tt> "prev_page"
+        # * <tt>Accepts:</tt> String, nil to disable
+        def page_links_prev_page_class_name
+          @page_links_prev_page_class_name ||= "prev_page"
+        end
+        attr_writer :page_links_prev_page_class_name
+        
+        # The default for the :prev option for the page_links helper.
+        #
+        # * <tt>Default:</tt> "< Prev"
+        # * <tt>Accepts:</tt> Anything you want, text, html, etc. nil to disable
+        def page_links_prev
+          @page_links_prev ||= "&lt; Prev"
+        end
+        attr_writer :page_links_prev
+        
+        # The class name for used in the page_seect helper
+        #
+        # * <tt>Default:</tt> "page"
+        # * <tt>Accepts:</tt> String
+        def page_select_class_name
+          @page_select_class_name ||= "page"
+        end
+        attr_writer :page_select_class_name
+        
+        # The class name for used in the per_page_link helper
+        #
+        # * <tt>Default:</tt> "per_page"
+        # * <tt>Accepts:</tt> String
+        def per_page_link_class_name
+          @per_page_link_class_name ||= "per_page"
+        end
+        attr_writer :per_page_link_class_name
+        
+        # The choices used in the per_page_select helper
+        #
+        # * <tt>Default:</tt> [["10 per page", 10], ["25 per page", 25], ["50 per page", 50], ["100 per page", 100], ["150 per page", 150], ["200 per page", 200], ["Show all", nil]]
+        # * <tt>Accepts:</tt> Array
+        def per_page_select_choices
+          return @per_page_select_choices if @per_page_select_choices
+          @per_page_select_choices = []
+          [10, 25, 50, 100, 150, 200].each { |choice| @per_page_select_choices << ["#{choice} per page", choice] }
+          @per_page_select_choices << ["Show all", nil]
+        end
+        attr_writer :per_page_select_choices
+        
+        # The class name for used in the per_page_select helper
+        #
+        # * <tt>Default:</tt> "per_page"
+        # * <tt>Accepts:</tt> String
+        def per_page_select_class_name
+          @per_page_select_class_name ||= "per_page"
+        end
+        attr_writer :per_page_select_class_name
+        
+        # The default value for the :activate_text option for priority_order_by_link
+        #
+        # * <tt>Default:</tt> "Show %s first"
+        # * <tt>Accepts:</tt> String with substitutions, using rubys % method for strings
+        def priority_order_by_link_activate_text
+          @priority_order_by_link_activate_text ||= "Show %s first"
+        end
+        attr_writer :priority_order_by_link_activate_text
+      
+        # The class name for used in the priority_order_by_link helper
+        #
+        # * <tt>Default:</tt> "priority_order_by"
+        # * <tt>Accepts:</tt> String
+        def priority_order_by_link_class_name
+          @priority_order_by_link_class_name ||= "priority_order_by"
+        end
+        attr_writer :priority_order_by_link_class_name
+      
+        # The default value for the :deactivate_text option for priority_order_by_link
+        #
+        # * <tt>Default:</tt> "Dont' show %s first"
+        # * <tt>Accepts:</tt> String with substitutions, using rubys % method for strings
+        def priority_order_by_link_deactivate_text
+          @priority_order_by_link_deactivate_text ||= "Don't show %s first"
+        end
+        attr_writer :priority_order_by_link_deactivate_text
+      end
+    end
+  end
+end

data/lib/searchlogic/config/search.rb

@@ -0,0 +1,53 @@
+module Searchlogic
+  class Config
+    # = Search Configuration
+    # Provides configuration for searchlogic
+    #
+    # === Example
+    #   Searchlogic::Config.configure do |config|
+    #     config.search.per_page = 50
+    #   end
+    class Search
+      class << self
+        # The default for per page. This is only applicaple for protected searches. Meaning you start the search with new_search or new_conditions.
+        # The reason for this not to disturb regular queries such as Whatever.find(:all). You would not expect that to be limited.
+        #
+        # * <tt>Default:</tt> The 2nd option in your per_page_choices, default of 25
+        # * <tt>Accepts:</tt> Any value in your per_page choices, nil or a blank string means "show all"
+        def per_page
+          return @per_page if @set_per_page
+          per_page = Helpers.per_page_select_choices[1]
+          per_page = per_page.last if per_page.is_a?(Array)
+          @per_page = per_page
+        end
+        
+        def per_page=(value)
+          @set_per_page = true
+          @per_page = value
+        end
+        
+        # If you are using ActiveRecord < 2.2.0 then ActiveRecord does not remove duplicates when using the :joins option, when it should. To fix this problem searchlogic does this for you. Searchlogic tries to act
+        # just like ActiveRecord, but in this instance it doesn't make sense.
+        #
+        # As a result, Searchlogic removes all duplicates results in *ALL* search / calculation queries. It does this by forcing the DISTINCT or GROUP BY operation in your SQL. Which might come as a surprise to you
+        # since it is not the "norm". If you don't want searchlogic to do this, set this to false.
+        #
+        # * <tt>Default:</tt> true
+        # * <tt>Accepts:</tt> Boolean
+        def remove_duplicates
+          return @remove_duplicates if @set_remove_duplicates
+          @remove_duplicates ||= true
+        end
+
+        def remove_duplicates? # :nodoc:
+          remove_duplicates == true
+        end
+        
+        def remove_duplicates=(value) # :nodoc:
+          @set_remove_duplicates = true
+          @remove_duplicates = value
+        end
+      end
+    end
+  end
+end

data/lib/searchlogic/core_ext/hash.rb

@@ -0,0 +1,75 @@
+module Searchlogic
+  module CoreExt # :nodoc: all
+    module Hash
+      def deep_dup
+        new_hash = {}
+        
+        self.each do |k, v|
+          case v
+          when Hash
+            new_hash[k] = v.deep_dup
+          else
+            new_hash[k] = v
+          end
+        end
+        
+        new_hash
+      end
+      
+      def deep_delete_duplicate_keys(hash)
+        hash.each do |k, v|
+          if v.is_a?(Hash) && self[k]
+            self[k].deep_delete_duplicate_keys(v)
+            delete(k) if self[k].blank?
+          else
+            delete(k)
+          end
+        end
+        
+        self
+      end
+      
+      def deep_delete(value)
+        case value
+        when Array
+          value.each { |v| deep_delete(v) }
+        when Hash
+          value.each do |k, v|
+            next unless self[k].is_a?(Hash)
+            
+            case v
+            when Hash, Array
+              self[k].deep_delete(v)
+            when String, Symbol
+              self[k].delete(v)
+            end
+          end
+        when String, Symbol
+          delete(value)
+        end
+      end
+      
+      def deep_merge(other_hash)
+        self.merge(other_hash) do |key, oldval, newval|
+          oldval = oldval.to_hash if oldval.respond_to?(:to_hash)
+          newval = newval.to_hash if newval.respond_to?(:to_hash)
+          oldval.class.to_s == 'Hash' && newval.class.to_s == 'Hash' ? oldval.deep_merge(newval) : newval
+        end
+      end
+
+      # Returns a new hash with +self+ and +other_hash+ merged recursively.
+      # Modifies the receiver in place.
+      def deep_merge!(other_hash)
+        replace(deep_merge(other_hash))
+      end
+      
+      # assert_valid_keys was killing performance. Array.flatten was the culprit, so I rewrote this method, got a 35% performance increase
+      def fast_assert_valid_keys(valid_keys)
+        unknown_keys = keys - valid_keys
+        raise(ArgumentError, "Unknown key(s): #{unknown_keys.join(", ")}") unless unknown_keys.empty?
+      end
+    end
+  end
+end
+
+Hash.send(:include, Searchlogic::CoreExt::Hash)