searchgasm 0.9.10 → 1.0.0

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

@@ -0,0 +1,33 @@
+module Searchgasm
+  module Helpers
+    module ControlTypes
+      module RemoteSelect
+        # Please see order_by_links. All options are the same and applicable here. The only difference is that instead of a group of links, this gets returned as a select form element that will perform the same function when the value is changed.
+        def remote_order_by_select(options = {})
+          add_remote_defaults!(options)
+          order_by_select(options)
+        end
+        
+        # Please see order_as_links. All options are the same and applicable here. The only difference is that instead of a group of links, this gets returned as a select form element that will perform the same function when the value is changed.
+        def remote_order_as_select(options = {})
+          add_remote_defaults!(options)
+          order_as_select(options)
+        end
+        
+        # Please see per_page_links. All options are the same and applicable here. The only difference is that instead of a group of links, this gets returned as a select form element that will perform the same function when the value is changed.
+        def remote_per_page_select(options = {})
+          add_remote_defaults!(options)
+          per_page_select(options)
+        end
+        
+        # Please see page_links. All options are the same and applicable here, excep the :prev, :next, :first, and :last options. The only difference is that instead of a group of links, this gets returned as a select form element that will perform the same function when the value is changed.
+        def remote_page_select(options = {})
+          add_remote_defaults!(options)
+          page_select(options)
+        end
+      end
+    end
+  end
+end
+
+ActionController::Base.helper Searchgasm::Helpers::ControlTypes::RemoteSelect if defined?(ActionController)

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

@@ -0,0 +1,78 @@
+module Searchgasm
+  module Helpers
+    module ControlTypes
+      module Select
+        # Please see order_by_links. All options are the same and applicable here. The only difference is that instead of a group of links, this gets returned as a select form element that will perform the same function when the value is changed.
+        def order_by_select(options = {})
+          add_order_by_select_defaults!(options)
+          searchgasm_state_for(:order_by, options) + select(options[:params_scope], :order_by, options[:choices], options[:tag] || {}, options[:html] || {})
+        end
+        
+        # Please see order_as_links. All options are the same and applicable here. The only difference is that instead of a group of links, this gets returned as a select form element that will perform the same function when the value is changed.
+        def order_as_select(options = {})
+          add_order_by_select_defaults!(options)
+          searchgasm_state_for(:order_as, options) + select(options[:params_scope], :order_as, options[:choices], options[:tag] || {}, options[:html])
+        end
+        
+        # Please see per_page_links. All options are the same and applicable here. The only difference is that instead of a group of links, this gets returned as a select form element that will perform the same function when the value is changed.
+        def per_page_select(options = {})
+          add_per_page_select_defaults!(options)
+          searchgasm_state_for(:per_page, options) + select(options[:params_scope], :per_page, options[:choices], options[:tag] || {}, options[:html])
+        end
+        
+        # Please see page_links. All options are the same and applicable here, excep the :prev, :next, :first, and :last options. The only difference is that instead of a group of links, this gets returned as a select form element that will perform the same function when the value is changed.
+        def page_select(options = {})
+          add_page_select_defaults!(options)
+          searchgasm_state_for(:page, options) + select(options[:params_scope], :page, options[:choices], options[:tag] || {}, options[:html])
+        end
+        
+        private
+          def add_order_by_select_defaults!(options)
+            add_order_by_links_defaults!(options)
+            add_searchgasm_select_defaults!(:order_by, options)
+            options
+          end
+          
+          def add_order_as_select_defaults!(options)
+            add_order_as_links_defaults!(options)
+            add_searchgasm_select_defaults!(:order_as, options)
+            options
+          end
+          
+          def add_per_page_select_defaults!(options)
+            add_per_page_links_defaults!(options)
+            options[:choices] = options[:choices].collect { |choice| choice.nil? ? ["Show all", choice] : ["#{choice} per page", choice]}
+            add_searchgasm_select_defaults!(:per_page, options)
+            options
+          end
+          
+          def add_page_select_defaults!(options)
+            add_page_links_defaults!(options)
+            add_searchgasm_select_defaults!(:page, options)
+            options
+          end
+          
+          def add_searchgasm_select_defaults!(option, options)
+            url = searchgasm_url_hash(option, nil, options)
+            url.delete(option)
+            url = searchgasm_url(url, options)
+            url = url_for(url)
+            url_option = CGI.escape((options[:params_scope].blank? ? "#{option}" : "#{options[:params_scope]}[#{option}]")) + "='+this.value"
+            url += (url.last == "?" ? "" : (url.include?("?") ? "&" : "?")) + url_option
+            
+            options[:html][:onchange] ||= ""
+            options[:html][:onchange] += ";"
+            if !options[:remote]
+              options[:html][:onchange] += "window.location='#{url};"
+            else
+              options[:html][:onchange] += remote_function(:url => url, :method => :get).gsub(/\\'\+this.value'/, "'+this.value")
+            end
+            options[:html][:id] ||= ""
+            options
+          end
+      end
+    end
+  end
+end
+
+ActionController::Base.helper Searchgasm::Helpers::ControlTypes::Select if defined?(ActionController)

