searchgasm 1.4.1 → 1.5.0

data/CHANGELOG.rdoc

@@ -1,9 +1,16 @@
-== 1.4.1 released 2008-10-08
+== 1.5.0 released 2008-10-20
+
+* Merge array of conditions with or or and where it makes sense. Begins with condition does not make sense to join with and, so instead join with or.
+* Cleaned up html validity so it will pass W3C validators
+* Restructure configuration to be more organized and allow for more configuration options.
+* Added more configuration options, especially for class names.
+
+== 1.4.1 released 2008-10-15
 
 * Extracted english text into configuration to support alternate languages. I18n support.
 * Improved method detection in add_joins to use respond_to? with the private method option set to true
 
-== 1.4.0 released 2008-10-08
+== 1.4.0 released 2008-10-15
 
 * Fixed bug when duping or cloning to copy over instance vars instead of method values
 * Fixed bug with older versions of ActiveRecord and creating an alias method chain on find in AssociationCollection

data/Manifest

@@ -32,6 +32,8 @@ lib/searchgasm/condition/sibling_of.rb
 lib/searchgasm/condition/tree.rb
 lib/searchgasm/conditions/base.rb
 lib/searchgasm/conditions/protection.rb
+lib/searchgasm/config/helpers.rb
+lib/searchgasm/config/search.rb
 lib/searchgasm/config.rb
 lib/searchgasm/core_ext/hash.rb
 lib/searchgasm/helpers/control_types/link.rb

data/Rakefile

@@ -10,6 +10,6 @@ Echoe.new 'searchgasm' do |p|
   p.project = 'searchgasm'
   p.summary = "Object based ActiveRecord searching, ordering, pagination, and more!"
   p.url = "http://github.com/binarylogic/searchgasm"
-  p.dependencies = %w(activerecord activesupport)
+  p.dependencies = %w(activerecord activesupport configatron)
   p.include_rakefile = true
 end

data/lib/searchgasm/condition/base.rb

@@ -8,7 +8,7 @@ module Searchgasm
       include Shared::Utilities
       
       attr_accessor :column, :column_for_type_cast, :column_sql, :column_sql_format, :klass, :table_name
-      class_inheritable_accessor :handle_array_value, :ignore_meaningless_value, :value_type
+      class_inheritable_accessor :handle_array_value, :ignore_meaningless_value, :join_arrays_with_or, :value_type
       self.ignore_meaningless_value = true
     
       class << self
@@ -25,6 +25,10 @@ module Searchgasm
           ignore_meaningless_value == true
         end
         
+        def join_arrays_with_or?
+          join_arrays_with_or == true
+        end
+        
         # Determines what to call the condition for the model
         #
         # Searchgasm tries to create conditions on each model. Before it does this it passes the model to this method to see what to call the condition. If the condition type doesnt want to create a condition on
@@ -82,7 +86,7 @@ module Searchgasm
         return if value_is_meaningless?
         v = alt_value || value
         if v.is_a?(Array) && !self.class.handle_array_value?
-          merge_conditions(*v.collect { |i| sanitize(i) })
+          merge_conditions(*v.collect { |i| sanitize(i) } << {:any => self.class.join_arrays_with_or?})
         else
           v = v.utc if column && v.respond_to?(:utc) && [:time, :timestamp, :datetime].include?(column.type) && klass.time_zone_aware_attributes && !klass.skip_time_zone_conversion_for_attributes.include?(column.name.to_sym)
           to_conditions(v)

data/lib/searchgasm/condition/begins_with.rb

@@ -1,6 +1,8 @@
 module Searchgasm
   module Condition
     class BeginsWith < Base
+      self.join_arrays_with_or = true
+      
       class << self
         def condition_names_for_column
           super + ["bw", "sw", "starts_with", "start"]

data/lib/searchgasm/condition/child_of.rb

@@ -1,6 +1,6 @@
 module Searchgasm
   module Condition
-    class ChildOf < Tree
+    class ChildOf < Tree      
       def to_conditions(value)
         parent_association = klass.reflect_on_association(:parent)
         foreign_key_name = (parent_association && parent_association.options[:foreign_key]) || "parent_id"

