searchgasm 1.0.4 → 1.1.0

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+== 1.1.0 released 2008-09-18
+
+* Added the options :inner_spread and :outer_spread to the page_links helper. Also added various config options for setting page_links defaults.
+* Updated calculation methods to ignore :limit and :offset. AR returns 0 or nil on calculations that provide an offset.
+* Added support to allow for "any" of the conditions, instead of all of them. Joins conditions with "or" instead of "and". See Searchgasm::Conditions::Base or the readme
+
 == 1.0.4 released 2008-09-18
 
 * Fixed bugs when performing calculations and searches on has_many through relationships.

data/README.rdoc

@@ -189,6 +189,16 @@ Don't need pagination, ordering, or any of the other options? Search with condit
 Pass a conditions object right into ActiveRecord:
 
   User.all(:conditions => conditions)
+  
+== Match ANY or ALL of the conditions
+
+As you saw above, the nice thing about Searchgasm is it's integration with forms. I designed the "any" option so that forms can set this as well, just like a condition.
+
+  search = User.new_search(:conditions => {:age_gt => 18})
+  search.conditions.first_name_contains = "Ben"
+  search.conditions.any = true # can set this to "true" or "1" or "yes"
+  search.all # will join all conditions with "or" instead of "and"
+  # ... all operations above are available
 
 == Scoped searching
 

data/lib/searchgasm/conditions/base.rb

@@ -9,7 +9,7 @@ module Searchgasm
       include Searchgasm::Shared::Searching
       include Searchgasm::Shared::VirtualClasses
       
-      attr_accessor :relationship_name, :sql
+      attr_accessor :any, :relationship_name, :sql
       
       class << self
         attr_accessor :added_klass_conditions, :added_column_conditions, :added_associations
@@ -66,6 +66,7 @@ module Searchgasm
         
         def needed?(model_class, conditions) # :nodoc:
           if conditions.is_a?(Hash)
+            return true if conditions[:any]
             column_names = model_class.column_names
             conditions.stringify_keys.keys.each do |condition|
               return true unless column_names.include?(condition)
@@ -83,10 +84,31 @@ module Searchgasm
         self.conditions = init_conditions
       end
       
+      # Determines if we should join the conditions with "AND" or "OR".
+      #
+      # === Examples
+      #
+      #   search.conditions.any = true # will join all conditions with "or", you can also set this to "true", "1", or "yes"
+      #   search.conditions.any = false # will join all conditions with "and"
+      def any=(value)
+        associations.each { |association| association.any = value }
+        @any = value
+      end
+      
+      def any # :nodoc:
+        any?
+      end
+      
+      # Convenience method for determining if we should join the conditions with "AND" or "OR".
+      def any?
+        @any == true || @any == "true" || @any == "1" || @any == "yes"
+      end
+      
       # A list of includes to use when searching, includes relationships
       def includes
         i = []
         associations.each do |association|
+          next if association.conditions.blank?
           association_includes = association.includes
           i << (association_includes.blank? ? association.relationship_name.to_sym : {association.relationship_name.to_sym => association_includes})
         end
@@ -101,10 +123,10 @@ module Searchgasm
       end
       
       # Sanitizes the conditions down into conditions that ActiveRecord::Base.find can understand.
-      def sanitize(any = false)
-        conditions = merge_conditions(*objects.collect { |object| object.sanitize })
+      def sanitize
+        conditions = merge_conditions(*(objects.collect { |object| object.sanitize } << {:any => any}))
         return sql if conditions.blank?
-        merged_conditions = merge_conditions(conditions, sql)
+        merged_conditions = merge_conditions(conditions, sql, :any => any)
         merged_conditions
       end
       
@@ -123,8 +145,7 @@ module Searchgasm
       def conditions
         conditions_hash = {}
         objects.each do |object|
