texticle 2.0.pre3 → 2.0.pre4

data/CHANGELOG.rdoc

@@ -1,3 +1,23 @@
+== 2.0.pre4
+
+* 1 new feature
+
+  * Searchable is now available to specify which columns you want searched:
+
+      require 'texticle/searchable'
+      class Game
+        include Searchable(:title)
+      end
+
+    This also allows Texticle use in Rails without having #search available to all models:
+
+      gem 'texticle', '~> 2.0.pre4', :require => 'texticle/searchable'
+
+* 1 bugfix
+
+  * ActiveRecord::Base.extend(Texticle) doesn't break #method_missing and #respond_to? anymore
+
+
 == 2.0.pre3
 
 * 1 new feature

data/Manifest.txt

@@ -4,10 +4,9 @@ Manifest.txt
 README.rdoc
 Rakefile
 lib/texticle.rb
-lib/texticle/full_text_index.rb
-lib/texticle/railtie.rb
-lib/texticle/tasks.rb
-rails/init.rb
-test/helper.rb
-test/test_full_text_index.rb
-test/test_texticle.rb
+lib/texticle/rails.rb
+lib/texticle/searchable.rb
+spec/config.yml
+spec/spec_helper.rb
+spec/texticle_spec.rb
+spec/texticle/searchable_spec.rb

data/README.rdoc

@@ -1,5 +1,7 @@
 = texticle
 
+Further documentation available at:
+
 * http://tenderlove.github.com/texticle
 
 == DESCRIPTION:
@@ -33,6 +35,7 @@ Your models now have access to the search method:
   Game.search('Sonic') # will search through the model's :string columns
   Game.search(:title => 'Mario')
   Game.search_by_title('Street Fighter').search_by_system('PS3')
+  Game.search_by_title_and_system('Final Fantasy', 'PS2')
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -15,6 +15,17 @@ namespace :db do
         table.string :system
         table.string :title
       end
+      create_table :web_comics do |table|
+        table.string :name
+        table.string :author
+      end
+    end
+  end
+  desc 'Drop tables from test database'
+  task :drop do
+    ActiveRecord::Migration.instance_eval do
+      drop_table :games
+      drop_table :web_comics
     end
   end
 end

data/lib/texticle/searchable.rb

@@ -0,0 +1,16 @@
+require 'texticle'
+
+def Searchable(*searchable_columns)
+  Module.new do
+
+    include Texticle
+
+    private
+
+    define_method(:searchable_columns) do
+      searchable_columns.map(&:to_s)
+    end
+  end
+end
+
+Searchable = Texticle

data/lib/texticle.rb

@@ -6,11 +6,10 @@ module Texticle
     language = connection.quote('english')
 
     exclusive = true
-    string_columns = columns.select {|column| column.type == :string }.map(&:name)
 
     unless query.is_a?(Hash)
       exclusive = false
-      query = string_columns.inject({}) do |terms, column|
+      query = searchable_columns.inject({}) do |terms, column|
         terms.merge column => query.to_s
       end
     end
@@ -18,11 +17,6 @@ module Texticle
     similarities = []
     conditions = []
 
-    select_values = scoped.select_values.map(&:to_s) & string_columns
-    query.select! do |column, search_term|
-      select_values.include? column
-    end unless select_values.empty?
-
     query.each do |column, search_term|
       column = connection.quote_column_name(column)
       search_term = connection.quote normalize(Helper.normalize(search_term))
@@ -32,12 +26,13 @@ module Texticle
 
     rank = connection.quote_column_name('rank' + rand.to_s)
 
-    select("#{quoted_table_name + '.*,' if select_values.empty?} #{similarities.join(" + ")} AS #{rank}").
+    select("#{quoted_table_name + '.*,' if scoped.select_values.empty?} #{similarities.join(" + ")} AS #{rank}").
       where(conditions.join(exclusive ? " AND " : " OR ")).
       order("#{rank} DESC")
   end
 
   def method_missing(method, *search_terms)
+    return super if self == ActiveRecord::Base
     if Helper.dynamic_search_method?(method, self.columns)
       columns = Helper.dynamic_search_columns(method)
       metaclass = class << self; self; end
@@ -54,6 +49,7 @@ module Texticle
   end
 
   def respond_to?(method, include_private = false)
+    return super if self == ActiveRecord::Base
     Helper.dynamic_search_method?(method, self.columns) ? true : super
   end
 
@@ -63,6 +59,10 @@ module Texticle
     query
   end
 
+  def searchable_columns
+    columns.select {|column| column.type == :string }.map(&:name)
+  end
+
   module Helper
     class << self
       def normalize(query)

data/spec/texticle/searchable_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+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"
+      @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"
+    end
+
+    teardown do
+      WebComic.delete_all
+    end
+
+    context "with no paramters" do
+      setup do
+        WebComic.extend(Searchable)
+      end
+
+      should "search across all columns" do
+        assert_equal [@penny], WebComic.search("Penny")
+        assert_equal [@ddeeg], WebComic.search("Dominic")
+      end
+    end
+
+    context "with one column as parameter" do
+      setup do
+        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
+    end
+
+    context "with two columns as parameters" do
+      setup do
+        WebComic.extend(Searchable(:name, :author))
+      end
+
+      should "only search across the given column" do
+        assert_equal [@penny], WebComic.search("Penny")
+        assert_equal [@penny], WebComic.search("Tycho")
+      end
+    end
+  end
+
+end

data/spec/texticle_spec.rb

@@ -12,6 +12,26 @@ end
 
 class TexticleTest < Test::Unit::TestCase
 