data/lib/searchgasm/condition/descendant_of.rb

@@ -1,6 +1,6 @@
 module Searchgasm
   module Condition
-    class DescendantOf < Tree
+    class DescendantOf < Tree      
       def to_conditions(value)
         # Wish I knew how to do this in SQL
         root = (value.is_a?(klass) ? value : klass.find(value)) rescue return

data/lib/searchgasm/condition/ends_with.rb

@@ -1,6 +1,8 @@
 module Searchgasm
   module Condition
     class EndsWith < Base
+      self.join_arrays_with_or = true
+      
       class << self
         def condition_names_for_column
           super + ["ew", "ends", "end"]

data/lib/searchgasm/condition/inclusive_descendant_of.rb

@@ -1,6 +1,6 @@
 module Searchgasm
   module Condition
-    class InclusiveDescendantOf < Tree
+    class InclusiveDescendantOf < Tree      
       def to_conditions(value)
         condition = DescendantOf.new(klass, options)
         condition.value = value

data/lib/searchgasm/condition/keywords.rb

@@ -1,6 +1,9 @@
 module Searchgasm
   module Condition
     class Keywords < Base
+      # Because be default it joins with AND, so padding an array just gives you more options. Joining with and is no different than combining all of the words.
+      self.join_arrays_with_or = true
+      
       BLACKLISTED_WORDS = ('a'..'z').to_a + ["about", "an", "are", "as", "at", "be", "by", "com", "de", "en", "for", "from", "how", "in", "is", "it", "la", "of", "on", "or", "that", "the", "the", "this", "to", "und", "was", "what", "when", "where", "who", "will", "with", "www"] # from ranks.nl        
       
       class << self

data/lib/searchgasm/condition/tree.rb

@@ -1,6 +1,8 @@
 module Searchgasm
   module Condition
     class Tree < Base # :nodoc:
+      self.join_arrays_with_or = true
+      
       class << self
         def condition_names_for_column
           []

data/lib/searchgasm/config/helpers.rb

@@ -0,0 +1,268 @@
+module Searchgasm
+  class Config
+    # = Helpers Configuration
+    # Provide configuration for searchgasm's rails helpers
+    #
+    # === Example
+    #   Searchgasm::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 Searchgasm object. See Searchgasm::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 ||= (Searchgasm::Search::Base::SPECIAL_FIND_OPTIONS - [:page, :priority_order])
+        end
+        attr_writer :hidden_fields
+      
+        # 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 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", 25] }
+          @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/searchgasm/config/search.rb

@@ -0,0 +1,53 @@
+module Searchgasm
+  class Config
+    # = Search Configuration
+    # Provides configuration for searchgasm
+    #
+    # === Example
+    #   Searchgasm::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 searchgasm does this for you. Searchgasm tries to act
+        # just like ActiveRecord, but in this instance it doesn't make sense.
+        #
+        # As a result, Searchgasm 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 searchgasm 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/searchgasm/config.rb

@@ -1,14 +1,16 @@
 module Searchgasm
   # = Config
-  # Adds default configuration for all of searchgasm. Just make sure you set your config before you use Searchgasm.
-  # For rails the best place to do this is in config/initializers. Create a file in there called searchgasm.rb with the following content:
+  # Adds default configuration for all of searchgasm. For rails the best place to do this is in config/initializers. Create a file in there called searchgasm.rb with the following content:
   #
   # === Example
   #
   #   # config/iniitializers/searchgasm.rb
   #   Searchgasm::Config.configure do |config|
-  #     config.you_option_here = your_value # see methods below
+  #     config.search.per_page = 25
+  #     config.helpers.order_by_link_asc_indicator = "My indicator"
   #   end
+  #
+  # For a list of all configuration options see Searchgasm::Config::Search and Searchgasm::Config::Helpers
   class Config
     class << self
       # Convenience method for setting configuration
@@ -17,212 +19,12 @@ module Searchgasm
         yield self
       end
       