data/lib/searchgasm/helpers/control_types.rb

@@ -0,0 +1,41 @@
+module Searchgasm
+  module Helpers
+    # = Control Type Helpers
+    #
+    # The purpose of these helpers is to make ordering and paginating data, in your view, a breeze. Everyone has their own flavor of displaying data, so I made these helpers extra flexible, just for you.
+    #
+    # === How it's organized
+    #
+    # Basically you can do 4 different things in your with with your data:
+    #
+    # 1. Order your data by a single column or an array of columns
+    # 2. Descend or ascend your data
+    # 3. Change how many items are on each page
+    # 4. Paginate through your data
+    #
+    # Each one of these actions comes with 3 different types of helpers:
+    #
+    # 1. Link - A single link for a single value. Requires that you pass a value as the first parameter.
+    # 2. Group of links - A group of single links.
+    # 3. Select - A select with choices that perform an action once selected. Basically the same thing as a group of links, but just as a select form element
+    #
+    # === Examples
+    #
+    # Sometimes the best way to explain something is with some examples. Let's pretend we are performing these actions on a User model. Check it out:
+    #
+    #   order_by_link(:name)
+    #   => produces a single link that when clicked will order by the name column, and each time its clicked alternated between "ASC" and "DESC"
+    #
+    #   order_by_links
+    #   => produces a group of links for all of the columns in your users table, each link is basically order_by_link(column.name)
+    #
+    #   order_by_select
+    #   => produces a select form element with all of the user's columns as choices, when the value is change (onchange) it will act as if they clicked a link.
+    #   => This is just order_by_links as a select form element, nothing fancy
+    #
+    # You can apply the _link, _links, or _select to any of the following: order_by, order_as, per_page, page. You have your choice on how you want to set up the interface. For more information and options on these individual
+    # helpers check out their source files. Look at the sub modules under this one (Ex: Searchgasm::Helpers::ControlTypes::Select)
+    module ControlTypes
+    end
+  end
+end

data/lib/searchgasm/helpers/{form_helper.rb → form.rb}

@@ -24,7 +24,9 @@ module Searchgasm
     # === Options
     #
     # * <tt>:hidden_fields</tt> --- Array, a list of hidden fields to include. Defaults to [:order_by, :order_as, :per_page]. Pass false, nil, or a blank array to not include any.
-    module FormHelper
+    # * <tt>:js_lib</tt> --- Accepts :prototype, :jquery, or nil. Javascript is written to keep the :hidden_fields in sync with the other fields on the page. nil will turn javascript off, you will be on your own.
+    #  Keeping these fields in sync allows search to remember their values when they are changed, making search much more user friendly.
+    module Form
       module Shared # :nodoc:
         private
           def searchgasm_object?(object)
