searchlogic 1.5.3

data/lib/searchlogic/helpers/control_types/remote_link.rb

@@ -0,0 +1,87 @@
+module Searchlogic
+  module Helpers
+    module ControlTypes
+      # = Remote Link Control Types
+      #
+      # These helpers use rails built in remote_function as links.
+      module RemoteLink
+        # The same thing as order_by_link but instead of using rails link_to it uses link_to_remote
+        #
+        # === Examples
+        #
+        #   remote_order_by_link
+        #   remote_order_by_link(:remote => {:update => "users"})
+        #
+        # === Options
+        #
+        # Please look at order_by_link, this accepts the same options with the following addition:
+        #
+        # * <tt>:remote</tt> -- default: {}, the options to pass into link_to_remote remote options. Such as :update => {:success => "alert('success')"}
+        def remote_order_by_link(order_by, options = {})
+          add_remote_defaults!(options)
+          order_by_link(order_by, options)
+        end
+        
+        # The same thing as order_as_link but instead of using rails link_to it uses link_to_remote
+        #
+        # === Examples
+        #
+        #   remote_order_as_link
+        #   remote_order_as_link(:remote => {:update => "users"})
+        #
+        # === Options
+        #
+        # Please look at order_as_link, this accepts the same options with the following addition:
+        #
+        # * <tt>:remote</tt> -- default: {}, the options to pass into link_to_remote remote options. Such as :update => {:success => "alert('success')"}
+        def remote_order_as_link(order_as, options = {})
+          add_remote_defaults!(options)
+          order_as_link(order_as, options)
+        end
+        
+        # The same thing as per_page_link but instead of using rails link_to it uses link_to_remote
+        #
+        # === Examples
+        #
+        #   remote_per_page_link
+        #   remote_per_page_link(:remote => {:update => "users"})
+        #
+        # === Options
+        #
+        # Please look at per_page_link, this accepts the same options with the following addition:
+        #
+        # * <tt>:remote</tt> -- default: {}, the options to pass into link_to_remote remote options. Such as :update => {:success => "alert('success')"}
+        def remote_per_page_link(per_page, options = {})
+          add_remote_defaults!(options)
+          per_page_link(per_page, options)
+        end
+        
+        # The same thing as page_link but instead of using rails link_to it uses link_to_remote
+        #
+        # === Examples
+        #
+        #   remote_page_link
+        #   remote_page_link(:remote => {:update => "users"})
+        #
+        # === Options
+        #
+        # Please look at page_link, this accepts the same options with the following addition:
+        #
+        # * <tt>:remote</tt> -- default: {}, the options to pass into link_to_remote remote options. Such as :update => {:success => "alert('success')"}
+        def remote_page_link(page, options = {})
+          add_remote_defaults!(options)
+          page_link(page, options)
+        end
+        
+        private
+          def add_remote_defaults!(options)
+            options[:remote] ||= {}
+            options[:remote][:method] ||= :get
+            options[:is_remote] = true
+          end
+      end
+    end
+  end
+end
+
+ActionController::Base.helper Searchlogic::Helpers::ControlTypes::RemoteLink if defined?(ActionController)

data/lib/searchlogic/helpers/control_types/remote_links.rb