-      def asc_indicator # :nodoc:
-        @asc_indicator ||= "&nbsp;&#9650;"
-      end
-      
-      # 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 asc_indicator=(value)
-        @asc_indicator = value
-      end
-      
-      def desc_indicator # :nodoc:
-        @desc_indicator ||= "&nbsp;&#9660;"
-      end
-      
-      # See asc_indicator=
-      def desc_indicator=(value)
-        @desc_indicator = value
-      end
-      
-      def hidden_fields # :nodoc:
-        @hidden_fields ||= (Search::Base::SPECIAL_FIND_OPTIONS - [:page, :priority_order])
-      end
-      
-      # Which hidden fields to automatically include when creating a form with a Searchgasm object. See Searchgasm::Helpers::Form for more info.
-      #
-      # * <tt>Default:</tt> [:order_by, :order_as, :per_page]
-      # * <tt>Accepts:</tt> Array, nil, false
-      def hidden_fields=(value)
-        @hidden_fields = value
-      end
-      
-      def page_links_first # :nodoc:
-        @page_links_first
-      end
-      
-      # 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=(value)
-        @page_links_first = value
-      end
-      
-      def page_links_last # :nodoc:
-        @page_links_last
-      end
-      
-      # 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=(value)
-        @page_links_last = value
-      end
-      
-      def page_links_inner_spread # :nodoc:
-        @page_links_inner_spread ||= 3
-      end
-      
-      # 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=(value)
-        @page_links_inner_spread = value
-      end
-      
-      def page_links_outer_spread # :nodoc:
-        @page_links_outer_spread ||= 1
-      end
-      
-      # 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=(value)
-        @page_links_outer_spread = value
-      end
-      
-      def page_links_next # :nodoc:
-        @page_links_next ||= "Next >"
-      end
-      
-      # 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=(value)
-        @page_links_next = value
-      end
-      
-      def page_links_prev # :nodoc:
-        @page_links_prev ||= "< Prev"
-      end
-      
-      # 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=(value)
-        @page_links_prev = value
-      end
-      
-      def per_page # :nodoc:
-        @per_page ||= per_page_choices[1]
-      end
-      
-      # 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 3rd option in your per_page_choices, default of 50
-      # * <tt>Accepts:</tt> Any value in your per_page choices, nil or a blank string means "show all"
-      def per_page=(value)
-        @per_page = value
-      end
-      
-      def per_page_choices # :nodoc:
-        @per_page_choices ||= [10, 25, 50, 100, 150, 200, nil]
-      end
-      
-      # The choices used in the per_page helper
-      #
-      # * <tt>Default:</tt> [10, 25, 50, 100, 150, 200, nil]
-      # * <tt>Accepts:</tt> Array
-      #
-      # nil means "Show all"
-      def per_page_choices=(value)
-        @per_page_choices = value
-      end
-      
-      def per_page_show_all_text # :nodoc:
-        @per_page_show_all_text ||= "Show all"
-      end
-      
-      # The default value for the :text option for per_page_links and per_page_select when the page is nil, meaning show all.
-      #
-      # * <tt>Default:</tt> "Show all"
-      # * <tt>Accepts:</tt> String
-      def per_page_show_all_text=(value)
-        @per_page_show_all_text = value
-      end
-      
-      def per_page_text # :nodoc:
-        @per_page_text ||= "%s per page"
-      end
-      
-      # The default value for the :text option for per_page_links and per_page_select when the page is NOT nil. Only one substitution is
-      # passed, which is the per_page value.
-      #
-      # * <tt>Default:</tt> "%s per page"
-      # * <tt>Accepts:</tt> String with substitutions, using rubys % method for strings
-      def per_page_text=(value)
-        @per_page_text = value
-      end
-      
-      def priority_order_by_link_activate_text # :nodoc:
-        @priority_order_by_link_activate_text ||= "Show %s first"
-      end
-      
-      # 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=(value)
-        @priority_order_by_link_activate_text = value
-      end
-      
-      def priority_order_by_link_deactivate_text # :nodoc:
-        @priority_order_by_link_deactivate_text ||= "Don't show %s first"
-      end
-      
-      # 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=(value)
-        @priority_order_by_link_deactivate_text = value
-      end
-      
-      def remove_duplicates # :nodoc:
-        return @remove_duplicates if @set_remove_duplicates
-        @remove_duplicates ||= true
-      end
-      
-      def remove_duplicates? # :nodoc:
-        remove_duplicates == true
+      def search # :nodoc:
+        Search
       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 searchgasm does this for you. Searchgasm tries to act
