meta_search 0.3.0 → 0.5.0

data/test/test_view_helpers.rb

@@ -3,14 +3,41 @@ require 'action_controller'
 require 'action_view/test_case'
 
 class TestViewHelpers < ActionView::TestCase
-  tests ActionView::Helpers::FormHelper
+  tests MetaSearch::Helpers::FormHelper
+  include MetaSearch::Helpers::UrlHelper
+  
+  router = ActionDispatch::Routing::RouteSet.new
+  router.draw do |map|
+    resources :developers
+    resources :companies
+    resources :projects
+    resources :notes
+    match ':controller(/:action(/:id(.:format)))'
+  end
+  include router.url_helpers
+  
+  def setup
+    @controller = Class.new do
+      
+      attr_reader :url_for_options
+      def url_for(options)
+        @url_for_options = options
+        "http://www.example.com"
+      end
+      
+      def _router
+        @router ||= ActionDispatch::Routing::RouteSet.new
+      end
+    end
+    @controller = @controller.new
+  end
   
   context "A previously-filled search form" do
     setup do
       @s = Company.search
       @s.created_at_gte = [2001, 2, 3, 4, 5]
       @s.name_contains = "bacon"
-      fields_for :search, @s do |f|
+      form_for @s do |f|
         @f = f
       end
     end
@@ -31,7 +58,7 @@ class TestViewHelpers < ActionView::TestCase
   context "A form using mutiparameter_field with default size option" do
     setup do
       @s = Developer.search
-      fields_for :search, @s do |f|
+      form_for @s do |f|
         @f = f
       end
     end
@@ -51,35 +78,39 @@ class TestViewHelpers < ActionView::TestCase
   context "A form using check_boxes with three choices" do
     setup do
       @s = Company.search
-      fields_for :search, @s do |f|
+      form_for @s do |f|
         @f = f
       end
     end
     
-    should "generate the expected HTML without a block" do
-      assert_dom_equal '<input id="search_id_in_1" name="search[id_in][]" ' +
-                       'type="checkbox" value="1" /><label for="search_id_in_1">One</label>' +
-                       '<input id="search_id_in_2" name="search[id_in][]" ' +
-                       'type="checkbox" value="2" /><label for="search_id_in_2">Two</label>' +
-                       '<input id="search_id_in_3" name="search[id_in][]" ' +
-                       'type="checkbox" value="3" /><label for="search_id_in_3">Three</label>',
-                       @f.check_boxes(:id_in, [['One', 1], ['Two', 2], ['Three', 3]])
+    should "return an array of check boxes without a block" do
+      assert @f.check_boxes(:id_in, [['One', 1], ['Two', 2], ['Three', 3]]).all?{|c| c.is_a?(MetaSearch::Check)}
     end
     
     should "generate the expected HTML with a block" do
-      @f.check_boxes(:id_in, [['One', 1], ['Two', 2], ['Three', 3]]) do |c|
-        concat render :to => :string, :inline => "<p><%= c[:label] %> <%= c[:check_box] %></p>", :locals => {:c => c}
-      end
-      assert_dom_equal output_buffer,
-                      '<p><label for="search_id_in_1">One</label> ' +
-                      '<input id="search_id_in_1" name="search[id_in][]" ' +
-                      'type="checkbox" value="1" /></p>' +
-                      '<p><label for="search_id_in_2">Two</label> ' +
-                      '<input id="search_id_in_2" name="search[id_in][]" ' +
-                      'type="checkbox" value="2" /></p>' +
-                      '<p><label for="search_id_in_3">Three</label> ' +
-                      '<input id="search_id_in_3" name="search[id_in][]" ' +
-                      'type="checkbox" value="3" /></p>'
+      expected = <<-EXPECTED
+<p>
+  <label for="search_id_in_1">One</label>
+  <input id="search_id_in_1" name="search[id_in][]" type="checkbox" value="1" />
+</p>
+<p>
+  <label for="search_id_in_2">Two</label>
+  <input id="search_id_in_2" name="search[id_in][]" type="checkbox" value="2" />
+</p>
+<p>
+  <label for="search_id_in_3">Three</label>
+  <input id="search_id_in_3" name="search[id_in][]" type="checkbox" value="3" />
+</p>
+      EXPECTED
+      assert_dom_equal expected,
+        render(:to => :string, :inline => <<-ERB)
+<%= @f.check_boxes(:id_in, [['One', 1], ['Two', 2], ['Three', 3]]) do |c| -%>
+<p>
+  <%= c.label %>
+  <%= c.box %>
+</p>
+<% end -%>
+      ERB
     end
   end
   
