texticle 2.0.2 → 2.0.3

data/CHANGELOG.rdoc

@@ -1,3 +1,22 @@
+== 2.0.3
+
+* 1 new feature
+
+  * Allow searching through relations. Model.join(:relation).search(:relation => {:column => "query"})
+    works, and reduces the need for multi-model tables. Huge thanks to Ben Hamill for the pull request.
+  * Allow searching through all model columns irrespective of the column's type; we cast all columns to text
+    in the search query. Performance may degrade when searching through anything but a string column.
+
+* 2 bugfixes
+
+  * Fix exceptions when adding Texticle to a table-less model.
+  * Column names in a search query are now scoped to the current table.
+
+* 1 dev improvement
+
+  * Running `rake` from the project root will setup the test environment by creating a test database
+    and running the necessary migrations. `rake` can also be used to run all the project tests.
+
 == 2.0.2
 
 * 1 bugfix
@@ -25,7 +44,7 @@
 
       require 'texticle/searchable'
       class Game
-        include Searchable(:title)
+        extend Searchable(:title)
       end
 
     This also allows Texticle use in Rails without having #search available to all models:

data/README.rdoc

@@ -38,6 +38,19 @@ Your models now have access to the search method:
   Game.search_by_title_and_system('Final Fantasy', 'PS2')
   Game.search_by_title_or_system('Final Fantasy, 'PS3')
 
+=== Creating Indexes for Super Speed
+You can have Postgresql use an index for the full-text search.  To declare a full-text index, in a
+migration add code like the following:
+
+  execute "
+      create index on email_logs using gin(to_tsvector('english', subject));
+      create index on email_logs using gin(to_tsvector('english', email_address));"
+
+In the above example, the table email_logs has two text columns that we search against, subject and email_address.
+You will need to add an index for every text/string column you query against, or else Postgresql will revert to a
+full table scan instead of using the indexes.
+
+
 == REQUIREMENTS:
 
 * ActiveRecord

data/Rakefile

@@ -5,27 +5,58 @@ require 'pg'
 require 'active_record'
 require 'benchmark'
 
-require File.expand_path(File.dirname(__FILE__) + '/spec/spec_helper')
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/spec')
+
+task :default do
+  config = File.open(File.expand_path(File.dirname(__FILE__) + '/spec/config.yml')).read
+  if config.match /<username>/
+    print "Would you like to create and configure the test database? y/n "
+    continue = STDIN.getc
+    exit 0 unless continue == "Y" || continue == "y"
+    sh "createdb texticle"
+    File.open(File.expand_path(File.dirname(__FILE__) + '/spec/config.yml'), "w") do |writable_config|
+      writable_config << config.sub(/<username>/, `whoami`.chomp)
+    end
+    Rake::Task["db:migrate"].invoke
+  end
+  Rake::Task["test"].invoke
+end
+
+task :test do
+  require 'texticle_spec'
+  require 'texticle/searchable_spec'
+end
 
 namespace :db do
   desc 'Run migrations for test database'
   task :migrate do
+    require 'spec_helper'
     ActiveRecord::Migration.instance_eval do
       create_table :games do |table|
         table.string :system
         table.string :title
+        table.text :description
       end
       create_table :web_comics do |table|
         table.string :name
         table.string :author
+        table.text :review
+        table.integer :id
+      end
+      create_table :characters do |table|
+        table.string :name
+        table.string :description
+        table.integer :web_comic_id
       end
     end
   end
   desc 'Drop tables from test database'
   task :drop do
+    require 'spec_helper'
     ActiveRecord::Migration.instance_eval do
       drop_table :games
       drop_table :web_comics
+      drop_table :characters
     end
   end
 end

data/lib/texticle.rb

@@ -1,9 +1,9 @@
 require 'active_record'
 
 module Texticle
-
   def search(query = "", exclusive = true)
-    language = connection.quote(searchable_language)
+    @similarities = []
+    @conditions = []
 
     unless query.is_a?(Hash)
       exclusive = false
@@ -12,20 +12,12 @@ module Texticle
       end
     end
 
-    similarities = []
-    conditions = []
-
-    query.each do |column, search_term|
-      column = connection.quote_column_name(column)
-      search_term = connection.quote normalize(Helper.normalize(search_term))
-      similarities << "ts_rank(to_tsvector(#{language}, #{quoted_table_name}.#{column}), to_tsquery(#{language}, #{search_term}))"
-      conditions << "to_tsvector(#{language}, #{column}) @@ to_tsquery(#{language}, #{search_term})"
-    end
+    parse_query_hash(query)
 
     rank = connection.quote_column_name('rank' + rand.to_s)
 
-    select("#{quoted_table_name + '.*,' if scoped.select_values.empty?} #{similarities.join(" + ")} AS #{rank}").
-      where(conditions.join(exclusive ? " AND " : " OR ")).
+    select("#{quoted_table_name + '.*,' if scoped.select_values.empty?} #{@similarities.join(" + ")} AS #{rank}").
+      where(@conditions.join(exclusive ? " AND " : " OR ")).
       order("#{rank} DESC")
   end
 
@@ -45,23 +37,41 @@ module Texticle
     else
       super
     end
+  rescue ActiveRecord::StatementInvalid
+    super
   end
 
   def respond_to?(method, include_private = false)
     return super if self == ActiveRecord::Base
     Helper.dynamic_search_method?(method, self.columns) or super
-  rescue ActiveRecord::StatementInvalid
+  rescue StandardError
     super
   end
 
   private
 
+  def parse_query_hash(query, table_name = quoted_table_name)
+    language = connection.quote(searchable_language)
+    table_name = connection.quote_table_name(table_name)
+
+    query.each do |column_or_table, search_term|
+      if search_term.is_a?(Hash)
+        parse_query_hash(search_term, column_or_table)
+      else
+        column = connection.quote_column_name(column_or_table)
+        search_term = connection.quote normalize(Helper.normalize(search_term))
+        @similarities << "ts_rank(to_tsvector(#{language}, #{table_name}.#{column}::text), to_tsquery(#{language}, #{search_term}::text))"
+        @conditions << "to_tsvector(#{language}, #{table_name}.#{column}::text) @@ to_tsquery(#{language}, #{search_term}::text)"
+      end
+    end
+  end
+
   def normalize(query)
     query
   end
 
   def searchable_columns
-    columns.select {|column| column.type == :string }.map(&:name)
+    columns.select {|column| [:string, :text].include? column.type }.map(&:name)
   end
 
   def searchable_language
@@ -91,7 +101,7 @@ module Texticle
       end
 
       def exclusive_dynamic_search_method?(method, class_columns)
-        string_columns = class_columns.select {|column| column.type == :string }.map(&:name)
+        string_columns = class_columns.map(&:name)
         columns = exclusive_dynamic_search_columns(method)
         unless columns.empty?
           columns.all? {|column| string_columns.include?(column) }
@@ -101,7 +111,7 @@ module Texticle
       end
 
       def inclusive_dynamic_search_method?(method, class_columns)
-        string_columns = class_columns.select {|column| column.type == :string }.map(&:name)
+        string_columns = class_columns.map(&:name)
         columns = inclusive_dynamic_search_columns(method)
         unless columns.empty?
           columns.all? {|column| string_columns.include?(column) }
@@ -116,5 +126,4 @@ module Texticle
       end
     end
   end
-
 end

data/lib/texticle/searchable.rb

@@ -5,11 +5,11 @@ def Searchable(*searchable_columns)
 
     include Texticle
 
-    private
-
     define_method(:searchable_columns) do
       searchable_columns.map(&:to_s)
     end
+
+    private :searchable_columns
   end
 end
 

data/spec/texticle/searchable_spec.rb

@@ -1,16 +1,11 @@
 require 'spec_helper'
+require 'fixtures/webcomic'
 require 'texticle/searchable'
 
-class WebComic < ActiveRecord::Base
-  # string :name
-  # string :author
-end
-
 class SearchableTest < Test::Unit::TestCase
-
   context "when extending an ActiveRecord::Base subclass" do
     setup do
-      @qcont = WebComic.create :name => "Questionable Content", :author => "Jeff Jaques"
+      @qcont = WebComic.create :name => "Questionable Content", :author => "Jeph Jaques"
       @jhony = WebComic.create :name => "Johnny Wander", :author => "Ananth & Yuko"
       @ddeeg = WebComic.create :name => "Dominic Deegan", :author => "Mookie"
       @penny = WebComic.create :name => "Penny Arcade", :author => "Tycho & Gabe"
@@ -18,11 +13,12 @@ class SearchableTest < Test::Unit::TestCase
 
     teardown do
       WebComic.delete_all
+      #Object.send(:remove_const, :WebComic) if defined?(WebComic)
     end
 
-    context "with no paramters" do
+    context "with no parameters" do
       setup do
-        WebComic.extend(Searchable)
+        WebComic.extend Searchable
       end
 
       should "search across all columns" do
@@ -33,18 +29,27 @@ class SearchableTest < Test::Unit::TestCase
 
     context "with one column as parameter" do
       setup do
-        WebComic.extend(Searchable(:name))
+        WebComic.extend Searchable(:name)
       end
 
       should "only search across the given column" do
         assert_equal [@penny], WebComic.search("Penny")
         assert_empty WebComic.search("Tycho")
       end
+
+      should "define :searchable_columns as private" do
+        assert_raise(NoMethodError) { WebComic.searchable_columns }
+        begin
+          WebComic.searchable_columns
+        rescue NoMethodError => error
+          assert_match error.message, /private method/
+        end
+      end
     end
 
     context "with two columns as parameters" do
       setup do
-        WebComic.extend(Searchable(:name, :author))
+        WebComic.extend Searchable(:name, :author)
       end
 
       should "only search across the given column" do
@@ -53,5 +58,4 @@ class SearchableTest < Test::Unit::TestCase
       end
     end
   end
-
 end

data/spec/texticle_spec.rb

@@ -1,25 +1,14 @@
 # coding: utf-8
 require 'spec_helper'
-
-class Game < ActiveRecord::Base
-  # string :system
-  # string :title
-
-  def to_s
-    "#{system}: #{title}"
-  end
-end
-
-class NotThere < ActiveRecord::Base
-
-end
+require 'fixtures/webcomic'
+require 'fixtures/character'
+require 'fixtures/game'
 
 class TexticleTest < Test::Unit::TestCase
-
   context "after extending ActiveRecord::Base" do
-    setup do
-      ActiveRecord::Base.extend(Texticle)
-    end
+    # before(:all)
+    ActiveRecord::Base.extend(Texticle)
+    class NotThere < ActiveRecord::Base; end
 
     should "not break #respond_to?" do
       assert_nothing_raised do
@@ -35,31 +24,85 @@ class TexticleTest < Test::Unit::TestCase
     end
 
     should "not break #method_missing" do
+      assert_raise(NoMethodError) { ActiveRecord::Base.random }
       begin
         ActiveRecord::Base.random
       rescue NoMethodError => error
         assert_match error.message, /undefined method `random'/
       end
     end
+
+    should "not break #method_missing for table-less classes" do
+      assert !NotThere.table_exists?
+      assert_raise(NoMethodError) { NotThere.random }
+      begin
+        NotThere.random
+      rescue NoMethodError => error
+        assert_match error.message, /undefined method `random'/
+      end
+    end
+
+    context "when finding models based on searching a related model" do
+      setup do
+        @qc = WebComic.create :name => "Questionable Content", :author => "Jeph Jaques"
+        @jw = WebComic.create :name => "Johnny Wander", :author => "Ananth & Yuko"
+        @pa = WebComic.create :name => "Penny Arcade", :author => "Tycho & Gabe"
+
+        @gabe = @pa.characters.create :name => 'Gabe', :description => 'the simple one'
+        @tycho = @pa.characters.create :name => 'Tycho', :description => 'the wordy one'
+        @div = @pa.characters.create :name => 'Div', :description => 'a crude divx player with anger management issues'
+
+        @martin = @qc.characters.create :name => 'Martin', :description => 'the insecure protagonist'
+        @faye = @qc.characters.create :name => 'Faye', :description => 'a sarcastic barrista with anger management issues'
+        @pintsize = @qc.characters.create :name => 'Pintsize', :description => 'a crude AnthroPC'
+
+        @ananth = @jw.characters.create :name => 'Ananth', :description => 'Stubble! What is under that hat?!?'
+        @yuko = @jw.characters.create :name => 'Yuko', :description => 'So... small. Carl Sagan haircut.'
+        @john = @jw.characters.create :name => 'John', :description => 'Tall. Anger issues?'
+        @cricket = @jw.characters.create :name => 'Cricket', :description => 'Chirrup!'
+      end
+
+      teardown do
+        WebComic.delete_all
+        Character.delete_all
+      end
+
+      should "look in the related model with nested searching syntax" do
+        assert_equal [@jw], WebComic.joins(:characters).search(:characters => {:description => 'tall'})
+        assert_equal [@pa, @jw, @qc].sort, WebComic.joins(:characters).search(:characters => {:description => 'anger'}).sort
+        assert_equal [@pa, @qc].sort, WebComic.joins(:characters).search(:characters => {:description => 'crude'}).sort
+      end
+    end
   end
 
   context "after extending an ActiveRecord::Base subclass" do
+    # before(:all)
+    class ::GameFail < Game; end
+
     setup do
-      Game.extend(Texticle)
-      @zelda = Game.create :system => "NES",     :title => "Legend of Zelda"
-      @mario = Game.create :system => "NES",     :title => "Super Mario Bros."
-      @sonic = Game.create :system => "Genesis", :title => "Sonic the Hedgehog"
-      @dkong = Game.create :system => "SNES",    :title => "Diddy's Kong Quest"
-      @megam = Game.create :system => nil,       :title => "Mega Man"
-      @sfnes = Game.create :system => "SNES",    :title => "Street Fighter 2"
-      @sfgen = Game.create :system => "Genesis", :title => "Street Fighter 2"
-      @takun = Game.create :system => "Saturn",  :title => "Magical Tarurūto-kun"
+      @zelda = Game.create :system => "NES",     :title => "Legend of Zelda",    :description => "A Link to the Past."
+      @mario = Game.create :system => "NES",     :title => "Super Mario Bros.",  :description => "The original platformer."
+      @sonic = Game.create :system => "Genesis", :title => "Sonic the Hedgehog", :description => "Spiky."
+      @dkong = Game.create :system => "SNES",    :title => "Diddy's Kong Quest", :description => "Donkey Kong Country 2"
+      @megam = Game.create :system => nil,       :title => "Mega Man",           :description => "Beware Dr. Brain"
+      @sfnes = Game.create :system => "SNES",    :title => "Street Fighter 2",   :description => "Yoga Flame!"
+      @sfgen = Game.create :system => "Genesis", :title => "Street Fighter 2",   :description => "Yoga Flame!"
+      @takun = Game.create :system => "Saturn",  :title => "Magical Tarurūto-kun", :description => "カッコイイ！"
     end
 
     teardown do
       Game.delete_all
     end
 
+    should "not break respond_to? when connection is unavailable" do
+      GameFail.establish_connection({:adapter => :postgresql, :database =>'unavailable', :username=>'bad', :pool=>5, :timeout=>5000}) rescue nil
+
+      assert_nothing_raised do
+        GameFail.respond_to?(:search)
+      end
+
+    end
+
     should "define a #search method" do
       assert Game.respond_to?(:search)
     end
@@ -108,6 +151,10 @@ class TexticleTest < Test::Unit::TestCase
       should "scope consecutively" do
         assert_equal [@sfgen], Game.search(:system => "Genesis").search(:title => "Street Fighter")
       end
+
+      should "cast non-:string columns as text" do
+        assert_equal [@mario], Game.search(:id => @mario.id)
+      end
     end
 
     context "when using dynamic search methods" do
@@ -116,10 +163,15 @@ class TexticleTest < Test::Unit::TestCase
         assert_equal [@takun], Game.search_by_system("Saturn")
       end
 
-      should "generate methods for any combination of :string columns" do
+      should "generate methods for each :text column" do
+        assert_equal [@mario], Game.search_by_description("platform")
+      end
+
+      should "generate methods for any combination of :string and :text columns" do
         assert_equal [@mario], Game.search_by_title_and_system("Mario", "NES")
         assert_equal [@sonic], Game.search_by_system_and_title("Genesis", "Sonic")
         assert_equal [@mario], Game.search_by_title_and_title("Mario", "Mario")
+        assert_equal [@megam], Game.search_by_title_and_description("Man", "Brain")
       end
 
       should "generate methods for inclusive searches" do
@@ -130,8 +182,8 @@ class TexticleTest < Test::Unit::TestCase
         assert_equal [@sfgen], Game.search_by_system("Genesis").search_by_title("Street Fighter")
       end
 
-      should "not generate methods for non-:string columns" do
-        assert_raise(NoMethodError) { Game.search_by_id }
+      should "generate methods for non-:string columns" do
+        assert_equal [@mario], Game.search_by_id(@mario.id)
       end
 
       should "work with #respond_to?" do
@@ -140,8 +192,8 @@ class TexticleTest < Test::Unit::TestCase
         assert Game.respond_to?(:search_by_system_and_title)
         assert Game.respond_to?(:search_by_system_or_title)
         assert Game.respond_to?(:search_by_title_and_title_and_title)
+        assert Game.respond_to?(:search_by_id)
 
-        assert !Game.respond_to?(:search_by_id)
         assert !Game.respond_to?(:search_by_title_and_title_or_title)
       end
 
@@ -160,24 +212,20 @@ class TexticleTest < Test::Unit::TestCase
   end
 
   context "when setting a custom search language" do
+    def Game.searchable_language
+      'spanish'
+    end
+
     setup do
-      def Game.searchable_language
-        'spanish'
-      end
       Game.create :system => "PS3", :title => "Harry Potter & the Deathly Hallows"
     end
 
     teardown do
-      def Game.searchable_language
-        'english'
-      end
       Game.delete_all
     end
 
     should "still find results" do
       assert_not_empty Game.search_by_title("harry")
-      p
     end
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: texticle
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,42 +10,63 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-10 00:00:00.000000000 -04:00
-default_executable: 
+date: 2011-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &2156472340 !ruby/object:Gem::Requirement
+  requirement: &70337748621180 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.11.0
   type: :development
   prerelease: false
-  version_requirements: *2156472340
+  version_requirements: *70337748621180
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2156471820 !ruby/object:Gem::Requirement
+  requirement: &70337748620400 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.11.3
   type: :development
   prerelease: false
-  version_requirements: *2156471820
+  version_requirements: *70337748620400
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70337748619540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70337748619540
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &70337748618760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.6
+  type: :development
+  prerelease: false
+  version_requirements: *70337748618760
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2156471320 !ruby/object:Gem::Requirement
+  requirement: &70337748617780 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156471320
+  version_requirements: *70337748617780
 description: ! "Texticle exposes full text search capabilities from PostgreSQL, extending\n
   \   ActiveRecord with scopes making search easy and fun!"
 email:
@@ -68,7 +89,6 @@ files:
 - spec/texticle_spec.rb
 - spec/texticle/searchable_spec.rb
 - spec/config.yml
-has_rdoc: true
 homepage: http://tenderlove.github.com/texticle
 licenses: []
 post_install_message: 
@@ -91,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: texticle
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Texticle exposes full text search capabilities from PostgreSQL