-      # just like ActiveRecord, but in this instance it doesn't make sense.
-      #
-      # As a result, Searchgasm 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 searchgasm to do this, set this to false.
-      #
-      # * <tt>Default:</tt> true
-      # * <tt>Accepts:</tt> Boolean
-      def remove_duplicates=(value)
-        @set_remove_duplicates = true
-        @remove_duplicates = value
+      def helpers # :nodoc:
+        Helpers
       end
     end
   end

data/lib/searchgasm/helpers/control_types/link.rb

@@ -181,8 +181,6 @@ module Searchgasm
         # As you can see above, passing nil means "show all" and the text will automatically revert to "show all"
         #
         # === Options
-        # * <tt>:text</tt> -- default: "%s per page", text for the link, only if per_page is not blank
-        # * <tt>:show_all_text</tt> -- default: "Show all", text for the link, only if per_page is blank
         # * <tt>:html</tt> -- html arrtributes for the <a> tag.
         #
         # === Advanced Options
@@ -239,29 +237,32 @@ module Searchgasm
         
         private
           def add_order_by_link_defaults!(order_by, options = {})
-            add_searchgasm_control_defaults!(:order_by, options)
+            add_searchgasm_control_defaults!(options)
+            searchgasm_add_class!(options[:html], Config.helpers.order_by_link_class_name)
             ordering_by_this = searchgasm_ordering_by?(order_by, options)
             searchgasm_add_class!(options[:html], "ordering") if ordering_by_this
             options[:text] ||= determine_order_by_text(order_by)
-            options[:asc_indicator] ||= Config.asc_indicator
-            options[:desc_indicator] ||= Config.desc_indicator
+            options[:asc_indicator] ||= Config.helpers.order_by_link_asc_indicator
+            options[:desc_indicator] ||= Config.helpers.order_by_link_desc_indicator
             options[:text] += options[:search_obj].desc? ? options[:desc_indicator] : options[:asc_indicator] if ordering_by_this
             options[:url] = searchgasm_params(options.merge(:search_params => {:order_by => order_by}))
             options
           end
           
           def add_order_as_link_defaults!(order_as, options = {})
-            add_searchgasm_control_defaults!(:order_as, options)
+            add_searchgasm_control_defaults!(options)
+            searchgasm_add_class!(options[:html], Config.helpers.order_as_link_class_name)
             options[:text] ||= order_as.to_s
             options[:url] = searchgasm_params(options.merge(:search_params => {:order_as => order_as}))
             options
           end
           
           def add_priority_order_by_link_defaults!(priority_order_by, priority_order_as, options = {})
-            add_searchgasm_control_defaults!(:priority_order_by, options)
+            add_searchgasm_control_defaults!(options)
+            searchgasm_add_class!(options[:html], Config.helpers.priority_order_by_link_class_name)
             options[:column_name] ||= determine_order_by_text(priority_order_by).downcase 
-            options[:activate_text] ||= Config.priority_order_by_link_activate_text % options[:column_name]
-            options[:deactivate_text] ||= Config.priority_order_by_link_deactivate_text % options[:column_name]
+            options[:activate_text] ||= Config.helpers.priority_order_by_link_activate_text % options[:column_name]
+            options[:deactivate_text] ||= Config.helpers.priority_order_by_link_deactivate_text % options[:column_name]
             active = deep_stringify(options[:search_obj].priority_order_by) == deep_stringify(priority_order_by) && options[:search_obj].priority_order_as == priority_order_as
             options[:text] ||= active ? options[:deactivate_text] : options[:activate_text]
             if active
@@ -274,15 +275,16 @@ module Searchgasm
           end
           
           def add_per_page_link_defaults!(per_page, options = {})