@@ -43,12 +45,21 @@ module Searchgasm
           
             searchgasm_object?(search_object) ? search_object : nil
           end
+          
+          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) }
+            searchgasm_options[:hidden_fields] = [searchgasm_options[:hidden_fields]].flatten.compact
+            args << options
+            searchgasm_options
+          end
         
-          def searchgasm_args(args, search_object, for_helper = nil)
+          def searchgasm_args(args, search_object, search_options, for_helper = nil)
             args = args.dup
             first = args.shift
           
-            # Setup args
+            # Rearrange args with name first, search_obj second
             case first
             when String, Symbol
               args.unshift(search_object).unshift(first)
@@ -56,13 +67,32 @@ module Searchgasm
               name = search_object.is_a?(Conditions::Base) ? (search_object.relationship_name || :conditions) : :search
               args.unshift(search_object).unshift(name)
             end
-          
+            
+            # Now that we are consistent, get the name
+            name = args.first
+            
+            # Add in some form magic to keep searching consisten and user friendly
             if for_helper != :fields_for
               options = args.extract_options!
+              
+              # Set some defaults
               options[:html] ||= {}
               options[:html][:method] ||= :get
               options[:method] ||= options[:html][:method] if for_helper == :remote_form_for
-              options[:html][:id] ||= searchgasm_form_id(search_object)
+              #options[:html][:id] ||= searchgasm_form_id(search_object)
+              
+              if !search_options[:hidden_fields].blank?
+                options[:html][:onsubmit] ||= ""
+                options[:html][:onsubmit] += ";"
+              
+                javascript = "if(typeof(Prototype) != 'undefined') {"
+                search_options[:hidden_fields].each { |field| javascript += "$('#{name}_#{field}_hidden').value = $('#{name}_#{field}').value;" }
+                javascript += "} else if(jQuery) {"
+                search_options[:hidden_fields].each { |field| javascript += "$('##{name}_#{field}_hidden').val($('##{name}_#{field}').val());" }
+                javascript += "}"
+              
+                options[:html][:onsubmit] += javascript
+              end
           
               # Setup options
               case first
@@ -80,12 +110,13 @@ module Searchgasm
             args
           end
         
-          def insert_searchgasm_fields(args, search_object)
+          def insert_searchgasm_fields(args, search_object, search_options)
             return unless search_object.is_a?(Search::Base)
             name = args.first
             options = args.extract_options!
-            [(options.delete(:hidden_fields) || Config.hidden_fields)].flatten.each do |option|
-              concat(hidden_field(name, option, :object => search_object, :value => (option == :order_by ? searchgasm_order_by_value(search_object.order_by) : search_object.send(option))))
+            options
+            search_options[:hidden_fields].each do |field|
+              concat(hidden_field(name, field, :object => search_object, :id => "#{name}_#{field}_hidden", :value => (field == :order_by ? searchgasm_order_by_value(search_object.order_by) : search_object.send(field))))
             end
             args << options
           end
@@ -97,8 +128,9 @@ module Searchgasm
         def fields_for_with_searchgasm(*args, &block)
           search_object = find_searchgasm_object(args)
           if search_object
-            new_args = searchgasm_args(args, search_object, :fields_for)
-            insert_searchgasm_fields(new_args, search_object)
+            searchgasm_options = extract_searchgasm_options!(args)
+            new_args = searchgasm_args(args, search_object, searchgasm_options, :fields_for)
+            insert_searchgasm_fields(new_args, search_object, searchgasm_options)
             fields_for_without_searchgasm(*new_args, &block)
           else
             fields_for_without_searchgasm(*args, &block)
@@ -108,7 +140,8 @@ module Searchgasm
         def form_for_with_searchgasm(*args, &block)
           search_object = find_searchgasm_object(args)
           if search_object