@@ -0,0 +1,72 @@
+module Searchlogic
+  module Helpers
+    module ControlTypes
+      # = Remote Links Control Types
+      #
+      # These helpers use rails built in remote_function as links. They are the same thing as the Links control type, but just use rails built in remote helpers.
+      module RemoteLinks
+        # Same as order_by_links, but uses link_to_remote instead of remote.
+        #
+        # === Examples
+        #
+        #   remote_order_by_links
+        #   remote_order_by_links(:remote => {:update => "users"})
+        #
+        # === Options
+        #
+        # Please look at remote_order_by_link and order_by_links. All options there are applicable here. This is just a wrapper method for those 2 methods.
+        def remote_order_by_links(options = {})
+          add_remote_defaults!(options)
+          order_by_links(options)
+        end
+        
+        # Same as order_as_links, but uses link_to_remote instead of remote.
+        #
+        # === Examples
+        #
+        #   remote_order_as_links
+        #   remote_order_as_links(:remote => {:update => "users"})
+        #
+        # === Options
+        #
+        # Please look at remote_order_as_link and order_as_links. All options there are applicable here. This is just a wrapper method for those 2 methods.
+        def remote_order_as_links(options = {})
+          add_remote_defaults!(options)
+          order_as_link(options)
+        end
+        
+        # Same as per_page_links, but uses link_to_remote instead of remote.
+        #
+        # === Examples
+        #
+        #   remote_per_page_links
+        #   remote_per_page_links(:remote => {:update => "users"})
+        #
+        # === Options
+        #
+        # Please look at remote_per_page_link and per_page_links. All options there are applicable here. This is just a wrapper method for those 2 methods.
+        def remote_per_page_links(options = {})
+          add_remote_defaults!(options)
+          per_page_links(options)
+        end
+        
+        # Same as page_links, but uses link_to_remote instead of remote.
+        #
+        # === Examples
+        #
+        #   remote_page_links
+        #   remote_page_links(:remote => {:update => "users"})
+        #
+        # === Options
+        #
+        # Please look at remote_page_link and page_links. All options there are applicable here. This is just a wrapper method for those 2 methods.
+        def remote_page_links(options = {})
+          add_remote_defaults!(options)
+          page_links(options)
+        end
+      end
+    end
+  end
+end
+
+ActionController::Base.helper Searchlogic::Helpers::ControlTypes::RemoteLinks if defined?(ActionController)

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

@@ -0,0 +1,36 @@
+module Searchlogic
+  module Helpers
+    module ControlTypes
+      # = Remote Select Control Types
+      #
+      # These helpers use rails built in remote_function as links. They are the same thing as the Select control type, but just use rails built in remote helpers.
+      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, except 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 Searchlogic::Helpers::ControlTypes::RemoteSelect if defined?(ActionController)

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

@@ -0,0 +1,82 @@
+module Searchlogic
+  module Helpers
+    module ControlTypes
+      # = Select Control Types
+      #
+      # These create <select> tags to help navigate through search data. This is here as an alternative to the Links control types.
+      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)
+          searchlogic_state(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_as_select_defaults!(options)
+          searchlogic_state(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)
+          searchlogic_state(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)
+          searchlogic_state(options) + select(options[:params_scope], :page, (options[:first_page]..options[:last_page]), options[:tag], options[:html])
+        end
+        
+        private
+          def add_order_by_select_defaults!(options)
+            add_order_by_links_defaults!(options)
+            searchlogic_add_class!(options[:html], Config.helpers.order_by_select_class_name)
+            add_searchlogic_select_defaults!(:order_by, options)
+            options
+          end
+          
+          def add_order_as_select_defaults!(options)
+            add_order_as_links_defaults!(options)
+            searchlogic_add_class!(options[:html], Config.helpers.order_as_select_class_name)
+            add_searchlogic_select_defaults!(:order_as, options)
+            options
+          end
+          
+          def add_per_page_select_defaults!(options)
+            add_per_page_links_defaults!(options)
+            searchlogic_add_class!(options[:html], Config.helpers.per_page_select_class_name)
+            add_searchlogic_select_defaults!(:per_page, options)
+            options
+          end
+          
+          def add_page_select_defaults!(options)
+            add_page_links_defaults!(options)
+            searchlogic_add_class!(options[:html], Config.helpers.page_select_class_name)
+            add_searchlogic_select_defaults!(:page, options)
+            options
+          end
+          
+          def add_searchlogic_select_defaults!(option, options)
+            options[:tag] ||= {}
+            options[:tag][:object] = options[:search_obj]
+            
+            url = searchlogic_url(options.merge(:literal_search_params => {option => "'+this.value+'"}))
+            
+            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] ||= "#{option}_select"
+            options
+          end
+      end
+    end
+  end
+end
+
+ActionController::Base.helper Searchlogic::Helpers::ControlTypes::Select if defined?(ActionController)

