wvanbergen-scoped_search 0.3.0 → 0.6.0

data/README.rdoc

@@ -1,54 +1,76 @@
-= scoped_search
+h1. "scoped_search":http://github.com/wvanbergen/scoped_search/tree/master
 
-This simple plugin will make it easy to search your ActiveRecord models. Searching is performed using a query string, which should be passed to the named_scope <tt>search_for</tt> that uses SQL %LIKE% conditions for searching. You can specify what fields should be used for searching.
+This simple plugin will make it easy to search your ActiveRecord models. Searching is performed using a query string, which should be passed to the named_scope <tt>search_for</tt> that uses SQL %LIKE% conditions for searching (ILIKE for Postgres). You can specify what fields should be used for searching.
 
-== Installation
+* "scoped_search installation":#INSTALLATION
+* "scoped_search usage":#USAGE
+* "scoped_search license":#LICENSE
 
-You can enable <tt>scoped_search</tt> as a Ruby gem. You must enable the gem in your <tt>environment.rb</tt> configuration:
-  
-  Rails::Initializer.run do |config|
-    ...
-    config.gem 'wvanbergen-scoped_search', :lib => 'scoped_search', :source => 'http://gems.github.com/'
-  end
+<a id="INSTALLATION"/> </a>
+h2. Installing scoped_search
 
-Make sure the gem is installed by running <tt>rake gems:install</tt> in you project root. You can also install the gem by running <tt>sudo gem install wvanbergen-scoped_search -s http://gems.github.com</tt>
+<pre><code>
+gem install wvanbergen-scoped_search
 
-You can use scoped_search as a Rails plugin as well, but this is deprecated. Simply download or
-clone scoped_search into your +vendor/plugins+ directory of your project.
+</code></pre>
 
-== Usage
+<a id="USAGE"/> </a>
+h2. Usage
 
 First, you have to specify in what columns should be searched:
 
-  class Project < ActiveRecord::Base
-    searchable_on :name, :description
-  end
+<pre><code>
+class User < ActiveRecord::Base
+  searchable_on :first_name, :last_name
+end
 
-Now, the +search_for+ scope is available for queries. You should pass a query string to the scope. This can be empty or nil, in which case all no search conditions are set (and all records will be returned).
+</code></pre>
 
-  Project.search_for(params[:q]).each { |project| ... }
+Now, the *search_for* scope is available for queries. You should pass a query string to the scope. 
+This can be empty or nil, in which case all no search conditions are set (and all records will be returned).
 
-The search query language is simple. It supports these constructs:
+<pre><code>
+User.search_for(params[:q]).each { |project| ... }
+
+</code></pre>
+
+You can also search on associate models.  This works with *belongs_to*, *has_one*, *has_many*, 
+*has_many :through*, and *HABTM*.  For example if a User *has_many* Notes (title, content, created_at, updated_at)
+
+<pre><code>
+class User < ActiveRecord::Base
+  has_many: notes
+  searchable_on :first_name, :last_name, :notes_title, :notes_content
+end
 
+</code></pre>
+
+The search query language is simple. It supports these constructs:
 * words: some search keywords
 * phrases: "a single search phrase"
 * negation: "look for this" -"but do not look for this phrase and this" -word
+* OR words/phrases: word/phrase OR word/phrase.  Example: "Hello World" OR "Hello Moon"
+* dates: mm/dd/yyyy, dd/mm/yyyy, yyyy/mm/dd, yyyy-mm-dd
+* date ranges: > date, >= date, < date, <= date, date TO date.  Examples: > mm/dd/yyyy, < yyyy-mm-dd
 
 This functionality is build on named_scope. The searchable_on statement creates 
-a named_scope "search_for". Because of this, you can actually chain the call with
+a named_scope *search_for*. Because of this, you can actually chain the call with
 other scopes. For example, this can be very useful if you only want to search in 
 projects that are accessible by a given user.
 
-  class Project < ActiveRecord::Base
-    searchable_on :name, :description
-    named_scope :accessible_by, lambda { |user| ... }
-  end
+<pre><code>
+class Project < ActiveRecord::Base
+  searchable_on :name, :description
+  named_scope :accessible_by, lambda { |user| ... }
+end
   