-          case object
-          when self.class
+          if object.class < Searchgasm::Conditions::Base
             relationship_conditions = object.conditions
             next if relationship_conditions.blank?
             conditions_hash[object.relationship_name.to_sym] = relationship_conditions
@@ -218,7 +239,7 @@ module Searchgasm
         end
         
         def assert_valid_conditions(conditions)
-          conditions.stringify_keys.fast_assert_valid_keys(self.class.condition_names + self.class.association_names)
+          conditions.stringify_keys.fast_assert_valid_keys(self.class.condition_names + self.class.association_names + ["any"])
         end
         
         def associations

data/lib/searchgasm/config.rb

@@ -43,6 +43,78 @@ module Searchgasm
         @desc_indicator = 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 ||= 2
+      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
       end

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

@@ -1,9 +1,6 @@
 module Searchgasm
   module Helpers
     module ControlTypes
-      # = Links Control Types
-      #
-      # These helpers create a group of links to help navigate through search data.
       module Links
         # Creates a group of links that order the data by a column or columns. All that this does is loop through the :choices option and call order_by_link and then glue it all together.
         #
@@ -14,7 +11,7 @@ module Searchgasm
         #
         # === Options
         #
-        # Please look at order_by_link. All options there are applicable here and are passed onto each option. Here are the options specific to this method:
+        # Please look at order_by_link. All options there are applicable here and are passed onto each option.
         #
         # * <tt>:choices</tt> -- default: the models column names, the choices to loop through when calling order_by_link
         def order_by_links(options = {})
@@ -35,7 +32,7 @@ module Searchgasm
         #
         # === Options
         #
-        # Please look at order_as_link. All options there are applicable here and are passed onto each option. Here are the options specific to this method:
+        # Please look at order_as_link. All options there are applicable here and are passed onto each option.
         #
         # * <tt>:choices</tt> -- default: ["asc", "desc"], the choices to loop through when calling order_as_link
         def order_as_links(options = {})
@@ -56,7 +53,7 @@ module Searchgasm
         #
         # === Options
         #
-        # Please look at per_page_link. All options there are applicable here and are passed onto each option. Here are the options specific to this method:
+        # 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.
         def per_page_links(options = {})
@@ -75,7 +72,7 @@ module Searchgasm
         #   page_links
         #   page_links(:first => "<< First", :last => "Last >>")
         #
-        # === Classes and tag
+        # === Classes and tags
         #
         # If the user is on the current page they will get a <span> tag, not an <a> tag. If they are on the first page the "first" and "prev" options will be a <span> also. The same goes
         # for "next" and "last" if the user is on the last page. Other than that each element will come with a CSS class so you can style it to your liking. Somtimes the easiest way to understand this
@@ -83,7 +80,7 @@ module Searchgasm
         #
         # * <tt>page</tt> - This is in *every* element, span or a.
         # * <tt>first_page</tt> - This is for the "first page" element only.
-        # * <tt>preve_page</tt> - This is for the "prev page" element only.
+        # * <tt>prev_page</tt> - This is for the "prev page" element only.
         # * <tt>current_page</tt> - This is for the current page element
         # * <tt>next_page</tt> - This is for the "next page" element only.
         # * <tt>last_page</tt> - This is for the "last page" element only.
@@ -91,33 +88,64 @@ module Searchgasm
         #
         # === Options
         #