+  context "after extending ActiveRecord::Base" do
+    setup do
+      ActiveRecord::Base.extend(Texticle)
+    end
+
+    should "not break #respond_to?" do
+      assert_nothing_raised do
+        ActiveRecord::Base.respond_to? :abstract_class?
+      end
+    end
+
+    should "not break #method_missing" do
+      begin
+        ActiveRecord::Base.random
+      rescue NoMethodError => error
+        assert_match error.message, /undefined method `random'/
+      end
+    end
+  end
+
   context "after extending an ActiveRecord::Base subclass" do
     setup do
       Game.extend(Texticle)
@@ -35,70 +55,64 @@ class TexticleTest < Test::Unit::TestCase
 
     context "when searching with a String argument" do
       should "search across all :string columns if no indexes have been specified" do
-        assert_equal @mario, Game.search("Mario").first
-        assert_equal 1,      Game.search("Mario").count
-
-        assert (Game.search("NES") && [@mario, @zelda]) == [@mario, @zelda]
-        assert_equal 2,      Game.search("NES").count
+        assert_equal [@mario], Game.search("Mario")
+        assert_equal Set.new([@mario, @zelda]), Game.search("NES").to_set
       end
 
       should "work if the query contains an apostrophe" do
-        assert_equal @dkong, Game.search("Diddy's").first
-        assert_equal 1,      Game.search("Diddy's").count
+        assert_equal [@dkong], Game.search("Diddy's")
       end
 
       should "work if the query contains whitespace" do
-        assert_equal @megam, Game.search("Mega Man").first
+        assert_equal [@megam], Game.search("Mega Man")
       end
 
       should "work if the query contains an accent" do
-        assert_equal @takun, Game.search("Tarurūto-kun").first
+        assert_equal [@takun], Game.search("Tarurūto-kun")
       end
 
       should "search across records with NULL values" do
-        assert_equal @megam, Game.search("Mega").first
+        assert_equal [@megam], Game.search("Mega")
       end
 
       should "scope consecutively" do
-        assert_equal @sfgen, Game.search("Genesis").search("Street Fighter").first
+        assert_equal [@sfgen], Game.search("Genesis").search("Street Fighter")
       end
     end
 
     context "when searching with a Hash argument" do
       should "search across the given columns" do
-        assert Game.search(:title => "NES").empty?
-        assert Game.search(:system => "Mario").empty?
-        puts Game.search(:system => "NES", :title => "Sonic").to_a
-        assert Game.search(:system => "NES", :title => "Sonic").empty?
+        assert_empty Game.search(:title => "NES")
+        assert_empty Game.search(:system => "Mario")
+        assert_empty Game.search(:system => "NES", :title => "Sonic")
 
-        assert_equal @mario, Game.search(:title => "Mario").first
-        assert_equal 1,      Game.search(:title => "Mario").count
+        assert_equal [@mario], Game.search(:title => "Mario")
 
-        assert_equal 2,      Game.search(:system => "NES").count
+        assert_equal 2, Game.search(:system => "NES").count
 
-        assert_equal @zelda, Game.search(:system => "NES", :title => "Zelda").first
-        assert_equal @megam, Game.search(:title => "Mega").first
+        assert_equal [@zelda], Game.search(:system => "NES", :title => "Zelda")
+        assert_equal [@megam], Game.search(:title => "Mega")
       end
 
       should "scope consecutively" do
-        assert_equal @sfgen, Game.search(:system => "Genesis").search(:title => "Street Fighter").first
+        assert_equal [@sfgen], Game.search(:system => "Genesis").search(:title => "Street Fighter")
       end
     end
 
     context "when using dynamic search methods" do
       should "generate methods for each :string column" do
-        assert_equal @mario, Game.search_by_title("Mario").first
-        assert_equal @takun, Game.search_by_system("Saturn").first
+        assert_equal [@mario], Game.search_by_title("Mario")
+        assert_equal [@takun], Game.search_by_system("Saturn")
       end
 
       should "generate methods for any combination of :string columns" do
-        assert_equal @mario, Game.search_by_title_and_system("Mario", "NES").first
-        assert_equal @sonic, Game.search_by_system_and_title("Genesis", "Sonic").first
-        assert_equal @mario, Game.search_by_title_and_title("Mario", "Mario").first
+        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")
       end
 
       should "scope consecutively" do
-        assert_equal @sfgen, Game.search_by_system("Genesis").search_by_title("Street Fighter").first
+        assert_equal [@sfgen], Game.search_by_system("Genesis").search_by_title("Street Fighter")
       end
 
       should "not generate methods for non-:string columns" do
@@ -120,11 +134,6 @@ class TexticleTest < Test::Unit::TestCase
     end
 
     context "when searching after selecting columns to return" do
-      should "limit the search to the selected columns" do
-        assert_empty Game.select(:system).search("Mario")
-        assert_equal @mario.title, Game.select(:title).search("Mario").first.title
-      end
-
       should "not fetch extra columns" do
         assert_raise(ActiveModel::MissingAttributeError) do
           Game.select(:title).search("Mario").first.system

metadata

@@ -2,7 +2,7 @@
 name: texticle
 version: !ruby/object:Gem::Version 
   prerelease: 4
-  version: 2.0.pre3
+  version: 2.0.pre4
 platform: ruby
 authors: 
 - ecin
@@ -65,9 +65,11 @@ files:
 - README.rdoc
 - Rakefile
 - lib/texticle.rb
+- lib/texticle/searchable.rb
 - lib/texticle/rails.rb
 - spec/spec_helper.rb
 - spec/texticle_spec.rb
+- spec/texticle/searchable_spec.rb
 - spec/config.yml
 homepage: http://tenderlove.github.com/texticle
 licenses: []