-            form_for_without_searchgasm(*searchgasm_args(args, search_object, :form_for), &block)
+            searchgasm_options = extract_searchgasm_options!(args)
+            form_for_without_searchgasm(*searchgasm_args(args, search_object, searchgasm_options, :form_for), &block)
           else
             form_for_without_searchgasm(*args, &block)
           end
@@ -117,7 +150,8 @@ module Searchgasm
         def remote_form_for_with_searchgasm(*args, &block)
           search_object = find_searchgasm_object(args)
           if search_object
-            remote_form_for_without_searchgasm(*searchgasm_args(args, search_object, :remote_form_for), &block)
+            searchgasm_options = extract_searchgasm_options!(args)
+            remote_form_for_without_searchgasm(*searchgasm_args(args, search_object, searchgasm_options, :remote_form_for), &block)
           else
             remote_form_for_without_searchgasm(*args, &block)
           end
@@ -130,8 +164,9 @@ module Searchgasm
         def fields_for_with_searchgasm(*args, &block)
           search_object = find_searchgasm_object(args)
           if search_object
-            new_args = searchgasm_args(args, search_object, :fields_for)
-            insert_searchgasm_fields(new_args, search_object)
+            searchgasm_options = extract_searchgasm_options!(args)
+            new_args = searchgasm_args(args, search_object, searchgasm_options, :fields_for)
+            insert_searchgasm_fields(new_args, search_object, searchgasm_options)
             fields_for_without_searchgasm(*new_args, &block)
           else
             fields_for_without_searchgasm(*args, &block)
@@ -143,7 +178,7 @@ module Searchgasm
 end
 
 if defined?(ActionView)
-  ActionView::Base.send(:include, Searchgasm::Helpers::FormHelper::Base)
+  ActionView::Base.send(:include, Searchgasm::Helpers::Form::Base)
 
   ActionView::Base.class_eval do
     alias_method_chain :fields_for, :searchgasm
@@ -151,7 +186,7 @@ if defined?(ActionView)
     alias_method_chain :remote_form_for, :searchgasm
   end
 
-  ActionView::Helpers::FormBuilder.send(:include, Searchgasm::Helpers::FormHelper::FormBuilder)
+  ActionView::Helpers::FormBuilder.send(:include, Searchgasm::Helpers::Form::FormBuilder)
 
   ActionView::Helpers::FormBuilder.class_eval do
     alias_method_chain :fields_for, :searchgasm

data/lib/searchgasm/helpers/utilities.rb

@@ -0,0 +1,59 @@
+module Searchgasm
+  module Helpers #:nodoc:
+    module Utilities # :nodoc:
+      private
+        # Adds default options for all helper methods.
+        def add_searchgasm_helper_defaults!(option, options)
+          options[:params_scope] = :search unless options.has_key?(:params_scope)
+          options[:search_obj] ||= instance_variable_get("@#{options[:params_scope]}")
+          raise(ArgumentError, "@search object could not be inferred, please specify: :search_obj => @search") unless options[:search_obj].is_a?(Searchgasm::Search::Base)
+          options[:html] ||= {}
+          options[:html][:class] = (options[:html][:class].blank? ? "" : "#{options[:html][:class]} ") + option.to_s
+          options
+        end
+        
+        def searchgasm_url(url_hash, options)
+          options[:params_scope].blank? ? url_hash : {options[:params_scope] => url_hash}
+        end
+        
+        def searchgasm_url_hash(option, value, options)
+          params_copy = params.dup
+          params_copy.delete(:commit)
+                    
+          # Extract search params from params
+          search_params = options[:params_scope].blank? ? params_copy : params_copy[options[:params_scope]]
+          search_params ||= {}
+                    
+          # Never want to keep page
+          search_params.delete(:page)
+          
+          # Use special order_by value
+          search_params[option] = option == :order_by ? searchgasm_order_by_value(value) : value
+          
+          search_params
+        end
+        
+        def searchgasm_order_by_value(order_by)
+          case order_by
+          when String
+            order_by
+          when Array, Hash
+            [Marshal.dump(order_by)].pack("m")
+          end
+        end
+        
+        def searchgasm_state_for(option, options)
+          @added_state_for ||= []
+          html = ""
+          unless @added_state_for.include?(option)
+            value = options[:search_obj].send(option)
+            html = hidden_field(options[:params_scope], option, :value => (option == :order_by ? searchgasm_order_by_value(value) : value))
+            @added_state_for << option
+          end
+          html
+        end
+    end
+  end
+end
+
+ActionController::Base.helper(Searchgasm::Helpers::Utilities) if defined?(ActionController)