@@ -87,54 +118,56 @@ class TestViewHelpers < ActionView::TestCase
     setup do
       @s = Company.search
       @s.id_in = [1, 3]
-      fields_for :search, @s do |f|
+      form_for @s do |f|
         @f = f
       end
     end
     
-    should "generate the expected HTML without a block" do
-      assert_dom_equal '<input checked="checked" id="search_id_in_1" name="search[id_in][]" ' +
-                       'type="checkbox" value="1" /><label for="search_id_in_1">One</label>' +
-                       '<input id="search_id_in_2" name="search[id_in][]" ' +
-                       'type="checkbox" value="2" /><label for="search_id_in_2">Two</label>' +
-                       '<input checked="checked" id="search_id_in_3" name="search[id_in][]" ' +
-                       'type="checkbox" value="3" /><label for="search_id_in_3">Three</label>',
-                       @f.check_boxes(:id_in, [['One', 1], ['Two', 2], ['Three', 3]])
+    should "return an array of check boxes without a block" do
+      assert @f.check_boxes(:id_in, [['One', 1], ['Two', 2], ['Three', 3]]).all?{|c| c.is_a?(MetaSearch::Check)}
     end
     
     should "generate the expected HTML with a block" do
-      @f.check_boxes(:id_in, [['One', 1], ['Two', 2], ['Three', 3]]) do |c|
-        concat render :to => :string, :inline => "<p><%= c[:label] %> <%= c[:check_box] %></p>", :locals => {:c => c}
-      end
-      assert_dom_equal output_buffer,
-                       '<p><label for="search_id_in_1">One</label> <input checked="checked" id="search_id_in_1" ' +
-                       'name="search[id_in][]" type="checkbox" value="1" /></p><p><label for="search_id_in_2">' +
-                       'Two</label> <input id="search_id_in_2" name="search[id_in][]" type="checkbox" value="2" />' +
-                       '</p><p><label for="search_id_in_3">Three</label> <input checked="checked" id="search_id_in_3" ' +
-                       'name="search[id_in][]" type="checkbox" value="3" /></p>'
+      expected = <<-EXPECTED
+<p>
+  <label for="search_id_in_1">One</label>
+  <input id="search_id_in_1" name="search[id_in][]" type="checkbox" value="1" checked="checked" />
+</p>
+<p>
+  <label for="search_id_in_2">Two</label>
+  <input id="search_id_in_2" name="search[id_in][]" type="checkbox" value="2" />
+</p>
+<p>
+  <label for="search_id_in_3">Three</label>
+  <input id="search_id_in_3" name="search[id_in][]" type="checkbox" value="3" checked="checked" />
+</p>
+      EXPECTED
+      assert_dom_equal expected,
+                       render(:to => :string, :inline => <<-ERB)
+<%= @f.check_boxes(:id_in, [['One', 1], ['Two', 2], ['Three', 3]]) do |c| -%>
+<p>
+  <%= c.label %>
+  <%= c.box %>
+</p>
+<% end -%>
+                       ERB
     end
     
     context "A form using collection_check_boxes with companies" do
       setup do
         @s = Company.search
-        fields_for :search, @s do |f|
+        form_for @s do |f|
           @f = f
         end
       end
       