-        # Please look at per_page_link. All options there are applicable here and are passed onto each option. Here are the options specific to this method:
-        #
-        # * <tt>:spread</tt> -- default: 3, set to nil to show all page, this represents how many choices available on each side of the current page
-        # * <tt>:prev</tt> -- default: "< Prev", set to nil to omit. This is an extra link on the left side of the page links that will go to the previous page
-        # * <tt>:next</tt> -- default: "Next >", set to nil to omit. This is an extra link on the right side of the page links that will go to the next page
+        # Please look at per_page_link. All options there are applicable here and are passed onto each option.
+        #
+        # * <tt>:inner_spread</tt> -- default: 3, set to nil to show all pages, this represents how many choices available on each side of the current page
+        # * <tt>:outer_spread</tt> -- default: 1, set to nil to disable, this represents how many choices are in the "outer" spread. If set to 0, the separator will be present with no page links. This option changes the links from 
+        # *                  "< Prev 2 3 4 [5] 6 7 8 Next >" with 10 total pages to:
+        # *                  "< Prev ... 3 4 [5] 6 7 ... Next >" for :outer_spread = 0 and :inner_spread = 3
+        # *                  "< Prev 1 ... 3 4 [5] 6 7 ... 10 Next >" for :outer_spread = 1 and :inner_spread = 3
+        # *                  "< Prev 1 2 ... 3 4 [5] 6 7 ... 9 10 Next >" for :outer_spread = 2 and :inner_spread = 3 (outer_spread = number of absolute pages on each side)
+        # *                  Outer spread pages will not be visible unless the current_page is more than :inner_spread away from the first or last page.
+        # * <tt>:prev</tt> -- default: < Prev, set to nil to omit. This is an extra link on the left side of the page links that will go to the previous page
+        # * <tt>:next</tt> -- default: Next >, set to nil to omit. This is an extra link on the right side of the page links that will go to the next page
         # * <tt>:first</tt> -- default: nil, set to nil to omit. This is an extra link on thefar left side of the page links that will go to the first page
         # * <tt>:last</tt> -- default: nil, set to nil to omit. This is an extra link on the far right side of the page links that will go to the last page
         def page_links(options = {})
           add_page_links_defaults!(options)
           return if options[:last_page] <= 1
           
-          first_page = 0
-          last_page = 0
-          if !options[:spread].blank?
-            first_page = options[:current_page] - options[:spread]
-            first_page = options[:first_page] if first_page < options[:first_page]
-            last_page = options[:current_page] + options[:spread]
-            last_page = options[:last_page] if last_page > options[:last_page]
+          inner_spread_start = inner_spread_end = lower_gap = lower_outer_spread_start = lower_outer_spread_end = upper_gap = upper_outer_spread_start = upper_outer_spread_end = 0
+          if !options[:inner_spread].blank?
+            inner_spread_start = options[:current_page] - options[:inner_spread]
+            inner_spread_start = options[:first_page] if inner_spread_start < options[:first_page]
+            inner_spread_end = options[:current_page] + options[:inner_spread]
+            inner_spread_end = options[:last_page] if inner_spread_end > options[:last_page]
+            
+            if !options[:outer_spread].blank?
+              lower_gap = inner_spread_start - options[:first_page]
+              if lower_gap > 0
+                lower_outer_spread_start = options[:first_page]
+                lower_outer_spread_end = options[:outer_spread] > lower_gap ? lower_gap : options[:outer_spread]
+              end
+              
+              upper_gap = options[:last_page] - inner_spread_end
+              if upper_gap > 0
+                upper_outer_spread_start = options[:last_page] - (options[:outer_spread] > upper_gap ? upper_gap : options[:outer_spread]) + 1
+                upper_outer_spread_end = options[:last_page]
+              end
+            end
           else
-            first_page = options[:first_page]
-            last_page = options[:last_page]
+            inner_spread_start = options[:first_page]
+            inner_spread_end = options[:last_page]
           end
           
           html = ""
           html += span_or_page_link(:first, options.deep_dup, options[:current_page] == options[:first_page]) if options[:first]
           html += span_or_page_link(:prev, options.deep_dup, options[:current_page] == options[:first_page]) if options[:prev]