data/lib/searchgasm/helpers.rb

@@ -0,0 +1,3 @@
+module Searchgasm
+  module Helpers #:nodoc:
+    module UtilitiesHelper # :nodoc:

data/lib/searchgasm/search/ordering.rb

@@ -3,7 +3,7 @@ module Searchgasm
     # = Search Ordering
     #
     # The purpose of this module is to provide easy ordering for your searches. All that these options do is
-    # build :order for you. This plays a huge part in ordering your data on the interface. See Searchgasm::Helpers::SearchHelper for more information.
+    # build :order for you. This plays a huge part in ordering your data on the interface. See Searchgasm::Helpers::Search for more information.
     module Ordering
       def self.included(klass)
         klass.class_eval do

data/lib/searchgasm/version.rb

@@ -65,9 +65,9 @@ module Searchgasm
       [@major, @minor, @tiny]
     end
 
-    MAJOR = 0
-    MINOR = 9
-    TINY  = 10
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
 
     # The current version as a Version instance
     CURRENT = new(MAJOR, MINOR, TINY)

data/lib/searchgasm.rb

@@ -40,9 +40,14 @@ require "searchgasm/condition/inclusive_descendant_of"
 require "searchgasm/condition/sibling_of"
 
 # Helpers
-require "searchgasm/helpers/utilities_helper"
-require "searchgasm/helpers/form_helper"
-require "searchgasm/helpers/search_helper"
+require "searchgasm/helpers/utilities"
+require "searchgasm/helpers/form"
+require "searchgasm/helpers/control_types/link"
+require "searchgasm/helpers/control_types/links"
+require "searchgasm/helpers/control_types/select"
+require "searchgasm/helpers/control_types/remote_link"
+require "searchgasm/helpers/control_types/remote_links"
+require "searchgasm/helpers/control_types/remote_select"
 
 # Lets do it!
 module Searchgasm

data/searchgasm.gemspec

@@ -1,18 +1,18 @@
 
-# Gem::Specification for Searchgasm-0.9.10
+# Gem::Specification for Searchgasm-1.0.0
 # Originally generated by Echoe
 
 --- !ruby/object:Gem::Specification 
 name: searchgasm
 version: !ruby/object:Gem::Version 
-  version: 0.9.10
+  version: 1.0.0
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic
 autorequire: 
 bindir: bin
 
-date: 2008-09-08 00:00:00 -04:00
+date: 2008-09-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,9 +74,16 @@ extra_rdoc_files:
 - lib/searchgasm/conditions/base.rb
 - lib/searchgasm/conditions/protection.rb
 - lib/searchgasm/config.rb
-- lib/searchgasm/helpers/form_helper.rb
-- lib/searchgasm/helpers/search_helper.rb
-- lib/searchgasm/helpers/utilities_helper.rb
+- lib/searchgasm/helpers/control_types/link.rb
+- lib/searchgasm/helpers/control_types/links.rb
+- lib/searchgasm/helpers/control_types/remote_link.rb
+- lib/searchgasm/helpers/control_types/remote_links.rb
+- lib/searchgasm/helpers/control_types/remote_select.rb
+- lib/searchgasm/helpers/control_types/select.rb
+- lib/searchgasm/helpers/control_types.rb
+- lib/searchgasm/helpers/form.rb
+- lib/searchgasm/helpers/utilities.rb
+- lib/searchgasm/helpers.rb
 - lib/searchgasm/search/base.rb
 - lib/searchgasm/search/conditions.rb
 - lib/searchgasm/search/ordering.rb
