meta_search 0.9.3 → 0.9.4

data/CHANGELOG

@@ -1,3 +1,8 @@
+Changes since 0.9.3 (2010-09-08):
+  * Minor documentation fixes.
+  * Add sort_link helper to FormBuilder, to spare keystrokes if sort_links
+    are being added inside the context of the form_for of the search.
+
 Changes since 0.9.2 (2010-08-25):
   * Update dependencies for Rails 3 final.
 

data/README.rdoc

@@ -50,8 +50,8 @@ Or, you can build up any relation you like and call the search method on that ob
 
 === Multi-level associations
 
-MetaSearch will allow you traverse your associations in one form, generating the necessary
-joins along the way. If you have the following models...
+MetaSearch will allow you to traverse your associations in one form, generating the
+necessary joins along the way. If you have the following models...
 
   class Company < ActiveRecord::Base
     has_many :developers
@@ -64,12 +64,12 @@ joins along the way. If you have the following models...
 
 ...you can do this in your form to search your companies by developers with certain notes:
 
-  <%= f.text_field :developers_notes_note %>
+  <%= f.text_field :developers_notes_note_contains %>
 
 You can travel forward and back through the associations, so this would also work (though
 be entirely pointless in this case):
 
-  <%= f.text_field :developers_notes_developer_company_name %>
+  <%= f.text_field :developers_notes_developer_company_name_contains %>
 
 However, to prevent abuse, this is limited to associations of a total "depth" of 5 levels.
 This means that while starting from a Company model, as above, you could do
@@ -202,7 +202,7 @@ All <tt>sort_link</tt>-generated links will have the CSS class sort_link, as wel
 directional class (ascending or descending) if the link is for a currently sorted column,
 for your styling enjoyment.
 
-This feature should hopefully help out those of you migrating from SearchLogic, and a thanks
+This feature should hopefully help out those of you migrating from Searchlogic, and a thanks
 goes out to Ben Johnson for the HTML entities used for the up and down arrows, which provide
 a nice default look.
 

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "meta_search"
-    gem.summary = %Q{ActiveRecord 3 object-based searching for your form_for enjoyment.}
+    gem.summary = %Q{Object-based searching (and more) for simply creating search forms.}
     gem.description = %Q{
       Allows simple search forms to be created against an AR3 model
       and its associations, has useful view helpers for sort links
@@ -19,7 +19,15 @@ begin
     gem.add_dependency "activesupport", "~> 3.0.0"
     gem.add_dependency "actionpack", "~> 3.0.0"
     gem.add_dependency "arel", "~> 1.0.1"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.post_install_message = <<END
+
+*** Thanks for installing MetaSearch! ***
+Be sure to check out http://metautonomo.us/projects/metasearch/ for a
+walkthrough of MetaSearch's features, and click the donate button if
+you're feeling especially appreciative. It'd help me justify this
+"open source" stuff to my lovely wife. :)
+
+END
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.9.3
+0.9.4

data/lib/meta_search/builder.rb

@@ -85,22 +85,6 @@ module MetaSearch
       attribute
     end
 
-    def base_includes_association?(base, assoc)
-      if base._metasearch_include_associations.blank?
-        base.reflect_on_association(assoc.to_sym) unless base._metasearch_exclude_associations.include?(assoc.to_s)
-      else
-        base.reflect_on_association(assoc.to_sym) if base._metasearch_include_associations.include?(assoc.to_s)
-      end
-    end
-
-    def base_includes_attribute?(base, attribute)
-      if base._metasearch_include_attributes.blank?
-        base.column_names.detect(attribute.to_s) unless base._metasearch_exclude_attributes.include?(attribute.to_s)
-      else
-        base.column_names.detect(attribute.to_s) if base._metasearch_include_attributes.include?(attribute.to_s)
-      end
-    end
-
     # Build the search with the given search options. Options are in the form of a hash
     # with keys matching the names creted by the Builder's "wheres" as outlined in
     # MetaSearch::Where

data/lib/meta_search/helpers/form_builder.rb

@@ -135,6 +135,19 @@ module MetaSearch
         check_boxes unless block_given?
       end
 
+      # Creates a sort link for the MetaSearch::Builder the form is created against.
+      # Useful shorthand if your results happen to reside in the context of your
+      # form_for block.
+      # Sample usage:
+      #
+      #   <%= f.sort_link :name %>
+      #   <%= f.sort_link :name, 'Company Name' %>
+      #   <%= f.sort_link :name, :class => 'name_sort' %>
+      #   <%= f.sort_link :name, 'Company Name', :class => 'company_name_sort' %>
+      def sort_link(attribute, *args)
+        @template.sort_link @object, attribute, *args
+      end
+
       private
 
       # If the last element of the arguments to multiparameter_field has no :field_type

data/lib/meta_search/helpers/url_helper.rb

@@ -1,7 +1,21 @@
 module MetaSearch
   module Helpers
     module UrlHelper
-      
+
+      # Generates a column sort link for a given attribute of a MetaSearch::Builder object.
+      # The link maintains existing options for the sort as parameters in the URL, and
+      # sets a meta_sort parameter as well. If the first parameter after the attribute name
+      # is not a hash, it will be used as a string for alternate link text. If a hash is
+      # supplied, it will be passed to link_to as an html_options hash. The link will
+      # be assigned two css classes: sort_link and one of "asc" or "desc", depending on
+      # the current sort order. Any class supplied in the options hash will be appended.
+      #
+      # Sample usage:
+      #
+      #   <%= sort_link @search, :name %>
+      #   <%= sort_link @search, :name, 'Company Name' %>
+      #   <%= sort_link @search, :name, :class => 'name_sort' %>
+      #   <%= sort_link @search, :name, 'Company Name', :class => 'company_name_sort' %>
       def sort_link(builder, attribute, *args)
         raise ArgumentError, "Need a MetaSearch::Builder search object as first param!" unless builder.is_a?(MetaSearch::Builder)
         attr_name = attribute.to_s
@@ -22,9 +36,9 @@ module MetaSearch
                 url_for(options),
                 html_options
       end
-      
+
       private
-      
+
       def order_indicator_for(order)
         if order == 'asc'
           '&#9650;'

data/meta_search.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{meta_search}
-  s.version = "0.9.3"
+  s.version = "0.9.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ernie Miller"]
-  s.date = %q{2010-09-08}
+  s.date = %q{2010-09-18}
   s.description = %q{
       Allows simple search forms to be created against an AR3 model
       and its associations, has useful view helpers for sort links
@@ -60,10 +60,18 @@ Gem::Specification.new do |s|
      "test/test_view_helpers.rb"
   ]
   s.homepage = %q{http://metautonomo.us/projects/metasearch/}
+  s.post_install_message = %q{
+*** Thanks for installing MetaSearch! ***
+Be sure to check out http://metautonomo.us/projects/metasearch/ for a
+walkthrough of MetaSearch's features, and click the donate button if
+you're feeling especially appreciative. It'd help me justify this
+"open source" stuff to my lovely wife. :)
+
+}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{ActiveRecord 3 object-based searching for your form_for enjoyment.}
+  s.summary = %q{Object-based searching (and more) for simply creating search forms.}
   s.test_files = [
     "test/fixtures/company.rb",
      "test/fixtures/data_type.rb",

data/test/helper.rb

@@ -4,6 +4,7 @@ require 'shoulda'
 require 'active_record'
 require 'active_record/fixtures'
 require 'action_view'
+require 'meta_search'
 
 FIXTURES_PATH = File.join(File.dirname(__FILE__), 'fixtures')
 
@@ -26,7 +27,6 @@ Fixtures.create_fixtures(FIXTURES_PATH, ActiveRecord::Base.connection.tables)
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'meta_search'
 
 class Test::Unit::TestCase
   def self.context_a_search_against(name, object, &block)

data/test/test_view_helpers.rb

@@ -152,32 +152,52 @@ class TestViewHelpers < ActionView::TestCase
 <% end -%>
                        ERB
     end
+  end
 
-    context "A form using collection_check_boxes with companies" do
-      setup do
-        @s = Company.search
-        form_for @s do |f|
-          @f = f
-        end
+  context "A form using collection_check_boxes with companies" do
+    setup do
+      @s = Company.search
+      form_for @s do |f|
+        @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 "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)}
+    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}
       end
+      assert_dom_equal output_buffer,
+                       '<p><label for="search_id_in_1">Initech</label> ' +
+                       '<input id="search_id_in_1" name="search[id_in][]" type="checkbox" value="1" /></p>' +
+                       '<p><label for="search_id_in_2">Advanced Optical Solutions</label> ' +
+                       '<input id="search_id_in_2" name="search[id_in][]" type="checkbox" value="2" /></p>' +
+                       '<p><label for="search_id_in_3">Mission Data</label> ' +
+                       '<input id="search_id_in_3" name="search[id_in][]" type="checkbox" value="3" /></p>'
+    end
+  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}
-        end
-        assert_dom_equal output_buffer,
-                         '<p><label for="search_id_in_1">Initech</label> ' +
-                         '<input id="search_id_in_1" name="search[id_in][]" type="checkbox" value="1" /></p>' +
-                         '<p><label for="search_id_in_2">Advanced Optical Solutions</label> ' +
-                         '<input id="search_id_in_2" name="search[id_in][]" type="checkbox" value="2" /></p>' +
-                         '<p><label for="search_id_in_3">Mission Data</label> ' +
-                         '<input id="search_id_in_3" name="search[id_in][]" type="checkbox" value="3" /></p>'
+  context "A company search form sorted by name ascending" do
+    setup do
+      @s = Company.search
+      @s.meta_sort = 'name.asc'
+      form_for @s do |f|
+        @f = f
       end
     end
+
+    should "generate a sort link with an up arrow for the sorted column" do
+      assert_match /Name &#9650;/,
+                   @f.sort_link(: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;/,
+                      @f.sort_link(:created_at, :controller => 'companies')
+    end
   end
 
   context "A company search" do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 9
-  - 3
-  version: 0.9.3
+  - 4
+  version: 0.9.4
 platform: ruby
 authors: 
 - Ernie Miller
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-08 00:00:00 -04:00
+date: 2010-09-18 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -141,7 +141,12 @@ has_rdoc: true
 homepage: http://metautonomo.us/projects/metasearch/
 licenses: []
 
-post_install_message: 
+post_install_message: "\n\
+  *** Thanks for installing MetaSearch! ***\n\
+  Be sure to check out http://metautonomo.us/projects/metasearch/ for a\n\
+  walkthrough of MetaSearch's features, and click the donate button if\n\
+  you're feeling especially appreciative. It'd help me justify this\n\
+  \"open source\" stuff to my lovely wife. :)\n\n"
 rdoc_options: 
 - --charset=UTF-8
 require_paths: 
@@ -168,7 +173,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: ActiveRecord 3 object-based searching for your form_for enjoyment.
+summary: Object-based searching (and more) for simply creating search forms.
 test_files: 
 - test/fixtures/company.rb
 - test/fixtures/data_type.rb