-          (first_page..last_page).each { |page| html += span_or_page_link(page, options.deep_dup, page == options[:current_page]) }
+          
+          if lower_gap > 0
+            (lower_outer_spread_start..lower_outer_spread_end).each { |page| html += span_or_page_link(page, options.deep_dup, false) }
+            html += content_tag(:span, "&hellip;", options[:html]) if (inner_spread_start - lower_outer_spread_end) > 1
+          end
+          
+          (inner_spread_start..inner_spread_end).each { |page| html += span_or_page_link(page, options.deep_dup, page == options[:current_page]) }
+          
+          if upper_gap > 0
+            html += content_tag(:span, "&hellip;", options[:html]) if (upper_outer_spread_start - inner_spread_end) > 1
+            (upper_outer_spread_start..upper_outer_spread_end).each { |page| html += span_or_page_link(page, options.deep_dup, false) }
+          end
+          
           html += span_or_page_link(:next, options.deep_dup, options[:current_page] == options[:last_page]) if options[:next]
           html += span_or_page_link(:last, options.deep_dup, options[:current_page] == options[:last_page]) if options[:last]
           html
@@ -154,9 +182,12 @@ module Searchgasm
             options[:first_page] ||= 1
             options[:last_page] ||= options[:search_obj].page_count
             options[:current_page] ||= options[:search_obj].page
-            options[:spread] = 3 unless options.has_key?(:spread)
-            options[:prev] = "< Prev" unless options.has_key?(:prev)
-            options[:next] = "Next >" unless options.has_key?(:next)
+            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
           end
           

data/lib/searchgasm/shared/searching.rb

@@ -30,6 +30,8 @@ module Searchgasm
             klass.send(:with_scope, :find => options) do
               find_options = (self.class < Searchgasm::Conditions::Base ? {:conditions => sanitize} : sanitize)
               find_options.delete(:select)
+              find_options.delete(:limit)
+              find_options.delete(:offset)
               args << find_options
               klass.#{method}(*args)
             end

data/lib/searchgasm/version.rb

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

data/searchgasm.gemspec

@@ -1,11 +1,11 @@
 
-# Gem::Specification for Searchgasm-1.0.4
+# Gem::Specification for Searchgasm-1.1.0
 # Originally generated by Echoe
 
 --- !ruby/object:Gem::Specification 
 name: searchgasm
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic

data/test/test_active_record_base.rb

@@ -84,5 +84,11 @@ class TestActiveRecordBase < Test::Unit::TestCase
   def test_count
     assert_equal 3, Account.count
     assert_equal 3, Account.count(:limit => 1)
+    assert_equal 0, Account.count(:limit => 1, :offset => 1) # not sure why AR doesn't ignore offset like it does for limit
+    search = Account.new_search
+    assert_equal 3, search.count
+    search.per_page = 10
+    search.page = 10
+    assert_equal 3, search.count
   end
 end

data/test/test_conditions_base.rb

@@ -173,4 +173,16 @@ class TestConditionsBase < Test::Unit::TestCase
     assert_equal 1, conditions.minimum('id')
     assert_equal 4, conditions.sum('id')
   end
+  
+  def test_any
+    conditions = Account.new_conditions
+    conditions.name_contains = "Binary"
+    assert_equal Account.find(1, 3), conditions.all
+    conditions.id = 1
+    assert_equal [Account.find(1)], conditions.all
+    conditions.any = true
+    assert_equal Account.find(1, 3), conditions.all
+    conditions.any = false
+    assert_equal [Account.find(1)], conditions.all
+  end
 end

data/test/test_search_pagination.rb

@@ -67,6 +67,17 @@ class TestSearchPagination < Test::Unit::TestCase
   end
   
   def test_page_count
+    search = Account.new_search
+    assert_equal 1, search.page_count
+    search.per_page = 1
+    assert_equal 3, search.page_count
+    search.per_page = 100
+    assert_equal 1, search.page_count
     
+    Searchgasm::Config.per_page = 1
+    search = Account.new_search
+    assert_equal 3, search.page_count    
+    search.conditions.users.first_name_contains
+    assert_equal 3, search.page_count
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: searchgasm
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic