meta_search 0.3.0

data/test/fixtures/schema.rb

@@ -0,0 +1,47 @@
+ActiveRecord::Schema.define do
+
+  create_table "companies", :force => true do |t|
+    t.string   "name"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+  
+  create_table "developers", :force => true do |t|
+    t.integer  "company_id"
+    t.string   "name"
+    t.integer  "salary"
+    t.boolean  "slacker"
+  end
+  
+  create_table "projects", :force => true do |t|
+    t.string   "name"
+    t.float    "estimated_hours"
+  end
+  
+  create_table "developers_projects", :id => false, :force => true do |t|
+    t.integer  "developer_id"
+    t.integer  "project_id"
+  end
+  
+  create_table "notes", :force => true do |t|
+    t.string   "notable_type"
+    t.integer  "notable_id"
+    t.string   "note"
+  end
+
+  create_table "data_types", :force => true do |t|
+    t.integer  "company_id"
+    t.string   "str"
+    t.text     "txt"
+    t.integer  "int"
+    t.float    "flt"
+    t.decimal  "dec"
+    t.datetime "dtm"
+    t.timestamp "tms"
+    t.time     "tim"
+    t.date     "dat"
+    t.binary   "bin"
+    t.boolean  "bln"
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'active_record'
+require 'active_record/fixtures'
+require 'action_view'
+
+FIXTURES_PATH = File.join(File.dirname(__FILE__), 'fixtures')
+
+Time.zone = 'Eastern Time (US & Canada)'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+)
+
+dep = defined?(ActiveSupport::Dependencies) ? ActiveSupport::Dependencies : ::Dependencies
+dep.load_paths.unshift FIXTURES_PATH
+
+ActiveRecord::Base.silence do
+  ActiveRecord::Migration.verbose = false
+  load File.join(FIXTURES_PATH, 'schema.rb')
+end
+
+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'
+require 'meta_search/searches/active_record'
+require 'meta_search/helpers/action_view'
+
+MetaSearch::Searches::ActiveRecord.enable!
+MetaSearch::Helpers::FormBuilder.enable!
+
+class Test::Unit::TestCase
+end

data/test/test_search.rb

@@ -0,0 +1,351 @@
+require 'helper'
+
+class TestSearch < Test::Unit::TestCase
+  
+  context "A company search" do
+    setup do
+      @s = Company.search
+    end
+    
+    should "have an association named developers" do
+      assert @s.association(:developers)
+    end
+    
+    should "have a column named name" do
+      assert @s.column(:name)
+    end
+      
+    should "exclude the column named updated_at" do
+      assert_nil @s.column(:updated_at)
+    end
+    
+    should "raise an error if we try to search on updated_at" do
+      assert_raise NoMethodError do
+        @s.updated_at_eq = [2009, 1, 1]
+      end
+    end
+    
+    should "exclude the association named notes" do
+      assert_nil @s.association(:notes)
+    end
+    
+    should "raise an error if we try to search on notes" do
+      assert_raise NoMethodError do
+        @s.notes_note_eq = 'Blah'
+      end
+    end
+    
+    should "honor its associations' excluded attributes" do
+      assert_nil @s.association_column(:data_types, :str)
+    end
+    
+    should "raise an error if we try to search data_types.str" do
+      assert_raise NoMethodError do
+        @s.data_types_str_eq = 'Blah'
+      end
+    end
+    
+    context "where name contains optical" do
+      setup do
+        @s.name_contains = 'optical'
+      end
+    
+      should "return one result" do
+        assert_equal 1, @s.all.size
+      end
+    
+      should "return a company named Advanced Optical Solutions" do
+        assert_contains @s.all, Company.where(:name => 'Advanced Optical Solutions').first
+      end
+    
+      should "not return a company named Initech" do
+        assert_does_not_contain @s.all, Company.where(:name => "Initech").first
+      end
+    end
+  
+    context "where developer name starts with Ernie" do
+      setup do
+        @s.developers_name_starts_with = 'Ernie'
+      end
+    
+      should "return one result" do
+        assert_equal 1, @s.all.size
+      end
+      
+      should "return a company named Mission Data" do
+        assert_contains @s.all, Company.where(:name => 'Mission Data').first
+      end
+    
+      should "not return a company named Initech" do
+        assert_does_not_contain @s.all, Company.where(:name => "Initech").first
+      end
+      
+      context "and slackers salary is greater than $70k" do
+        setup do
+          @s.slackers_salary_gt = 70000
+        end
+        
+        should "return no results" do
+          assert_equal 0, @s.all.size
+        end
+        
+        should "join developers twice" do
+          assert @s.to_sql.match(/join "developers".*join "developers"/i)
+        end
+        
+        should "alias the second join of developers" do
+          assert @s.to_sql.match(/join "developers" "slackers_companies"/i)
+        end
+      end
+    end
+    
+    context "where developer note indicates he will crack yo skull" do
+      setup do
+        @s.developer_notes_note_equals = "Will show you what he's doing."
+      end
+      
+      should "return one result" do
+        assert_equal 1, @s.all.size
+      end
+      
+      should "return a company named Advanced Optical Solutions" do
+        assert_contains @s.all, Company.where(:name => 'Advanced Optical Solutions').first
+      end
+    
+      should "not return a company named Mission Data" do
+        assert_does_not_contain @s.all, Company.where(:name => "Mission Data").first
+      end
+    end
+  end
+  
+  context "A developer search" do
+    setup do
+      @s = Developer.search
+    end
+    
+    should "have an association named projects" do
+      assert @s.association(:projects)
+    end
+    
+    context "where developer is Bob-approved" do
+      setup do
+        @s.notes_note_equals = "A straight shooter with upper management written all over him."
+      end
+      
+      should "return Peter Gibbons" do
+        assert_contains @s.all, Developer.where(:name => 'Peter Gibbons').first
+      end
+    end
+    
+    context "where name ends with Miller" do
+      setup do
+        @s.name_ends_with = 'Miller'
+      end
+      
+      should "return one result" do
+        assert_equal 1, @s.all.size
+      end
+      
+      should "return a developer named Ernie Miller" do
+        assert_contains @s.all, Developer.where(:name => 'Ernie Miller').first
+      end
+    
+      should "not return a developer named Herb Myers" do
+        assert_does_not_contain @s.all, Developer.where(:name => "Herb Myers").first
+      end
+    end
+    
+    context "where project estimated hours are greater than or equal to 1000" do
+      setup do
+        @s.projects_estimated_hours_gte = 1000
+      end
+      
+      should "return three results" do
+        assert_equal 3, @s.all.size
+      end
+      
+      should "return these developers" do
+        assert_same_elements @s.all.collect {|d| d.name},
+                             ['Peter Gibbons', 'Michael Bolton', 'Samir Nagheenanajar']
+      end
+    end
+    
+    context "where project estimated hours are greater than 1000" do
+      setup do
+        @s.projects_estimated_hours_gt = 1000
+      end
+      
+      should "return no results" do
+        assert_equal 0, @s.all.size
+      end
+    end
+  end
+  
+  context "A data type search" do
+    setup do
+      @s = DataType.search
+    end
+    
+    should "raise an error on a contains search against a boolean column" do
+      assert_raise NoMethodError do
+        @s.bln_contains = "true"
+      end
+    end
+    
+    context "where boolean column equals true" do
+      setup do
+        @s.bln_equals = true
+      end
+      
+      should "return five results" do
+        assert_equal 5, @s.all.size
+      end
+      
+      should "contain no results with a false boolean column" do
+        assert_does_not_contain @s.all.collect {|r| r.bln}, false
+      end
+    end
+    
+    context "where date column is Christmas 2009 by array" do
+      setup do
+        @s.dat_equals = [2009, 12, 25]
+      end
+      
+      should "return one result" do
+        assert_equal 1, @s.all.size
+      end
+      
+      should "contain a result with Christmas 2009 as its date" do
+        assert_equal Date.parse('2009/12/25'), @s.first.dat
+      end
+    end
+    
+    context "where date column is Christmas 2009 by Date object" do
+      setup do
+        @s.dat_equals = Date.new(2009, 12, 25)
+      end
+      
+      should "return one result" do
+        assert_equal 1, @s.all.size
+      end
+      
+      should "contain a result with Christmas 2009 as its date" do
+        assert_equal Date.parse('2009/12/25'), @s.first.dat
+      end
+    end
+    
+    context "where time column is > 1:00 PM and < 3:30 PM" do
+      setup do
+        @s.tim_gt = Time.parse('2000-01-01 13:00') # Rails "dummy time" format
+        @s.tim_lt = Time.parse('2000-01-01 15:30') # Rails "dummy time" format
+      end
+      
+      should "return three results" do
+        assert_equal 3, @s.all.size
+      end
+      
+      should "not contain results with time column before or after constraints" do
+        assert_empty @s.all.select {|r|
+          r.tim < Time.parse('2000-01-01 13:00') || r.tim > Time.parse('2000-01-01 15:30')
+        }
+      end
+    end
+    
+    context "where timestamp column is in the year 2010" do
+      setup do
+        @s.tms_gte = Time.utc(2010, 1, 1)
+      end
+      
+      should "return two results" do
+        assert_equal 2, @s.all.size
+      end
+      
+      should "not contain results with timestamp column before 2010" do
+        assert_empty @s.all.select {|r|
+          r.tms < Time.utc(2010, 1, 1)
+        }
+      end
+    end
+    
+    context "where datetime column is before the year 2010" do
+      setup do
+        @s.tms_lt = Time.utc(2010, 1, 1)
+      end
+      
+      should "return seven results" do
+        assert_equal 7, @s.all.size
+      end
+      
+      should "not contain results with timestamp in 2010" do
+        assert_empty @s.all.select {|r|
+          r.tms >= Time.utc(2010, 1, 1)
+        }
+      end
+    end
+    
+    context "where decimal column is  > 5000" do
+      setup do
+        @s.dec_gt = 5000
+      end
+      
+      should "return four results" do
+        assert_equal 4, @s.all.size
+      end
+      
+      should "not contain results with decimal column <= 5000" do
+        assert_empty @s.all.select {|r|
+          r.dec <= 5000
+        }
+      end
+    end
+    
+    context "where float column is between 2.5 and 3.5" do
+      setup do
+        @s.flt_gte = 2.5
+        @s.flt_lte = 3.5
+      end
+      
+      should "return three results" do
+        assert_equal 3, @s.all.size
+      end
+      
+      should "not contain results with float column outside constraints" do
+        assert_empty @s.all.select {|r|
+          r.flt < 2.5 || r.flt > 3.5
+        }
+      end
+    end
+    
+    context "where integer column is in the set (1, 8, 729)" do
+      setup do
+        @s.int_in = [1, 8, 729]
+      end
+      
+      should "return three results" do
+        assert_equal 3, @s.all.size
+      end
+      
+      should "not contain results outside the specified set" do
+        assert_empty @s.all.select {|r|
+          ![1, 8, 729].include?(r.int)
+        }
+      end
+    end
+    
+    context "where integer column is not in the set (1, 8, 729)" do
+      setup do
+        @s.int_not_in = [1, 8, 729]
+      end
+      
+      should "return six results" do
+        assert_equal 6, @s.all.size
+      end
+      
+      should "not contain results outside the specified set" do
+        assert_empty @s.all.reject {|r|
+          ![1, 8, 729].include?(r.int)
+        }
+      end
+    end
+  end
+end