-            add_searchgasm_control_defaults!(:per_page, options)
-            options[:show_all_text] ||= Config.per_page_show_all_text
-            options[:text] ||= per_page.blank? ? options[:show_all_text] : Config.per_page.text % per_page
+            add_searchgasm_control_defaults!(options)
+            searchgasm_add_class!(options[:html], Config.helpers.per_page_link_class_name)
+            options[:text] ||= per_page.to_s
             options[:url] = searchgasm_params(options.merge(:search_params => {:per_page => per_page}))
             options
           end
           
           def add_page_link_defaults!(page, options = {})
-            add_searchgasm_control_defaults!(:page, options)
+            add_searchgasm_control_defaults!(options)
+            searchgasm_add_class!(options[:html], Config.helpers.page_link_class_name)
             options[:text] ||= page.to_s
             options[:url] = searchgasm_params(options.merge(:search_params => {:page => page}))
             options

data/lib/searchgasm/helpers/control_types/links.rb

@@ -16,10 +16,15 @@ module Searchgasm
         # * <tt>:choices</tt> -- default: the models column names, the choices to loop through when calling order_by_link
         def order_by_links(options = {})
           add_order_by_links_defaults!(options)
-          link_options = options.deep_dup
-          link_options.delete(:choices)
+          links_options = options.deep_dup
+          links_options.delete(:choices)
           html = ""
-          options[:choices].each { |choice| html += order_by_link(choice, link_options.deep_dup) }
+          options[:choices].each do |choice|
+            link_options = links_option.deep_dup
+            text, value = option_text_and_value(choice)
+            link_options[:text] ||= text
+            html += order_by_link(value, link_options)
+          end
           html
         end
         
@@ -37,10 +42,15 @@ module Searchgasm
         # * <tt>:choices</tt> -- default: ["asc", "desc"], the choices to loop through when calling order_as_link
         def order_as_links(options = {})
           add_order_as_links_defaults!(options)
-          link_options = options.deep_dup
-          link_options.delete(:choices)
+          links_options = options.deep_dup
+          links_options.delete(:choices)
           html = ""
-          options[:choices].each { |choice| html += order_as_link(choice, link_options.deep_dup) }
+          options[:choices].each do |choice|
+            link_options = links_option.deep_dup
+            text, value = option_text_and_value(choice)
+            link_options[:text] ||= text
+            html += order_as_link(value, link_options)
+          end
           html
         end
         
@@ -55,13 +65,18 @@ module Searchgasm
         #
         # Please look at per_page_link. All options there are applicable here and are passed onto each option.
         #
-        # * <tt>:choices</tt> -- default: [10, 25, 50, 100, 150, 200, nil], the choices to loop through when calling per_page_link.
+        # * <tt>:choices</tt> -- default: [["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]]
         def per_page_links(options = {})
           add_per_page_links_defaults!(options)
-          link_options = options.deep_dup
-          link_options.delete(:choices)
+          links_options = options.deep_dup
+          links_options.delete(:choices)
           html = ""
-          options[:choices].each { |choice| html += per_page_link(choice, link_options.deep_dup) }
+          options[:choices].each do |choice|
+            link_options = links_option.deep_dup
+            text, value = option_text_and_value(choice)
+            link_options[:text] ||= text
+            html += per_page_link(value, link_options)
+          end
           html
         end
         
@@ -148,41 +163,45 @@ module Searchgasm
         
         private
           def add_order_by_links_defaults!(options)
-            add_searchgasm_control_defaults!(:order_by, options)
+            add_searchgasm_control_defaults!(options)
             options[:choices] ||= options[:search_obj].klass.column_names.map(&:humanize)
             options
           end
           
           def add_order_as_links_defaults!(options)
-            add_searchgasm_control_defaults!(:order_as, options)
+            add_searchgasm_control_defaults!(options)
             options[:choices] = [:asc, :desc]
             options
           end
           
           def add_per_page_links_defaults!(options)
-            add_searchgasm_control_defaults!(:per_page, options)
-            options[:choices] ||= Config.per_page_choices.dup
+            add_searchgasm_control_defaults!(options)
+            options[:choices] ||= Config.helpers.per_page_links_choices.dup
             if !options[:search_obj].per_page.blank? && !options[:choices].include?(options[:search_obj].per_page)
               options[:choices] << options[:search_obj].per_page
               has_nil = options[:choices].include?(nil)
               options[:choices].compact!