-      should "generate the expected HTML without a block" do
-        assert_dom_equal '<input id="search_id_in_1" name="search[id_in][]" type="checkbox" ' +
-                         'value="1" /><label for="search_id_in_1">Initech</label>' +
-                         '<input id="search_id_in_2" name="search[id_in][]" type="checkbox" ' +
-                         'value="2" /><label for="search_id_in_2">Advanced Optical Solutions</label>' +
-                         '<input id="search_id_in_3" name="search[id_in][]" type="checkbox" ' +
-                         'value="3" /><label for="search_id_in_3">Mission Data</label>',
-                         @f.collection_check_boxes(:id_in, Company.all, :id, :name)
+      should "return an array of check boxes without a block" do
+       assert @f.collection_check_boxes(:id_in, Company.all, :id, :name).all?{|c| c.is_a?(MetaSearch::Check)}
       end
       
       should "generate the expected HTML with a block" do
         @f.collection_check_boxes(:id_in, Company.all, :id, :name) do |c|
-          concat render :to => :string, :inline => "<p><%= c[:label] %> <%= c[:check_box] %></p>", :locals => {:c => c}
+          concat render :to => :string, :inline => "<p><%= c.label %> <%= c.box %></p>", :locals => {:c => c}
         end
         assert_dom_equal output_buffer,
                          '<p><label for="search_id_in_1">Initech</label> ' +
@@ -146,4 +179,70 @@ class TestViewHelpers < ActionView::TestCase
       end
     end
   end
+  
+  context "A company search" do
+    setup do
+      @s = Company.search
+    end
+    
+    context "sorted by name ascending" do
+      setup do
+        @s.meta_sort = 'name.asc'
+      end
+    
+      should "generate a sort link with an up arrow for the sorted column" do
+        assert_match /Name &#9650;/,
+                     sort_link(@s, :name, :controller => 'companies')
+      end
+    
+      should "not generate a sort link with an up arrow for a non-sorted column" do
+        assert_no_match /Created at &#9650;/,
+                        sort_link(@s, :created_at, :controller => 'companies')
+      end
+    
+      context "with existing search options" do
+        setup do
+          @s.name_contains = 'a'
+        end
+      
+        should "maintain previous search options in its sort links" do
+          assert_match /search\[name_contains\]=a/,
+                       sort_link(@s, :name, :controller => 'companies')
+        end
+      end
+    end
+  end
+  
+  context "A developer search" do
+    setup do
+      @s = Developer.search
+    end
+    
+    context "sorted by company name descending" do
+      setup do
+        @s.meta_sort = 'company_name.desc'
+      end
+    
+      should "generate a sort link with a down arrow for the sorted column" do
+        assert_match /Company name &#9660;/,
+                     sort_link(@s, :company_name, :controller => 'developers')
+      end
+    
+      should "not generate a sort link with a down arrow for a non-sorted column" do
+        assert_no_match /Created at &#9660;/,
+                        sort_link(@s, :created_at, :controller => 'developers')
+      end
+    
+      context "with existing search options" do
+        setup do
+          @s.name_contains = 'a'
+        end
+      
+        should "maintain previous search options in its sort links" do
+          assert_match /search\[name_contains\]=a/,
+                       sort_link(@s, :company_name, :controller => 'companies')
+        end
+      end
+    end
+  end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 5
   - 0
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Ernie Miller
@@ -14,25 +14,86 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-16 00:00:00 -04:00
+date: 2010-06-08 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activerecord
+  name: shoulda
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 3
-        - 0
         - 0
-        - beta
-        version: 3.0.0.beta
+        version: "0"
   type: :development
   version_requirements: *id001
-description: Adds a search method to your ActiveRecord models which returns an object to be used in form_for while constructing a search. Works with Rails 3 only.
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta4
+        version: 3.0.0.beta4
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta4
+        version: 3.0.0.beta4
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta4
+        version: 3.0.0.beta4
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: arel
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :runtime
+  version_requirements: *id005
+description: "\n      Allows simple search forms to be created against an AR3 model\n      and its associations, has useful view helpers for sort links\n      and multiparameter fields as well.\n    "
 email: ernie@metautonomo.us
 executables: []
 