data/test/test_view_helpers.rb

@@ -0,0 +1,149 @@
+require 'helper'
+require 'action_controller'
+require 'action_view/test_case'
+
+class TestViewHelpers < ActionView::TestCase
+  tests ActionView::Helpers::FormHelper
+  
+  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|
+        @f = f
+      end
+    end
+
+    should "retain previous search terms" do
+      html = @f.datetime_select(:created_at_gte)
+      ['2001', '3', '04', '05'].each do |v|
+        assert_match /<option selected="selected" value="#{v}">#{v}<\/option>/,
+                     html
+      end
+      assert_match /<option selected="selected" value="2">February<\/option>/, html
+      assert_dom_equal '<input id="search_name_contains" name="search[name_contains]" ' +
+                       'size="30" type="text" value="bacon" />',
+                        @f.text_field(:name_contains)
+    end
+  end
+  
+  context "A form using mutiparameter_field with default size option" do
+    setup do
+      @s = Developer.search
+      fields_for :search, @s do |f|
+        @f = f
+      end
+    end
+    
+    should "apply proper cast and default size attribute to text fields" do
+      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)]" ' +
+                       'size="10" type="text" />' +
+                       '<input id="search_salary_in(2i)" name="search[salary_in(2i)]" ' +
+                       'size="10" type="text" />',
+                       html
+    end
+  end
+  
+  context "A form using check_boxes with three choices" do
+    setup do
+      @s = Company.search
+      fields_for :search, @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]])
+    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>'
+    end
+  end
+  
+  context "A form using check_boxes with three choices and a previous selection" do
+    setup do
+      @s = Company.search
+      @s.id_in = [1, 3]
+      fields_for :search, @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]])
+    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>'
+    end
+    
+    context "A form using collection_check_boxes with companies" do
+      setup do
+        @s = Company.search
+        fields_for :search, @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)
+      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}
+        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
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: meta_search
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Ernie Miller
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-16 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta
+        version: 3.0.0.beta
+  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.
+email: ernie@metautonomo.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/meta_search.rb
+- lib/meta_search/builder.rb
+- lib/meta_search/exceptions.rb
+- lib/meta_search/helpers/action_view.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
+- test/fixtures/companies.yml
+- test/fixtures/company.rb
+- test/fixtures/data_type.rb
+- test/fixtures/data_types.yml
+- test/fixtures/developer.rb
+- test/fixtures/developers.yml
+- test/fixtures/developers_projects.yml
+- test/fixtures/note.rb
+- test/fixtures/notes.yml
+- test/fixtures/project.rb
+- test/fixtures/projects.yml
+- test/fixtures/schema.rb
+- test/helper.rb
+- test/test_search.rb
+- test/test_view_helpers.rb
+has_rdoc: true
+homepage: http://metautonomo.us
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: ActiveRecord 3 object-based searching.
+test_files: 
+- test/fixtures/company.rb
+- test/fixtures/data_type.rb
+- test/fixtures/developer.rb
+- test/fixtures/note.rb
+- test/fixtures/project.rb
+- test/fixtures/schema.rb
+- test/helper.rb
+- test/test_search.rb
+- test/test_view_helpers.rb