-              options[:choices].sort!
+              options[:choices].sort! do |a, b|
+                a_value = (a.is_a?(Array) ? a.last : a).to_i
+                b_value = (b.is_a?(Array) ? b.last : b).to_i
+                a_value <=> b_value
+              end
               options[:choices] << nil if has_nil
             end
             options
           end
           
           def add_page_links_defaults!(options)
-            add_searchgasm_control_defaults!(:page, options)
+            add_searchgasm_control_defaults!(options)
             options[:first_page] ||= 1
             options[:last_page] ||= options[:search_obj].page_count
             options[:current_page] ||= options[:search_obj].page
-            options[:inner_spread] = Config.page_links_inner_spread unless options.has_key?(:inner_spread)
-            options[:outer_spread] = Config.page_links_outer_spread unless options.has_key?(:outer_spread)
-            options[:prev] = Config.page_links_prev unless options.has_key?(:prev)
-            options[:next] = Config.page_links_next unless options.has_key?(:next)
-            options[:first] = Config.page_links_first unless options.has_key?(:first)
-            options[:last] = Config.page_links_last unless options.has_key?(:last)
+            options[:inner_spread] = Config.helpers.page_links_inner_spread unless options.has_key?(:inner_spread)
+            options[:outer_spread] = Config.helpers.page_links_outer_spread unless options.has_key?(:outer_spread)
+            options[:prev] = Config.helpers.page_links_prev unless options.has_key?(:prev)
+            options[:next] = Config.helpers.page_links_next unless options.has_key?(:next)
+            options[:first] = Config.helpers.page_links_first unless options.has_key?(:first)
+            options[:last] = Config.helpers.page_links_last unless options.has_key?(:last)
             options
           end
           
@@ -193,14 +212,17 @@ module Searchgasm
             when Fixnum
               text = name
               page = name
-              searchgasm_add_class!(options[:html], "current_page") if span
+              searchgasm_add_class!(options[:html], Config.helpers.page_links_current_page_class_name) if span
             else
               text = options[name]
               page = options[:search_obj].send("#{name}_page")
-              searchgasm_add_class!(options[:html], "#{name}_page")
+              searchgasm_add_class!(options[:html], Config.helpers.send("page_links_#{name}_page_class_name"))
             end
             
-            searchgasm_add_class!(options[:html], "disabled_page") if span
+            if span
+              searchgasm_add_class!(options[:html], Config.helpers.page_links_disabled_class_name)
+              searchgasm_add_class!(options[:html], "page")
+            end
             options[:text] = text
             span ? content_tag(:span, text, options[:html]) : page_link(page, options)
           end

data/lib/searchgasm/helpers/control_types/select.rb

@@ -32,27 +32,28 @@ module Searchgasm
         private
           def add_order_by_select_defaults!(options)
             add_order_by_links_defaults!(options)
+            searchgasm_add_class!(options[:html], Config.helpers.order_by_select_class_name)
             add_searchgasm_select_defaults!(:order_by, options)
             options
           end
           
           def add_order_as_select_defaults!(options)
             add_order_as_links_defaults!(options)
+            searchgasm_add_class!(options[:html], Config.helpers.order_as_select_class_name)
             add_searchgasm_select_defaults!(:order_as, options)
             options
           end
           
           def add_per_page_select_defaults!(options)
             add_per_page_links_defaults!(options)
-            options[:show_all_text] ||= Config.per_page_show_all_text
-            options[:text] ||= Config.per_page_text
-            options[:choices] = options[:choices].collect { |choice| choice.nil? ? [options[:show_all_text], choice] : [options[:text] % choice, choice]}
+            searchgasm_add_class!(options[:html], Config.helpers.per_page_select_class_name)
             add_searchgasm_select_defaults!(:per_page, options)
             options
           end
           
           def add_page_select_defaults!(options)
             add_page_links_defaults!(options)