data/lib/searchlogic/helpers/form.rb

@@ -0,0 +1,208 @@
+module Searchlogic
+  module Helpers
+    # = Form Helper
+    #
+    # Enables you to use form_for and fields_for just like you do with an ActiveRecord object.
+    #
+    # === Examples
+    #
+    # Let's assume @search is searching Address
+    #
+    #   form_for(@search) # is equivalent to form_for(:search, @search, :url => addresses_path)
+    #   form_for([@current_user, @search]) # is equivalent to form_for(:search, @search, :url => user_addresses_path(@current_user))
+    #   form_for([:admin, @search]) # is equivalent to form_for(:search, @search, :url => admin_addresses_path)
+    #   form_for(:search, @search, :url => whatever_path)
+    #
+    # The goal was to mimic how ActiveRecord objects are treated. You can also pass a Searchlogic::Conditions::Base object as well and it will function the same way.
+    #
+    # === Automatic hidden fields generation
+    #
+    # If you pass a Searchlogic::Search::Base object it automatically adds the :order_by, :order_as, :priority_order_by, :priority_order_as, and :per_page hidden fields. This is done so that when someone
+    # creates a new search, their options are remembered. It keeps the search consistent and is much more user friendly. If you want to override this you can pass the
+    # following options or you can set this up in your configuration, see Searchlogic::Config for more details.
+    #
+    # Lastly some light javascript is added to the "onsubmit" action. You will notice that the control type helpers add in hidden fields in the page, as a way to declare its "state". The form
+    # finds these elements, gets their values and updates its hidden fields so that the correct values will be submitted during the search. The end result is having these search options remembered.
+    #
+    # === 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 Form
+      module Shared # :nodoc:
+        private
+          def searchlogic_object?(object)
+            object.is_a?(Search::Base) || object.is_a?(Conditions::Base)
+          end
+        
+          def find_searchlogic_object(args)
+            search_object = nil
+            
+            case args.first
+            when String, Symbol
+              begin
+                search_object = searchlogic_object?(args[1]) ? args[1] : instance_variable_get("@#{args.first}")
+              rescue Exception
+              end
+            when Array
+              search_object = args.first.last
+            else
+              search_object = args.first
+            end
+          
+            searchlogic_object?(search_object) ? search_object : nil
+          end
+          
+          def extract_searchlogic_options!(args)
+            options = args.extract_options!
+            searchlogic_options = {}
+            [:hidden_fields].each { |option| searchlogic_options[option] = options.has_key?(option) ? options.delete(option) : Config.helpers.send(option) }
+            searchlogic_options[:hidden_fields] = [searchlogic_options[:hidden_fields]].flatten.compact
+            args << options
+            searchlogic_options
+          end
+          
+          def searchlogic_args(args, search_object, search_options, for_helper = nil)
+            args = args.dup
+            first = args.shift
+          
+            # Rearrange args with name first, search_obj second
+            case first
+            when String, Symbol
+              args.unshift(search_object).unshift(first)
+            else
+              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] ||= searchlogic_form_id(search_object)
+              
+              if !search_options[:hidden_fields].blank?
+                options[:html][:onsubmit] ||= ""
+                options[:html][:onsubmit] += ";"
+                
+                javascript = ""
+                javascript += "if(typeof(Prototype) != 'undefined') {" if Config.helpers.javascript_library.blank?
+                search_options[:hidden_fields].each { |field| javascript += "field = $('#{name}_#{field}'); if(field) { $('#{name}_#{field}_hidden').value = field.value; }" } if Config.helpers.javascript_library.blank? || Config.helpers.javascript_library == :prototype
+                javascript += "} else if(typeof(jQuery) != 'undefined') {" if Config.helpers.javascript_library.blank?
+                search_options[:hidden_fields].each { |field| javascript += "field = $('##{name}_#{field}'); if(field) { $('##{name}_#{field}_hidden').val(field.val()); }" } if Config.helpers.javascript_library.blank? || Config.helpers.javascript_library == :jquery
+                javascript += "}" if Config.helpers.javascript_library.blank?
+              
+                options[:html][:onsubmit] += javascript
+              end
+          
+              # Setup options
+              case first
+              when Array
+                first.pop
+                first << search_object.klass.new
+                options[:url] ||= polymorphic_path(first)
+              else
+                options[:url] ||= polymorphic_path(search_object.klass.new)
+              end
+          
+              args << options
+            end
+          
+            args
+          end
+        
+          def insert_searchlogic_fields(args, search_object, search_options, &block)
+            return unless search_object.is_a?(Search::Base)
+            name = args.first
+            options = args.extract_options!
+            options
+            search_options[:hidden_fields].each do |field|
+              html = hidden_field(name, field, :object => search_object, :id => "#{name}_#{field}_hidden", :value => (field == :order_by ? searchlogic_base64_value(search_object.order_by) : search_object.send(field)))
+              
+              # For edge rails and older version compatibility, passing a binding to concat was deprecated
+              begin
+                concat(html)
+              rescue ArgumentError, NameError
+                concat(html, block.binding)
+              end
+            end
+            args << options
+          end
+      end
+      
+      module Base # :nodoc:
+        include Shared
+
+        def fields_for_with_searchlogic(*args, &block)
+          search_object = find_searchlogic_object(args)
+          if search_object
+            searchlogic_options = extract_searchlogic_options!(args)
+            new_args = searchlogic_args(args, search_object, searchlogic_options, :fields_for)
+            insert_searchlogic_fields(new_args, search_object, searchlogic_options, &block)
+            fields_for_without_searchlogic(*new_args, &block)
+          else
+            fields_for_without_searchlogic(*args, &block)
+          end
+        end
+      
+        def form_for_with_searchlogic(*args, &block)
+          search_object = find_searchlogic_object(args)
+          if search_object
+            searchlogic_options = extract_searchlogic_options!(args)
+            form_for_without_searchlogic(*searchlogic_args(args, search_object, searchlogic_options, :form_for), &block)
+          else
+            form_for_without_searchlogic(*args, &block)
+          end
+        end
+      
+        def remote_form_for_with_searchlogic(*args, &block)
+          search_object = find_searchlogic_object(args)
+          if search_object
+            searchlogic_options = extract_searchlogic_options!(args)
+            remote_form_for_without_searchlogic(*searchlogic_args(args, search_object, searchlogic_options, :remote_form_for), &block)
+          else
+            remote_form_for_without_searchlogic(*args, &block)
+          end
+        end
+      end
+    
+      module FormBuilder # :nodoc:
+        include Shared
+        
+        def fields_for_with_searchlogic(*args, &block)
+          search_object = find_searchlogic_object(args)
+          if search_object
+            searchlogic_options = extract_searchlogic_options!(args)
+            new_args = searchlogic_args(args, search_object, searchlogic_options, :fields_for)
+            insert_searchlogic_fields(new_args, search_object, searchlogic_options, &block)
+            fields_for_without_searchlogic(*new_args, &block)
+          else
+            fields_for_without_searchlogic(*args, &block)
+          end
+        end
+      end
+    end
+  end
+end
+
+if defined?(ActionView)
+  ActionView::Base.send(:include, Searchlogic::Helpers::Form::Base)
+
+  ActionView::Base.class_eval do
+    alias_method_chain :fields_for, :searchlogic
+    alias_method_chain :form_for, :searchlogic
+    alias_method_chain :remote_form_for, :searchlogic
+  end
+
+  ActionView::Helpers::FormBuilder.send(:include, Searchlogic::Helpers::Form::FormBuilder)
+
+  ActionView::Helpers::FormBuilder.class_eval do
+    alias_method_chain :fields_for, :searchlogic
+  end
+end