meta_search 0.5.0 → 0.5.1

data/CHANGELOG

@@ -0,0 +1,3 @@
+Changes since 0.5.0 (2010-06-08):
+  * Fix searching against relations derived from a has_many :through
+    association

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.5.1

data/lib/meta_search/builder.rb

@@ -37,7 +37,7 @@ module MetaSearch
       @relation = base_or_relation.scoped
       @base = @relation.klass
       @opts = opts
-      @join_dependency = ActiveRecord::Associations::ClassMethods::JoinDependency.new(@base, @relation.joins_values, nil)
+      @join_dependency = build_join_dependency
       @search_attributes = {}
     end
 
@@ -134,6 +134,45 @@ module MetaSearch
       end
     end
 
+    def build_join_dependency
+      joins = @relation.joins_values.map {|j| j.respond_to?(:strip) ? j.strip : j}.uniq
+
+      association_joins = joins.select do |j|
+        [Hash, Array, Symbol].include?(j.class) && !array_of_strings?(j)
+      end
+
+      stashed_association_joins = joins.select do |j|
+        j.is_a?(ActiveRecord::Associations::ClassMethods::JoinDependency::JoinAssociation)
+      end
+
+      non_association_joins = (joins - association_joins - stashed_association_joins)
+      custom_joins = custom_join_sql(*non_association_joins)
+
+      ActiveRecord::Associations::ClassMethods::JoinDependency.new(@base, association_joins, custom_joins)
+    end
+
+    def custom_join_sql(*joins)
+      arel = @relation.table
+      joins.each do |join|
+        next if join.blank?
+
+        case join
+        when Hash, Array, Symbol
+          if array_of_strings?(join)
+            join_string = join.join(' ')
+            arel = arel.join(join_string)
+          end
+        else
+          arel = arel.join(join)
+        end
+      end
+      arel.joins(arel)
+    end
+
+    def array_of_strings?(o)
+      o.is_a?(Array) && o.all?{|obj| obj.is_a?(String)}
+    end
+
     def build_sort_method
       singleton_class.instance_eval do
         define_method(:meta_sort) do

data/lib/meta_search/helpers/form_builder.rb

@@ -2,15 +2,11 @@ require 'action_view'
 require 'action_view/template'
 module MetaSearch
   Check = Struct.new(:box, :label)
-  
+
   module Helpers
     module FormBuilder
       extend ActiveSupport::Concern
-      
-      included do
-        self.field_helpers += ['multiparameter_field', 'check_boxes', 'collection_check_boxes']
-      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.
@@ -55,7 +51,7 @@ module MetaSearch
         end
         html
       end
-    
+
       # Behaves almost exactly like the select method, but instead of generating a select tag,
       # generates <tt>MetaSearch::Check</tt>s. These consist of two attributes, +box+ and +label+,
       # which are (unsurprisingly) the HTML for the check box and the label. Called without a block,
@@ -107,13 +103,13 @@ module MetaSearch
         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,
+      #   <% f.collection_check_boxes :head_sizes_in, HeadSize.all,
       #       :id, :name, :class => 'headcheck' do |check| %>
       #     <%= check.box %> <%= check.label %>
       #   <% end %>
@@ -139,9 +135,9 @@ module MetaSearch
         end
         check_boxes unless block_given?
       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)