+            searchgasm_add_class!(options[:html], Config.helpers.page_select_class_name)
             add_searchgasm_select_defaults!(:page, options)
             options
           end

data/lib/searchgasm/helpers/form.rb

@@ -55,12 +55,12 @@ module Searchgasm
           def extract_searchgasm_options!(args)
             options = args.extract_options!
             searchgasm_options = {}
-            [:hidden_fields].each { |option| searchgasm_options[option] = options.has_key?(option) ? options.delete(option) : Config.send(option) }
+            [:hidden_fields].each { |option| searchgasm_options[option] = options.has_key?(option) ? options.delete(option) : Config.helpers.send(option) }
             searchgasm_options[:hidden_fields] = [searchgasm_options[:hidden_fields]].flatten.compact
             args << options
             searchgasm_options
           end
-        
+          
           def searchgasm_args(args, search_object, search_options, for_helper = nil)
             args = args.dup
             first = args.shift
@@ -93,7 +93,7 @@ module Searchgasm
               
                 javascript = "if(typeof(Prototype) != 'undefined') {"
                 search_options[:hidden_fields].each { |field| javascript += "field = $('#{name}_#{field}'); if(field) { $('#{name}_#{field}_hidden').value = field.value; }" }
-                javascript += "} else if(jQuery) {"
+                javascript += "} else if(typeof(jQuery) != 'undefined') {"
                 search_options[:hidden_fields].each { |field| javascript += "field = $('##{name}_#{field}'); if(field) { $('##{name}_#{field}_hidden').val(field.val()); }" }
                 javascript += "}"
               

data/lib/searchgasm/helpers/utilities.rb

@@ -127,16 +127,15 @@ module Searchgasm
         end
         
         # Adds default options for all control type helper methods.
-        def add_searchgasm_control_defaults!(option, options)
+        def add_searchgasm_control_defaults!(options)
           add_searchgasm_defaults!(options)
           options[:html] ||= {}
-          options[:html][:class] ||= ""
-          searchgasm_add_class!(options[:html], option)
           options
         end
         
         def searchgasm_add_class!(html_options, new_class)
           new_class = new_class.to_s
+          html_options[:class] ||= ""
           classes = html_options[:class].split(" ")
           classes << new_class unless classes.include?(new_class)
           html_options[:class] = classes.join(" ")

data/lib/searchgasm/search/base.rb

@@ -92,7 +92,7 @@ module Searchgasm #:nodoc:
       end
       
       def limit
-        @limit ||= Config.per_page if !acting_as_filter? && !@set_limit
+        @limit ||= Config.search.per_page if !acting_as_filter? && !@set_limit
         @limit
       end
       
@@ -120,7 +120,7 @@ module Searchgasm #:nodoc:
       end
       
       def select
-        @select ||= "DISTINCT #{klass.connection.quote_table_name(klass.table_name)}.*" if !joins.blank? && Config.remove_duplicates?
+        @select ||= "DISTINCT #{klass.connection.quote_table_name(klass.table_name)}.*" if !joins.blank? && Config.search.remove_duplicates?
         @select
       end
       

data/lib/searchgasm/search/ordering.rb

@@ -170,7 +170,7 @@ module Searchgasm
           
           case order_by
           when Array
-            order_by.each { |part| sql_parts << order_by_to_order(part, order_as) }
+            order_by.each { |part| sql_parts << order_by_to_order(part, order_as, alt_klass) }
           when Hash
             raise(ArgumentError, "when passing a hash to order_by you must only have 1 key: {:user_group => :name} not {:user_group => :name, :user_group => :id}. The latter should be [{:user_group => :name}, {:user_group => :id}]") if order_by.keys.size != 1
             key = order_by.keys.first

data/lib/searchgasm/version.rb

@@ -66,8 +66,8 @@ module Searchgasm
     end
 
     MAJOR = 1
-    MINOR = 4
-    TINY  = 1
+    MINOR = 5
+    TINY  = 0
 
     # The current version as a Version instance
     CURRENT = new(MAJOR, MINOR, TINY)

data/lib/searchgasm.rb

