wvanbergen-scoped_search 1.0.0 → 1.0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,13 @@
+= Changelog for scoped_search
+
+The following changes were incorporated in each scoped_search release.
+
+== scoped_search 0.3.0
+- Detection of column types so they can be handled properly
+- Date based queries supported on date and time fields
+
+== scoped_search 0.2.0
+- OR keyword supported in query language
+
+== scoped_search 0.1.0
+- Initial version

data/{README → README.rdoc}

@@ -1,12 +1,10 @@
-= scoped_search[http://github.com/wvanbergen/scoped_search/tree/master]
+= scoped_search
 
 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 *search_for* that uses SQL %LIKE% conditions for searching (ILIKE for Postgres). You can specify what fields should be used for searching.
 
-
 == Installing
 
-	gem install wvanbergen-scoped_search
-
+	gem install wvanbergen-scoped_search -s http://gems.github.com
 
 == Usage
 
@@ -54,6 +52,13 @@ projects that are accessible by a given user.
 	Project.accessible_by(current_user).search_for(params[:q]).paginate(:page => params[:page], :include => :tasks)
 
 
+== Additional resources
+
+* Source code: http://github.com/wvanbergen/scoped_search
+* Project wiki: http://wiki.github.com/wvanbergen/scoped_search
+* RDoc documentation: http://wvanbergen.github.com/scoped_search
+* wvanbergen's blog posts: http://techblog.floorplanner.com/tag/scoped_search/
+
 == License
 
 This plugin is released under the MIT license. Please contact (willem AT vanbergen DOT org) if you have any suggestions or remarks. 

data/Rakefile

@@ -1,25 +1,43 @@
-require 'rubygems'
-require 'rake/rdoctask'
-
 Dir['tasks/*.rake'].each { |file| load(file) }
  
-desc 'Default: run unit tests.'
 task :default => [:test]
 
-##############################################
-# Build RDocs
-##############################################
-desc 'Generate documentation for the acts_as_callback_logger plugin.'
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'doc/html'
-  rdoc.title    = 'scoped_search'  
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.main = 'README'
-  rdoc.rdoc_files.include('README',
-                          'CHANGELOG',
-                          'LICENSE',
-                          'TODO',
-                          'lib/')
-end
-##############################################
+namespace :test do
+  
+  desc "Run tests for all configured databases in test/database.yml"
+  task :all do
+    
+    databases = YAML.load(File.read(File.dirname(__FILE__) + '/test/database.yml'))
+    databases.each do |database, config|
+      puts "\nRunning testsuite on #{database} database...\n\n"
+      sh "rake test DATABASE=#{database}"
+    end
+    puts "\nFinished testing for all configured databases!"
+    puts "(Configure databases by adjusting test/database.yml)"
+  end
+  
+  task :single do
+    database = ENV['DATABASE'] || 'sqlite3'
+    puts "Running testsuite on #{database} database...\n"
+    sh "rake test DATABASE=#{database}"
+  end
+  
+  desc "Run tests on SQLite3 database"
+  task :sqlite3 do
+    puts "Running testsuite on SQLite3 database...\n"
+    sh 'rake test DATABASE=sqlite3'
+  end
+
+  desc "Run tests on MySQL database"  
+  task :mysql do
+    puts "Running testsuite on MySQL database...\n"
+    sh 'rake test DATABASE=mysql'    
+  end
+  
+  desc "Run tests on PostgrSQL database"
+  task :postgresql do
+    puts "Running testsuite on PostgreSQL database...\n"
+    sh 'rake test DATABASE=postgresql'    
+  end
 
+end

data/TODO.rdoc

@@ -0,0 +1,6 @@
+= TODO items for scoped_search
+
+Contact me at my GitHub account (http://github.com/wvanbergen) if you want to help out.
+
+== Documentation & testing
+- Add rdoc and comments to code

data/tasks/github-gem.rake

@@ -26,17 +26,88 @@ module Rake
         desc "Updates the file lists for this gem"
         task(:manifest) { manifest_task }
 
-        desc "Builds a .gem package for #{@name}"
-        task(:build) { build_task } 
+        desc "Releases a new version of #{@name}"
+        task(:build => [:manifest]) { build_task } 
+        
         
+        release_dependencies = [:check_clean_master_branch, :version, :build, :create_tag]
+        release_dependencies.push 'doc:publish' if has_rdoc?
+        release_dependencies.unshift 'test' if has_tests?
+        release_dependencies.unshift 'spec' if has_specs?
+                
         desc "Releases a new version of #{@name}"
-        task(:release) { release_task } 
+        task(:release => release_dependencies) { release_task } 
+        
+        # helper task for releasing
+        task(:check_clean_master_branch) { verify_clean_status('master') }
+        task(:check_version) { verify_version(ENV['VERSION'] || @specification.version) }
+        task(:version => [:check_version]) { set_gem_version! }
+        task(:create_tag) { create_version_tag! }
+      end
+      
+      # Register RDoc tasks
+      if has_rdoc?
+        require 'rake/rdoctask'
         
-      end    
+        namespace(:doc) do 
+          desc 'Generate documentation for request-log-analyzer'
+          Rake::RDocTask.new(:compile) do |rdoc|
+            rdoc.rdoc_dir = 'doc'
+            rdoc.title    = @name
+            rdoc.options += @specification.rdoc_options
+            rdoc.rdoc_files.include(@specification.extra_rdoc_files)
+            rdoc.rdoc_files.include('lib/**/*.rb')
+          end
+          
+          desc "Publish RDoc files for #{@name} to Github"
+          task(:publish => :compile) do
+            sh 'git checkout gh-pages'
+            sh 'git pull origin gh-pages'
+            sh 'cp -rf doc/* .'
+            sh "git commit -am \"Publishing newest RDoc documentation for #{@name}\""
+            sh "git push origin gh-pages"
+            sh "git checkout master"
+          end
+        end
+      end
+    
+      # Setup :spec task if RSpec files exist
+      if has_specs?
+        require 'spec/rake/spectask'
+
+        desc "Run all specs for #{@name}"
+        Spec::Rake::SpecTask.new(:spec) do |t|
+          t.spec_files = FileList['spec/**/*_spec.rb']
+        end
+      end
+      
+      # Setup :test task if unit test files exist
+      if has_tests?
+        require 'rake/testtask'
+
+        desc "Run all unit tests for #{@name}"
+        Rake::TestTask.new(:test) do |t|
+          t.pattern = 'test/**/*_test.rb'
+          t.verbose = true
+          t.libs << 'test'
+        end
+      end      
     end
     
     protected 
 
+    def has_rdoc?
+      @specification.has_rdoc
+    end
+
+    def has_specs?
+      Dir['spec/**/*_spec.rb'].any?
+    end
+    
+    def has_tests?
+      Dir['test/**/*_test.rb'].any?
+    end
+
     def reload_gemspec!
       raise "No gemspec file found!" if gemspec_file.nil?      
       spec = File.read(gemspec_file)
@@ -110,6 +181,12 @@ module Rake
       newest_version = run_command('git tag').map { |tag| tag.split(name + '-').last }.compact.map { |v| Gem::Version.new(v) }.max
       raise "This version number (#{new_version}) is not higher than the highest tagged version (#{newest_version})" if !newest_version.nil? && newest_version >= Gem::Version.new(new_version.to_s)
     end
+    
+    def set_gem_version!
+      # update gemspec file
+      self.gemspec_version = ENV['VERSION'] if Gem::Version.correct?(ENV['VERSION'])
+      self.gemspec_date    = Date.today
+    end
 
     def manifest_task
       verify_current_branch('master')
@@ -153,19 +230,19 @@ module Rake
       sh "gem uninstall #{name}"
     end    
     
-    def release_task
-      verify_clean_status('master')
-      verify_version(ENV['VERSION'] || @specification.version)
-      
-      # update gemspec file
-      self.gemspec_version = ENV['VERSION'] if Gem::Version.correct?(ENV['VERSION'])
-      self.gemspec_date    = Date.today
-      manifest_task      
+    def create_version_tag!
+      # commit the gemspec file
       git_commit_file(gemspec_file, "Updated #{gemspec_file} for release of version #{@specification.version}") if git_modified?(gemspec_file)
 
       # create tag and push changes
       git_create_tag("#{@name}-#{@specification.version}", "Tagged version #{@specification.version}")
-      git_push('origin', 'master', [:tags])
+      git_push('origin', 'master', [:tags])     
+    end
+    
+    def release_task
+      puts
+      puts '------------------------------------------------------------'
+      puts "Released #{@name} - version #{@specification.version}"
     end
   end
 end

data/test/database.yml

@@ -0,0 +1,17 @@
+sqlite3:
+  adapter: "sqlite3"
+  database: ":memory:"
+  
+mysql:
+  adapter: "mysql"
+  host: "localhost"
+  user: "root"
+  password:
+  database: "scoped_search_test"
+  
+postgresql:
+  adapter: "postgresql"
+  host: "localhost"
+  username: "sstest"
+  password: "sstest"
+  database: "scoped_search_test"  

data/test/integration/api_test.rb

@@ -0,0 +1,52 @@
+require "#{File.dirname(__FILE__)}/../test_helper.rb"
+
+class ScopedSearch::Test::API < Test::Unit::TestCase
+
+  def self.const_missing(const)
+    ScopedSearch::Test::Models.const_get(const)
+  end
+
+  def setup
+    ScopedSearch::Test::establish_connection
+    ScopedSearch::Test::DatabaseSchema.up
+  end
+
+  def teardown
+      ScopedSearch::Test::DatabaseSchema.down    
+  end
+  
+  def test_enabling
+    assert !Foo.respond_to?(:search_for)
+    Foo.searchable_on :string_field, :text_field, :date_field
+    assert Foo.respond_to?(:search_for)
+      
+    assert_equal ActiveRecord::NamedScope::Scope, Foo.search_for('test').class
+  end  
+  
+  def test_search_only_fields
+    Foo.searchable_on :only => [:string_field, :text_field, :date_field]
+    assert Foo.respond_to?(:search_for)
+    assert_equal Foo.scoped_search_fields.size, 3
+    assert Foo.scoped_search_fields.include?(:string_field)
+    assert Foo.scoped_search_fields.include?(:text_field)
+    assert Foo.scoped_search_fields.include?(:date_field)
+  end
+  
+  def test_search_except_fields
+    Foo.searchable_on :except => [:id, :ignored_field, :created_at, :updated_at]
+    assert Foo.respond_to?(:search_for)
+    assert_equal Foo.scoped_search_fields.size, 3
+    assert Foo.scoped_search_fields.include?(:string_field)
+    assert Foo.scoped_search_fields.include?(:text_field)
+    assert Foo.scoped_search_fields.include?(:date_field)
+  end  
+  
+  def test_search_with_only_and_except
+    # :except should be ignored if :only is specified.
+    Foo.searchable_on({:only => [:text_field], :except => [:text_field]})
+    assert Foo.respond_to?(:search_for)
+    assert_equal Foo.scoped_search_fields.size, 1
+    assert Foo.scoped_search_fields.include?(:text_field), ':except should be ignored if :only is specified'
+  end  
+  
+end

data/test/lib/test_models.rb

@@ -0,0 +1,148 @@
+module ScopedSearch::Test::Models
+    
+  class Foo < ActiveRecord::Base
+    def self.create_corpus!
+      create!(:string_field => "Programmer 123", :text_field => nil,              :ignored_field => "123456",  :date_field => '2000-01-01')    
+      create!(:string_field => "Jim",            :text_field => "Henson",         :ignored_field => "123456a", :date_field => '2001-04-15')   
+      create!(:string_field => "Jim",            :text_field => "Bush",           :ignored_field => "123456b", :date_field => '2001-04-17')    
+      create!(:string_field => "Wes",            :text_field => "Hays",           :ignored_field => "123456c", :date_field => '1980-09-27')  
+      create!(:string_field => "Bob",            :text_field => "Hays",           :ignored_field => "123456d", :date_field => '2002-11-09')  
+      create!(:string_field => "Dogs",           :text_field => "Pit Bull",       :ignored_field => "123456e", :date_field => '2002-12-26') 
+      create!(:string_field => "Dogs",           :text_field => "Eskimo",         :ignored_field => "123456f", :date_field => '2003-03-19')
+      create!(:string_field => "Cows",           :text_field => "Farms",          :ignored_field => "123456g", :date_field => '2004-05-01')
+      create!(:string_field => "Hello World",    :text_field => "Hello Moon",     :ignored_field => "123456h", :date_field => '2004-07-11')   
+      create!(:string_field => "Hello World",    :text_field => "Goodnight Moon", :ignored_field => "123456i", :date_field => '2004-09-12')
+      create!(:string_field => "Happy Cow",      :text_field => "Sad Cow",        :ignored_field => "123456j", :date_field => '2005-02-05')
+      create!(:string_field => "Happy Frog",     :text_field => "Sad Frog",       :ignored_field => "123456k", :date_field => '2006-03-09')
+      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 => "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 << ScopedSearch::Test::Models::Location.find_by_name('Office')
+    
+      user = self.find_by_first_name('Wes')
+      user.locations << ScopedSearch::Test::Models::Location.find_by_name('Store')
+    
+      user = self.find_by_first_name('John')
+      user.locations << ScopedSearch::Test::Models::Location.find_by_name('Office')
+    
+      user = self.find_by_first_name('Ray')
+      user.locations << ScopedSearch::Test::Models::Location.find_by_name('Home')
+    
+      user = self.find_by_first_name('Anna')
+      user.locations << ScopedSearch::Test::Models::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  = ScopedSearch::Test::Models::User.find_by_first_name('Wes')
+      john = ScopedSearch::Test::Models::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
+end

data/test/lib/test_schema.rb

@@ -0,0 +1,66 @@
+ActiveRecord::Migration.verbose = false unless ENV.has_key?('DEBUG')
+
+class ScopedSearch::Test::DatabaseSchema < ActiveRecord::Migration
+
+  def self.up
+    
+    create_table :foos do |t|
+      t.string :string_field
+      t.text :text_field
+      t.string :ignored_field
+      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
+
+  def self.down
+    drop_table :foos    
+    drop_table :users     
+    drop_table :clients     
+    drop_table :offices     
+    drop_table :groups     
+    drop_table :locations     
+    drop_table :locations_users    
+    drop_table :notes     
+    drop_table :addresses
+  end
+
+end