-  # using chained named_scopes and will_paginate
-  Project.accessible_by(current_user).search_for(params[:q]).paginate(:page => params[:page], :include => :tasks)
+# using chained named_scopes and will_paginate
+Project.accessible_by(current_user).search_for(params[:q]).paginate(:page => params[:page], :include => :tasks)
+
+</code></pre>
+
+<a id="LICENSE"/> </a>
+h2. License
 
-== Disclaimer
+This plugin is released under the MIT license. Please contact (willem AT vanbergen DOT org) if you have any suggestions or remarks. 
 
-This Rails plugin is written by Willem van Bergen for the Floorplanner.com website. It is 
-released under the <b>MIT license</b>. Please contact me (willem AT vanbergen DOT org if 
-you have any suggestions or remarks.

data/TODO

@@ -2,16 +2,22 @@ TODO items for named_scope
 ==========================
 Contact willem AT vanbergen DOT org if you want to help out
 
+0.6.0
+- Add test for Postgres
+- Add test for MySQL
 
-New features:
-- Search fields of associations as well
-- Allow smart searches.  Example: "90 days ago", "Yesterday", "10 days from now" 
 
-Refactoring:
-- For searchable_on(*fields) make it so that instead of fields it accepts options (a hash) where 
-  :only and :except can be values.  That way it is possible for all fields to be loaded except 
-  the ones specified with :except.
+0.7.0
+
+
+0.8.0
+
+
+0.9.0
+
+
+1.0.0
+
 
 Documentation & testing:
-- Put something useful in the wiki
 - Add rdoc en comments to code

data/lib/scoped_search/query_conditions_builder.rb

@@ -107,7 +107,31 @@ module ScopedSearch
     end    
     
     def as_of_date(keyword_name, value)
-      helper_date_operation('=', keyword_name, value)
+      retVal = []
+      begin
+        dt = Date.parse(value) # This will throw an exception if it is not valid
+        @query_params[keyword_name] = dt.to_s
+        @query_fields.each do |field, field_type|  #|key,value| 
+          if field_type == :date or field_type == :datetime or field_type == :timestamp
+            retVal << "#{field} = :#{keyword_name.to_s}"
+          end
+        end
+      rescue
+        # do not search on any date columns since the date is invalid
+      end
+      
+      # Search the text fields for the date as well as it could be in text.
+      # Also still search on the text columns for an invalid date as it could
+      # have a different meaning.
+      keyword_name_b = "#{keyword_name}b".to_sym
+      @query_params[keyword_name_b] = "%#{value}%"
+      @query_fields.each do |field, field_type|  #|key,value| 
+        if field_type == :string or field_type == :text
+          retVal << "#{field} LIKE :#{keyword_name_b.to_s}"
+        end
+      end
+
+      "(#{retVal.join(' OR ')})"      
     end
     
     def greater_than_date(keyword_name, value)

data/lib/scoped_search.rb

@@ -9,9 +9,35 @@ module ScopedSearch
     end
   
     # Creates a named scope in the class it was called upon
-    def searchable_on(*fields)
-      self.cattr_accessor :scoped_search_fields
+    def searchable_on(*fields)      
+      if fields.first.class.to_s == 'Hash'
+        if fields.first.has_key?(:only)
+          fields = fields.first[:only]
+        elsif fields.first.has_key?(:except)
+          fields = self.column_names.collect { |column| 
+                     fields.first[:except].include?(column.to_sym) ? nil : column.to_sym }.compact
+        end
+      end
+
+      assoc_models = self.reflections.collect { |m| m[0] }
+      assoc_fields = fields - self.column_names.collect { |column| column.to_sym }
+      fields -= assoc_fields
+
+      assoc_groupings = {}
+      assoc_models.each do |assoc_model|
+        assoc_groupings[assoc_model] = []
+      	assoc_fields.each do |assoc_field|
+      	  unless assoc_field.to_s.match(/^#{assoc_model.to_s}_/).nil?
+            assoc_groupings[assoc_model] << assoc_field.to_s.sub(/^#{assoc_model.to_s}_/, '').to_sym 
+          end
+        end
+      end
+      
+      assoc_groupings = assoc_groupings.delete_if {|group, field_group| field_group.empty?}
+
+      self.cattr_accessor :scoped_search_fields, :scoped_search_assoc_groupings
       self.scoped_search_fields = fields
+      self.scoped_search_assoc_groupings = assoc_groupings
       self.named_scope :search_for, lambda { |keywords| self.build_scoped_search_conditions(keywords) }
     end
   
@@ -28,9 +54,22 @@ module ScopedSearch
           query_fields[field_name] = self.columns_hash[field.to_s].type
         end
         
+        assoc_models_to_include = []
+        self.scoped_search_assoc_groupings.each do |group|
+          assoc_models_to_include << group[0]
+          group[1].each do |group_field|
+            field_name = connection.quote_table_name(group[0].to_s.pluralize) + "." + connection.quote_column_name(group_field)
+            query_fields[field_name] = self.reflections[group[0]].klass.columns_hash[group_field.to_s].type
+          end
+        end
+        
         search_conditions = QueryLanguageParser.parse(search_string) 
         conditions = QueryConditionsBuilder.build_query(search_conditions, query_fields) 
-        return {:conditions => conditions}
+        
+        retVal = {:conditions => conditions}
+        retVal[:include] = assoc_models_to_include unless assoc_models_to_include.empty?
+
+        return retVal
       end
     end
   end

data/test/search_for_test.rb

@@ -5,62 +5,146 @@ class ScopedSearchTest < Test::Unit::TestCase
   def setup
     setup_db
     SearchTestModel.create_corpus!
+    Group.create_corpus!
+    Location.create_corpus!
+    Address.create_corpus!
+    User.create_corpus!
+    Client.create_corpus!
+    Office.create_corpus!
+    Note.create_corpus!
   end
 
   def teardown
     teardown_db
   end
   
-  # def test_enabling
-  #   assert !SearchTestModel.respond_to?(:search_for)
-  #   SearchTestModel.searchable_on :string_field, :text_field, :date_field
-  #   assert SearchTestModel.respond_to?(:search_for)
-  #   
-  #   assert_equal ActiveRecord::NamedScope::Scope, SearchTestModel.search_for('test').class
-  # end
-  # 
+  def test_enabling
+    assert !SearchTestModel.respond_to?(:search_for)
+    SearchTestModel.searchable_on :string_field, :text_field, :date_field
+    assert SearchTestModel.respond_to?(:search_for)
+  
+    assert_equal ActiveRecord::NamedScope::Scope, SearchTestModel.search_for('test').class
+  end  
+  
+  def test_search_only_fields
+    SearchTestModel.searchable_on :only => [:string_field, :text_field, :date_field]
+    assert SearchTestModel.respond_to?(:search_for)
+    assert_equal SearchTestModel.scoped_search_fields.size, 3
+    assert SearchTestModel.scoped_search_fields.include?(:string_field)
+    assert SearchTestModel.scoped_search_fields.include?(:text_field)
+    assert SearchTestModel.scoped_search_fields.include?(:date_field)
+  end
+  
+  def test_search_except_fields
+    SearchTestModel.searchable_on :except => [:id, :ignored_field, :created_at, :updated_at]
+    assert SearchTestModel.respond_to?(:search_for)
+    assert_equal SearchTestModel.scoped_search_fields.size, 3
+    assert SearchTestModel.scoped_search_fields.include?(:string_field)
+    assert SearchTestModel.scoped_search_fields.include?(:text_field)
+    assert SearchTestModel.scoped_search_fields.include?(:date_field)
+  end  
+  
+  def test_search_with_only_and_except
+    # :except should be ignored if :only is specified.
+    SearchTestModel.searchable_on({:only => [:text_field], :except => [:text_field]})
+    assert SearchTestModel.respond_to?(:search_for)
+    assert_equal SearchTestModel.scoped_search_fields.size, 1
+    assert SearchTestModel.scoped_search_fields.include?(:text_field), ':except should be ignored if :only is specified'
+  end  
+  
   def test_search
     SearchTestModel.searchable_on :string_field, :text_field, :date_field
-    
-    assert_equal 16, SearchTestModel.search_for('').count
+  
+    assert_equal SearchTestModel.count, SearchTestModel.search_for('').count
     assert_equal 0, SearchTestModel.search_for('456').count   
     assert_equal 2, SearchTestModel.search_for('hays').count 
     assert_equal 1, SearchTestModel.search_for('hay ob').count        
-    assert_equal 14, SearchTestModel.search_for('o').count    
+    assert_equal 15, SearchTestModel.search_for('o').count    
     assert_equal 2, SearchTestModel.search_for('-o').count
-    assert_equal 14, SearchTestModel.search_for('-Jim').count
+    assert_equal 15, SearchTestModel.search_for('-Jim').count
     assert_equal 1, SearchTestModel.search_for('Jim -Bush').count
     assert_equal 1, SearchTestModel.search_for('"Hello World" -"Goodnight Moon"').count    
     assert_equal 2, SearchTestModel.search_for('Wes OR Bob').count
     assert_equal 3, SearchTestModel.search_for('"Happy cow" OR "Sad Frog"').count
     assert_equal 3, SearchTestModel.search_for('"Man made" OR Dogs').count
     assert_equal 2, SearchTestModel.search_for('Cows OR "Frog Toys"').count   
-    
+  
     # ** DATES **   
     #
     # The next two dates are invalid therefore it will be ignored.  
-    # Thus it would be the same as searching for an empty string
-    assert_equal 16, SearchTestModel.search_for('2/30/1980').count 
-    assert_equal 16, SearchTestModel.search_for('99/99/9999').count
-
+    # Since it is just a date being searched for it will also
+    # be searched for in text fields regardless of whether or 
+    # not it is a valid date.
+    assert_equal 0, SearchTestModel.search_for('2/30/1980').count 
+    assert_equal 0, SearchTestModel.search_for('99/99/9999').count
+  
     assert_equal 1, SearchTestModel.search_for('9/27/1980').count
     assert_equal 1, SearchTestModel.search_for('hays 9/27/1980').count
-    assert_equal 2, SearchTestModel.search_for('hays 2/30/1980').count    
-    assert_equal 1, SearchTestModel.search_for('2006/07/15').count
-    
+    assert_equal 0, SearchTestModel.search_for('hays 2/30/1980').count 
+  
     assert_equal 1, SearchTestModel.search_for('< 12/01/1980').count    
-    assert_equal 5, SearchTestModel.search_for('> 1/1/2006').count
-    
+    assert_equal 6, SearchTestModel.search_for('> 2006/1/1').count
+  
     assert_equal 5, SearchTestModel.search_for('< 12/26/2002').count 
     assert_equal 6, SearchTestModel.search_for('<= 12/26/2002').count   
-    
-    assert_equal 5, SearchTestModel.search_for('> 2/5/2005').count 
-    assert_equal 6, SearchTestModel.search_for('>= 2/5/2005').count   
-    
+  
+    assert_equal 6, SearchTestModel.search_for('> 2/5/2005').count 
+    assert_equal 7, SearchTestModel.search_for('>= 2/5/2005').count   
+  
     assert_equal 3, SearchTestModel.search_for('1/1/2005 TO 1/1/2007').count 
-
+  
     assert_equal 2, SearchTestModel.search_for('Happy 1/1/2005 TO 1/1/2007').count 
+       
+    # This should return one with a date of 7/15/2006 found in the text.
+    assert_equal 2, SearchTestModel.search_for('7/15/2006').count
+  end
+  
+  def test_search_belongs_to_association
+    User.searchable_on :first_name, :last_name, :group_name
+      
+    assert_equal User.count, User.search_for('').count        
+    assert_equal 1, User.search_for('Wes').count     
+    assert_equal 2, User.search_for('System Administrator').count
+    assert_equal 2, User.search_for('Managers').count
   end
+  
+  def test_search_has_many_association
+    User.searchable_on :first_name, :last_name, :notes_title, :notes_content
+
+    assert_equal User.count, User.search_for('').count        
+    assert_equal 2, User.search_for('Router').count     
+    assert_equal 1, User.search_for('milk').count
+    assert_equal 1, User.search_for('"Spec Tests"').count
+    assert_equal 0, User.search_for('Wes "Spec Tests"').count
+  end  
+  
+  def test_search_has_many_through_association
+    User.searchable_on :first_name, :last_name, :clients_first_name, :clients_last_name
+      
+    assert_equal User.count, User.search_for('').count        
+    assert_equal 2, User.search_for('Smith').count     
+    assert_equal 1, User.search_for('Sam').count
+    assert_equal 1, User.search_for('Johnson').count
+  end  
+  
+  def test_search_has_one_association
+    User.searchable_on :first_name, :last_name, :address_street, :address_city, :address_state, :address_postal_code
+          
+    assert_equal User.count, User.search_for('').count        
+    assert_equal 1, User.search_for('Fernley').count     
+    assert_equal 4, User.search_for('NV').count
+    assert_equal 1, User.search_for('Haskell').count  
+    assert_equal 2, User.search_for('89434').count        
+  end  
+  
+  def test_search_has_and_belongs_to_many_association
+    User.searchable_on :first_name, :last_name, :locations_name
+  
+    assert_equal User.count, User.search_for('').count        
+    assert_equal 2, User.search_for('Office').count     
+    assert_equal 1, User.search_for('Store').count
+    assert_equal 1, User.search_for('John Office').count
+  end  
 
 end
 

data/test/test_helper.rb

@@ -15,6 +15,44 @@ def setup_db
       t.date :date_field
       t.timestamps
     end
+    
+    create_table :users do |t|
+      t.string :first_name, :last_name, :login
+      t.integer :group_id
+      t.integer :address_id
+    end   
+    
+    create_table :clients do |t|
+      t.string :first_name, :last_name
+    end     
+    
+    create_table :offices do |t|
+      t.string :name
+      t.integer :user_id, :client_id
+    end    
+    
+    create_table :groups do |t|
+      t.string :name
+    end    
+    
+    create_table :locations do |t|
+      t.string :name
+    end   
+    
+    create_table :locations_users, :id => false, :force => true do |t|
+      t.integer :user_id
+      t.integer :location_id
+    end 
+    
+    create_table :notes do |t|
+      t.string :title
+      t.text :content
+      t.integer :user_id
+    end      
+    
+    create_table :addresses do |t|
+      t.string :street, :city, :state, :postal_code
+    end  
   end
 end
 
@@ -39,6 +77,130 @@ class SearchTestModel < ActiveRecord::Base
     create!(:string_field => "Excited Frog",   :text_field => "Sad Frog",       :ignored_field => "123456l", :date_field => '2006-07-15')    
     create!(:string_field => "Man made",       :text_field => "Woman made",     :ignored_field => "123456m", :date_field => '2007-06-13')
     create!(:string_field => "Cat Toys",       :text_field => "Frog Toys",      :ignored_field => "123456n", :date_field => '2008-03-04') 
-    create!(:string_field => "Happy Toys",     :text_field => "Sad Toys",       :ignored_field => "123456n", :date_field => '2008-05-12')
+    create!(:string_field => "Happy Toys",     :text_field => "Sad Toys",       :ignored_field => "123456n", :date_field => '2008-05-12') 
+
+    create!(:string_field => "My son was born on 7/15/2006 and weighed 5.5 lbs",     
+            :text_field => "Sad Toys",       
+            :ignored_field => "123456n", 
+            :date_field => '2008-09-22')
+  end
+end
+
+class User < ActiveRecord::Base
+  belongs_to :group
+  belongs_to :address
+  has_many :notes
+  has_and_belongs_to_many :locations
+  
+  has_many :offices, :dependent => :destroy
+  has_many :clients, :through => :offices  
+  def self.create_corpus!
+    create!(:first_name => 'Willem',  :last_name => 'Van Bergen', :login => 'wvanbergen', :group_id => 1, :address_id => 1) 
+    create!(:first_name => 'Wes',     :last_name => 'Hays',       :login => 'weshays',    :group_id => 1, :address_id => 2) 
+    create!(:first_name => 'John',    :last_name => 'Dell',       :login => 'jdell',      :group_id => 2, :address_id => 3) 
+    create!(:first_name => 'Ray',     :last_name => 'York',       :login => 'ryork',      :group_id => 3, :address_id => 4) 
+    create!(:first_name => 'Anna',    :last_name => 'Landis',     :login => 'alandis',    :group_id => 4, :address_id => 5) 
+    
+    user = self.find_by_first_name('Willem')
+    user.locations << Location.find_by_name('Office')
+    
+    user = self.find_by_first_name('Wes')
+    user.locations << Location.find_by_name('Store')
+    
+    user = self.find_by_first_name('John')
+    user.locations << Location.find_by_name('Office')
+    
+    user = self.find_by_first_name('Ray')
+    user.locations << Location.find_by_name('Home')
+    
+    user = self.find_by_first_name('Anna')
+    user.locations << Location.find_by_name('Beach')                
+  end
+end
+
+class Client < ActiveRecord::Base
+  has_many :offices, :dependent => :destroy
+  has_many :users, :through => :offices
+  def self.create_corpus!
+    create!(:first_name => 'Bob',    :last_name => 'Smith') 
+    create!(:first_name => 'Sam',    :last_name => 'Lovett')
+    create!(:first_name => 'Sally',  :last_name => 'May')
+    create!(:first_name => 'Mary',   :last_name => 'Smith')
+    create!(:first_name => 'Darren', :last_name => 'Johnson')
+  end
+end
+
+class Office < ActiveRecord::Base
+  belongs_to :client
+  belongs_to :user
+  def self.create_corpus!
+    create!(:name => 'California Office', :user_id => 1, :client_id => 1)
+    create!(:name => 'California Office', :user_id => 2, :client_id => 2)
+    create!(:name => 'California Office', :user_id => 3, :client_id => 3)
+    create!(:name => 'Reno Office',       :user_id => 4, :client_id => 4)
+    create!(:name => 'Reno Office',       :user_id => 5, :client_id => 5)        
+  end
+end
+
+class Group < ActiveRecord::Base
+  has_many :users
+  def self.create_corpus!
+    create!(:name => 'System Administrator') 
+    create!(:name => 'Software Managers')    
+    create!(:name => 'Office Managers')      
+    create!(:name => 'Accounting')           
+  end
+end
+
+class Location < ActiveRecord::Base
+  has_and_belongs_to_many :users
+  def self.create_corpus!
+    create!(:name => 'Home')   
+    create!(:name => 'Office') 
+    create!(:name => 'Store')  
+    create!(:name => 'Beach')  
+  end
+end
+
+class Note < ActiveRecord::Base
+  belongs_to :user
+  def self.create_corpus!
+    wes = User.find_by_first_name('Wes')
+    john = User.find_by_first_name('John')
+    
+    create!(:user_id => wes.id,         
+            :title   => 'Purchases', 
+            :content => "1) Linksys Router. 2) Network Cable")   
+            
+    create!(:user_id => wes.id,         
+            :title  => 'Tasks',
+            :content => 'Clean my car, walk the dog and mow the yard buy milk') 
+            
+    create!(:user_id => wes.id,         
+            :title   => 'Grocery List',
+            :content => 'milk, gum, apples')  
+            
+    create!(:user_id => wes.id,         
+            :title   => 'Stocks to watch',
+            :content => 'MA, AAPL, V and SSO.  Straddle MA at 200 with JAN 09 options')            
+    
+    create!(:user_id => john.id,        
+            :title   => 'Spec Tests',
+            :content => 'Spec Tests... Spec Tests... Spec Tests!!')   
+            
+    create!(:user_id => john.id,        
+            :title   => 'Things To Do',
+            :content => '1) Did I mention Spec Tests!!!, 2) Buy Linksys Router WRT160N')
+  end
+end
+
+class Address < ActiveRecord::Base
+  has_one :user
+  def self.create_corpus!
+    create!(:street => '800 Haskell St',     :city => 'Reno',       :state => 'NV', :postal_code => '89509') 
+    create!(:street => '2499 Dorchester Rd', :city => 'Charleston', :state => 'SC', :postal_code => '29414')
+    create!(:street => '474 Mallard Way',    :city => 'Fernley',    :state => 'NV', :postal_code => '89408')
+    create!(:street => '1600 Montero Ct',    :city => 'Sparks',     :state => 'NV', :postal_code => '89434')
+    create!(:street => '200 4th St',         :city => 'Sparks',     :state => 'NV', :postal_code => '89434')
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wvanbergen-scoped_search
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Willem van Bergen
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-21 00:00:00 -07:00
+date: 2008-09-23 00:00:00 -07:00
 default_executable: 
 dependencies: []