@@ -44,6 +105,8 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- .gitmodules
+- Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -51,11 +114,13 @@ files:
 - lib/meta_search.rb
 - lib/meta_search/builder.rb
 - lib/meta_search/exceptions.rb
-- lib/meta_search/helpers/action_view.rb
+- lib/meta_search/helpers.rb
+- lib/meta_search/helpers/form_builder.rb
+- lib/meta_search/helpers/form_helper.rb
+- lib/meta_search/helpers/url_helper.rb
+- lib/meta_search/method.rb
 - lib/meta_search/model_compatibility.rb
-- lib/meta_search/railtie.rb
 - lib/meta_search/searches/active_record.rb
-- lib/meta_search/searches/base.rb
 - lib/meta_search/utility.rb
 - lib/meta_search/where.rb
 - meta_search.gemspec
@@ -75,7 +140,7 @@ files:
 - test/test_search.rb
 - test/test_view_helpers.rb
 has_rdoc: true
-homepage: http://metautonomo.us
+homepage: http://metautonomo.us/projects/metasearch/
 licenses: []
 
 post_install_message: 
@@ -84,6 +149,7 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -91,6 +157,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -100,10 +167,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: ActiveRecord 3 object-based searching.
+summary: ActiveRecord 3 object-based searching for your form_for enjoyment.
 test_files: 
 - test/fixtures/company.rb
 - test/fixtures/data_type.rb

data/lib/meta_search/helpers/action_view.rb