@@ -21,6 +21,8 @@ require "searchgasm/shared/virtual_classes"
 
 # Base classes
 require "searchgasm/version"
+require "searchgasm/config/helpers"
+require "searchgasm/config/search"
 require "searchgasm/config"
 
 # ActiveRecord

data/searchgasm.gemspec

@@ -1,18 +1,18 @@
 
-# Gem::Specification for Searchgasm-1.4.1
+# Gem::Specification for Searchgasm-1.5.0
 # Originally generated by Echoe
 
 --- !ruby/object:Gem::Specification 
 name: searchgasm
 version: !ruby/object:Gem::Version 
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic
 autorequire: 
 bindir: bin
 
-date: 2008-10-15 00:00:00 -04:00
+date: 2008-10-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,6 +35,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: configatron
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: echoe
   type: :development
@@ -84,6 +94,8 @@ extra_rdoc_files:
 - lib/searchgasm/condition/tree.rb
 - lib/searchgasm/conditions/base.rb
 - lib/searchgasm/conditions/protection.rb
+- lib/searchgasm/config/helpers.rb
+- lib/searchgasm/config/search.rb
 - lib/searchgasm/config.rb
 - lib/searchgasm/core_ext/hash.rb
 - lib/searchgasm/helpers/control_types/link.rb
@@ -181,6 +193,8 @@ files:
 - lib/searchgasm/condition/tree.rb
 - lib/searchgasm/conditions/base.rb
 - lib/searchgasm/conditions/protection.rb
+- lib/searchgasm/config/helpers.rb
+- lib/searchgasm/config/search.rb
 - lib/searchgasm/config.rb
 - lib/searchgasm/core_ext/hash.rb
 - lib/searchgasm/helpers/control_types/link.rb

data/test/test_config.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/test_helper.rb'
 
 class TestConfig < Test::Unit::TestCase
   def test_per_page
-    Searchgasm::Config.per_page = 1
+    Searchgasm::Config.search.per_page = 1
     
     assert Account.count > 1
     assert Account.all.size > 1
@@ -11,7 +11,7 @@ class TestConfig < Test::Unit::TestCase
     assert User.new_search.all.size == 1
     assert User.new_search(:per_page => nil).all.size > 1
     
-    Searchgasm::Config.per_page = nil
+    Searchgasm::Config.search.per_page = nil
     
     assert Account.count > 1
     assert Account.all.size > 1
@@ -20,6 +20,4 @@ class TestConfig < Test::Unit::TestCase
     assert User.new_search.all.size > 1
     assert User.new_search(:per_page => 1).all.size == 1
   end
-  
-  # test that config options do not mess up regular AR searches
 end

data/test/test_search_pagination.rb

@@ -63,7 +63,7 @@ class TestSearchPagination < Test::Unit::TestCase
     search.per_page = 100
     assert_equal 1, search.page_count
     
-    Searchgasm::Config.per_page = 1
+    Searchgasm::Config.search.per_page = 1
     search = Account.new_search
     assert_equal 3, search.page_count    
     search.conditions.users.first_name_contains

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: searchgasm
 version: !ruby/object:Gem::Version 
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-15 00:00:00 -04:00
+date: 2008-10-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: configatron
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: echoe
   type: :development
@@ -81,6 +91,8 @@ extra_rdoc_files:
 - lib/searchgasm/condition/tree.rb
 - lib/searchgasm/conditions/base.rb
 - lib/searchgasm/conditions/protection.rb
+- lib/searchgasm/config/helpers.rb
+- lib/searchgasm/config/search.rb
 - lib/searchgasm/config.rb
 - lib/searchgasm/core_ext/hash.rb
 - lib/searchgasm/helpers/control_types/link.rb
@@ -178,6 +190,8 @@ files:
 - lib/searchgasm/condition/tree.rb
 - lib/searchgasm/conditions/base.rb
 - lib/searchgasm/conditions/protection.rb
+- lib/searchgasm/config/helpers.rb
+- lib/searchgasm/config/search.rb
 - lib/searchgasm/config.rb
 - lib/searchgasm/core_ext/hash.rb
 - lib/searchgasm/helpers/control_types/link.rb