@@ -111,9 +118,16 @@ files:
 - lib/searchgasm/conditions/base.rb
 - lib/searchgasm/conditions/protection.rb
 - lib/searchgasm/config.rb
-- lib/searchgasm/helpers/form_helper.rb
-- lib/searchgasm/helpers/search_helper.rb
-- lib/searchgasm/helpers/utilities_helper.rb
+- lib/searchgasm/helpers/control_types/link.rb
+- lib/searchgasm/helpers/control_types/links.rb
+- lib/searchgasm/helpers/control_types/remote_link.rb
+- lib/searchgasm/helpers/control_types/remote_links.rb
+- lib/searchgasm/helpers/control_types/remote_select.rb
+- lib/searchgasm/helpers/control_types/select.rb
+- lib/searchgasm/helpers/control_types.rb
+- lib/searchgasm/helpers/form.rb
+- lib/searchgasm/helpers/utilities.rb
+- lib/searchgasm/helpers.rb
 - lib/searchgasm/search/base.rb
 - lib/searchgasm/search/conditions.rb
 - lib/searchgasm/search/ordering.rb

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: searchgasm
 version: !ruby/object:Gem::Version 
-  version: 0.9.10
+  version: 1.0.0
 platform: ruby
 authors: 
 - Ben Johnson of Binary Logic
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-08 00:00:00 -04:00
+date: 2008-09-09 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -71,9 +71,16 @@ extra_rdoc_files:
 - lib/searchgasm/conditions/base.rb
 - lib/searchgasm/conditions/protection.rb
 - lib/searchgasm/config.rb
-- lib/searchgasm/helpers/form_helper.rb
-- lib/searchgasm/helpers/search_helper.rb
-- lib/searchgasm/helpers/utilities_helper.rb
+- lib/searchgasm/helpers/control_types/link.rb
+- lib/searchgasm/helpers/control_types/links.rb
+- lib/searchgasm/helpers/control_types/remote_link.rb
+- lib/searchgasm/helpers/control_types/remote_links.rb
+- lib/searchgasm/helpers/control_types/remote_select.rb
+- lib/searchgasm/helpers/control_types/select.rb
+- lib/searchgasm/helpers/control_types.rb
+- lib/searchgasm/helpers/form.rb
+- lib/searchgasm/helpers/utilities.rb
+- lib/searchgasm/helpers.rb
 - lib/searchgasm/search/base.rb
 - lib/searchgasm/search/conditions.rb
 - lib/searchgasm/search/ordering.rb
@@ -108,9 +115,16 @@ files:
 - lib/searchgasm/conditions/base.rb
 - lib/searchgasm/conditions/protection.rb
 - lib/searchgasm/config.rb
-- lib/searchgasm/helpers/form_helper.rb
-- lib/searchgasm/helpers/search_helper.rb
-- lib/searchgasm/helpers/utilities_helper.rb
+- lib/searchgasm/helpers/control_types/link.rb
+- lib/searchgasm/helpers/control_types/links.rb
+- lib/searchgasm/helpers/control_types/remote_link.rb
+- lib/searchgasm/helpers/control_types/remote_links.rb
+- lib/searchgasm/helpers/control_types/remote_select.rb
+- lib/searchgasm/helpers/control_types/select.rb
+- lib/searchgasm/helpers/control_types.rb
+- lib/searchgasm/helpers/form.rb
+- lib/searchgasm/helpers/utilities.rb
+- lib/searchgasm/helpers.rb
 - lib/searchgasm/search/base.rb
 - lib/searchgasm/search/conditions.rb
 - lib/searchgasm/search/ordering.rb