@@ -1,168 +0,0 @@
-require 'action_view'
-require 'action_dispatch'
-
-module ActionDispatch::Http::FilterParameters #:nodoc:
-  protected
-  # Temp fix for Rails 3 beta buggy parameter filtering on arrays 
-  def process_parameter_filter(original_params) #:nodoc:
-    return original_params.dup unless filtering_parameters?
-
-    filtered_params = {}
-    regexps, blocks = compile_parameter_filter
-
-    original_params.each do |key, value|
-      if regexps.find { |r| key =~ r }
-        value = '[FILTERED]'
-      elsif value.is_a?(Hash)
-        value = process_parameter_filter(value)
-      elsif value.is_a?(Array)
-        value = value.map { |v| v.is_a?(Hash) ? process_parameter_filter(v) : v }
-      elsif blocks.present?
-        key = key.dup
-        value = value.dup if value.duplicable?
-        blocks.each { |b| b.call(key, value) }
-      end
-
-      filtered_params[key] = value
-    end
-
-    filtered_params
-  end
-end
-
-module MetaSearch::Helpers
-  module FormBuilder
-    def self.enable! #:nodoc:
-      ::ActionView::Helpers::FormBuilder.class_eval do
-        include FormBuilder
-        self.field_helpers += ['multiparameter_field', 'check_boxes', 'collection_check_boxes']
-      end
-    end
-    
-    # Like other form_for field methods (text_field, hidden_field, password_field) etc,
-    # but takes a list of hashes between the +method+ parameter and the trailing option hash,
-    # if any, to specify a number of fields to create in multiparameter fashion.
-    #
-    # Each hash *must* contain a :field_type option, which specifies a form_for method, and
-    # _may_ contain an optional :type_cast option, with one of the typical multiparameter
-    # type cast characters. Any remaining options will be merged with the defaults specified
-    # in the trailing option hash and passed along when creating that field.
-    #
-    # For example...
-    #
-    #   <%= f.multiparameter_field :moderations_value_between,
-    #       {:field_type => :text_field, :class => 'first'},
-    #       {:field_type => :text_field, :type_cast => 'i'},
-    #       :size => 5 %>
-    #
-    # ...will create the following HTML:
-    #
-    #   <input class="first" id="search_moderations_value_between(1)"
-    #    name="search[moderations_value_between(1)]" size="5" type="text" />
-    #
-    #   <input id="search_moderations_value_between(2i)"
-    #    name="search[moderations_value_between(2i)]" size="5" type="text" />
-    #
-    # As with any multiparameter input fields, these will be concatenated into an
-    # array and passed to the attribute named by the first parameter for assignment.
-    def multiparameter_field(method, *args)
-      defaults = has_multiparameter_defaults?(args) ? args.pop : {}
-      raise ArgumentError, "No multiparameter fields specified" if args.blank?
-      html = ''.html_safe
-      args.each_with_index do |field, index|
-        type = field.delete(:field_type) || raise(ArgumentError, "No :field_type specified.")
-        cast = field.delete(:type_cast) || ''
-        opts = defaults.merge(field)
-        html.safe_concat(
-          @template.send(
-            type.to_s,
-            @object_name,
-            (method.to_s + "(#{index + 1}#{cast})"),
-            objectify_options(opts))
-          )
-      end
-      html
-    end
-    
-    # Behaves almost exactly like the select method, but instead of generating a select tag,
-    # generates checkboxes. Since these checkboxes are just a checkbox and label with no
-    # additional formatting by default, this method can also take a block parameter.
-    #
-    # *Parameters:*
-    #
-    # * +method+ - The method name on the form_for object
-    # * +choices+ - An array of arrays, the first value in each element is the text for the
-    #   label, and the last is the value for the checkbox
-    # * +options+ - An options hash to be passed through to the checkboxes
-    #
-    # If a block is supplied, rather than just rendering the checkboxes and labels, the block
-    # will receive a hash with two keys, :check_box and :label
-    #
-    # *Examples:*
-    #
-    # Simple usage:
-    #
-    #   <%= f.check_boxes :number_of_heads_in,
-    #       [['One', 1], ['Two', 2], ['Three', 3]], :class => 'checkboxy' %>
-    #
-    # This will result in three checkboxes, with the labels "One", "Two", and "Three", and
-    # corresponding numeric values, which will be sent as an array to the :number_of_heads_in
-    # attribute of the form_for object.
-    #
-    # Additional formatting:
-    #
-    #   <table>
-    #     <th colspan="2">How many heads?</th>
-    #     <% f.check_boxes :number_of_heads_in,
-    #        [['One', 1], ['Two', 2], ['Three', 3]], :class => 'checkboxy' do |c| %>
-    #        <tr>
-    #          <td><%= c[:check_box] %></td>
-    #          <td><%= c[:label] %></td>
-    #        </tr>
-    #     <% end %>
-    #   </table>
-    #
-    # This example will output the checkboxes and labels in a tabular format. You get the idea.
-    def check_boxes(method, choices = [], options = {}, &block)
-      unless choices.first.respond_to?(:first) && choices.first.respond_to?(:last)
-        raise ArgumentError, 'invalid choice array specified'
-      end
-      collection_check_boxes(method, choices, :last, :first, options, &block)
-    end
-    
-    # Just like +check_boxes+, but this time you can pass in a collection, value, and text method,
-    # as with collection_select.
-    #
-    # Example:
-    #
-    #    <%= f.collection_check_boxes :head_sizes_in, HeadSize.all,
-    #        :id, :name, :class => 'head-check' %>
-    def collection_check_boxes(method, collection, value_method, text_method, options = {}, &block)
-      html = ''.html_safe
-      collection.each do |choice|
-        text = choice.send(text_method)
-        value = choice.send(value_method)
-        c = {}
-        c[:check_box] = @template.check_box_tag(
-          "#{@object_name}[#{method}][]",
-          value,
-          [@object.send(method)].flatten.include?(value),
-          options.merge(:id => [@object_name, method.to_s, value.to_s.underscore].join('_'))
-        )
-        c[:label] = @template.label_tag([@object_name, method.to_s, value.to_s.underscore].join('_'),
-                                        text)
-        yield c if block_given?
-        html.safe_concat(c[:check_box] + c[:label])
-      end
-      html
-    end
-    
-    private
-    
-    # If the last element of the arguments to multiparameter_field has no :field_type
-    # key, we assume it's got some defaults to be used in the other hashes.
-    def has_multiparameter_defaults?(args)
-      args.size > 1 && args.last.is_a?(Hash) && !args.last.has_key?(:field_type)
-    end
-  end
-end