data/meta_search.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{meta_search}
-  s.version = "0.5.0"
+  s.version = "0.5.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ernie Miller"]
-  s.date = %q{2010-06-08}
+  s.date = %q{2010-07-20}
   s.description = %q{
       Allows simple search forms to be created against an AR3 model
       and its associations, has useful view helpers for sort links
@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
     ".document",
      ".gitignore",
      ".gitmodules",
+     "CHANGELOG",
      "Gemfile",
      "LICENSE",
      "README.rdoc",

data/test/helper.rb

@@ -15,7 +15,7 @@ ActiveRecord::Base.establish_connection(
 )
 
 dep = defined?(ActiveSupport::Dependencies) ? ActiveSupport::Dependencies : ::Dependencies
-dep.load_paths.unshift FIXTURES_PATH
+dep.autoload_paths.unshift FIXTURES_PATH
 
 ActiveRecord::Base.silence do
   ActiveRecord::Migration.verbose = false

data/test/test_search.rb

@@ -562,4 +562,42 @@ class TestSearch < Test::Unit::TestCase
       end
     end
   end
+
+  context_a_search_against "a relation derived from a joined association",
+                           Company.where(:name => "Initech").first.developers do
+    should "not raise an error" do
+      assert_nothing_raised do
+        @s.all
+      end
+    end
+
+    should "return all developers for that company without conditions" do
+      assert_equal Company.where(:name => 'Initech').first.developers.all, @s.all
+    end
+
+    should "allow conditions on the search" do
+      @s.name_equals = 'Peter Gibbons'
+      assert_equal Developer.where(:name => 'Peter Gibbons').first,
+                   @s.first
+    end
+  end
+
+  context_a_search_against "a relation derived from a joined HM:T association",
+                           Company.where(:name => "Initech").first.developer_notes do
+    should "not raise an error" do
+      assert_nothing_raised do
+        @s.all
+      end
+    end
+
+    should "return all developer notes for that company without conditions" do
+      assert_equal Company.where(:name => 'Initech').first.developer_notes.all, @s.all
+    end
+
+    should "allow conditions on the search" do
+      @s.note_equals = 'A straight shooter with upper management written all over him.'
+      assert_equal Note.where(:note => 'A straight shooter with upper management written all over him.').first,
+                   @s.first
+    end
+  end
 end

data/test/test_view_helpers.rb

@@ -5,7 +5,7 @@ require 'action_view/test_case'
 class TestViewHelpers < ActionView::TestCase
   tests MetaSearch::Helpers::FormHelper
   include MetaSearch::Helpers::UrlHelper
-  
+
   router = ActionDispatch::Routing::RouteSet.new
   router.draw do |map|
     resources :developers
@@ -15,23 +15,23 @@ class TestViewHelpers < ActionView::TestCase
     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
+
+      def _routes
+        @routes ||= ActionDispatch::Routing::RouteSet.new
       end
     end
     @controller = @controller.new
   end
-  
+
   context "A previously-filled search form" do
     setup do
       @s = Company.search
@@ -54,7 +54,7 @@ class TestViewHelpers < ActionView::TestCase
                         @f.text_field(:name_contains)
     end
   end
-  
+
   context "A form using mutiparameter_field with default size option" do
     setup do
       @s = Developer.search
@@ -62,9 +62,9 @@ class TestViewHelpers < ActionView::TestCase
         @f = f
       end
     end
-    
+
     should "apply proper cast and default size attribute to text fields" do
-      html = @f.multiparameter_field :salary_in, 
+      html = @f.multiparameter_field :salary_in,
              {:field_type => :text_field, :type_cast => 'i'},
              {:field_type => :text_field, :type_cast => 'i'}, :size => 10
       assert_dom_equal '<input id="search_salary_in(1i)" name="search[salary_in(1i)]" ' +
@@ -74,7 +74,7 @@ class TestViewHelpers < ActionView::TestCase
                        html
     end
   end
-  
+
   context "A form using check_boxes with three choices" do
     setup do
       @s = Company.search
@@ -82,11 +82,11 @@ class TestViewHelpers < ActionView::TestCase
         @f = f
       end
     end
-    
+
     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
       expected = <<-EXPECTED
 <p>
@@ -113,7 +113,7 @@ class TestViewHelpers < ActionView::TestCase
       ERB
     end
   end
-  
+
   context "A form using check_boxes with three choices and a previous selection" do
     setup do
       @s = Company.search
@@ -122,11 +122,11 @@ class TestViewHelpers < ActionView::TestCase
         @f = f
       end
     end
-    
+
     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
       expected = <<-EXPECTED
 <p>
@@ -152,7 +152,7 @@ class TestViewHelpers < ActionView::TestCase
 <% end -%>
                        ERB
     end
-    
+
     context "A form using collection_check_boxes with companies" do
       setup do
         @s = Company.search
@@ -160,11 +160,11 @@ class TestViewHelpers < ActionView::TestCase
           @f = f
         end
       end
-      
+
       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.box %></p>", :locals => {:c => c}
@@ -179,32 +179,32 @@ 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')
@@ -212,32 +212,32 @@ class TestViewHelpers < ActionView::TestCase
       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')

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 5
-  - 0
-  version: 0.5.0
+  - 1
+  version: 0.5.1
 platform: ruby
 authors: 
 - Ernie Miller
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-08 00:00:00 -04:00
+date: 2010-07-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -106,6 +106,7 @@ files:
 - .document
 - .gitignore
 - .gitmodules
+- CHANGELOG
 - Gemfile
 - LICENSE
 - README.rdoc