texticle 2.0.3 → 2.1.0

data/CHANGELOG.rdoc

@@ -1,3 +1,24 @@
+== 2.1.0
+
+* 1 DEPRECATION
+
+  * `search` aliases new `advanced_search` method (same functionality as before), but will
+    alias `basic_search` in 3.0! Should print warnings.
+
+* 3 new features
+
+  * Generate full text search indexes from a rake task (sort of like in 1.x). Supply a specific
+    model name.
+  * New search methods: `basic_search`, `advanced_search` and `fuzzy_search`. Basic allows special
+    characters like &, and % in search terms. Fuzzy is based on Postgres's trigram matching extension
+    pg_trgm. Advanced is the same functionality from `search` previously.
+  * Rake task that installs pg_trgm now works on Postgres 9.1 and up.
+
+* 2 dev improvements
+
+  * Test database configuration not automatically generated from a rake task and ignored by git.
+  * New interactive developer console (powered by pry).
+
 == 2.0.3
 
 * 1 new feature

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.rdoc

@@ -38,6 +38,20 @@ 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')
 
+You can use '|' and '&' for logical conditions.
+
+  Game.search_by_title_or_system('Final Fantasy', 'PS3|Xbox')
+
+=== Setting Language
+
+To set proper searching dictionary just override class method on your model:
+
+  def self.searchable_language
+    'russian'
+  end
+
+And all your queries would go right! And don`t forget to change the migration for indexes, like shown below.
+
 === 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:
@@ -50,6 +64,9 @@ In the above example, the table email_logs has two text columns that we search a
 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.
 
+If you create these indexes, you should also switch to sql for your schema_format in `config/application.rb`:
+
+  config.active_record.schema_format = :sql
 
 == REQUIREMENTS:
 

data/Rakefile

@@ -1,6 +1,7 @@
 require 'rubygems'
 
 require 'rake'
+require 'yaml'
 require 'pg'
 require 'active_record'
 require 'benchmark'
@@ -8,29 +9,115 @@ require 'benchmark'
 $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["db:setup"].invoke
   Rake::Task["test"].invoke
 end
 
+desc "Fire up an interactive terminal to play with"
+task :console do
+  require 'pry'
+  require File.expand_path(File.dirname(__FILE__) + '/lib/texticle')
+
+  config = YAML.load_file File.expand_path(File.dirname(__FILE__) + '/spec/config.yml')
+  ActiveRecord::Base.establish_connection config.merge(:adapter => :postgresql)
+
+  class Character < ActiveRecord::Base
+    belongs_to :web_comic
+  end
+
+  class WebComic < ActiveRecord::Base
+    has_many :characters
+  end
+
+  class Game < ActiveRecord::Base
+  end
+
+  # add ability to reload console
+  def reload
+    reload_msg = '# Reloading the console...'
+    puts CodeRay.scan(reload_msg, :ruby).term
+    Pry.save_history
+    exec('rake console')
+  end
+
+  # start the console! :-)
+  welcome = <<-EOS
+    Welcome to the Texticle devloper console. You have some classes you can play with:
+
+      class Character < ActiveRecord::Base
+        # string :name
+        # string :description
+        # integer :web_comic_id
+
+        belongs_to :web_comic
+      end
+
+      class WebComic < ActiveRecord::Base
+        # string :name
+        # string :author
+        # integer :id
+
+        has_many :characters
+      end
+
+      class Game < ActiveRecord::Base
+        # string :system
+        # string :title
+        # text :description
+      end
+  EOS
+
+  puts CodeRay.scan(welcome, :ruby).term
+  Pry.start
+end
+
 task :test do
   require 'texticle_spec'
   require 'texticle/searchable_spec'
+  require 'texticle/full_text_indexer_spec'
 end
 
 namespace :db do
+  desc 'Create and configure the test database'
+  task :setup do
+    spec_directory = "#{File.expand_path(File.dirname(__FILE__))}/spec"
+
+    STDOUT.puts "Detecting database configuration..."
+
+    if File.exists?("#{spec_directory}/config.yml")
+      STDOUT.puts "Configuration detected. Skipping confguration."
+    else
+      STDOUT.puts "Would you like to create and configure the test database? y/N"
+      continue = STDIN.gets.chomp
+
+      unless continue =~ /^[y]$/i
+        STDOUT.puts "Done."
+        exit 0
+      end
+
+      STDOUT.puts "Creating database..."
+      `createdb texticle`
+
+      STDOUT.puts "Writing configuration file..."
+
+      config_example = File.read("#{spec_directory}/config.yml.example")
+
+      File.open("#{spec_directory}/config.yml", "w") do |config|
+        config << config_example.sub(/<username>/, `whoami`.chomp)
+      end
+
+      STDOUT.puts "Running migrations..."
+      Rake::Task["db:migrate"].invoke
+
+      STDOUT.puts 'Done.'
+    end
+  end
+
   desc 'Run migrations for test database'
   task :migrate do
-    require 'spec_helper'
+    config = YAML.load_file File.expand_path(File.dirname(__FILE__) + '/spec/config.yml')
+    ActiveRecord::Base.establish_connection config.merge(:adapter => :postgresql)
+
     ActiveRecord::Migration.instance_eval do
       create_table :games do |table|
         table.string :system
@@ -38,11 +125,13 @@ namespace :db do
         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
@@ -50,9 +139,12 @@ namespace :db do
       end
     end
   end
+
   desc 'Drop tables from test database'
   task :drop do
-    require 'spec_helper'
+    config = YAML.load_file File.expand_path(File.dirname(__FILE__) + '/spec/config.yml')
+    ActiveRecord::Base.establish_connection config.merge(:adapter => :postgresql)
+
     ActiveRecord::Migration.instance_eval do
       drop_table :games
       drop_table :web_comics

data/lib/texticle.rb

@@ -1,24 +1,36 @@
 require 'active_record'
 
+require 'texticle/version'
+
 module Texticle
-  def search(query = "", exclusive = true)
-    @similarities = []
-    @conditions = []
+  def self.searchable_language
+    'english'
+  end
 
-    unless query.is_a?(Hash)
-      exclusive = false
-      query = searchable_columns.inject({}) do |terms, column|
-        terms.merge column => query.to_s
-      end
-    end
+  def search(query = "", exclusive = true)
+    warn "[DEPRECATION] `search` is deprecated. Please use `advanced_search` instead. At the next major release `search` will become an alias for `basic_search`."
+    advanced_search(query, exclusive)
+  end
 
-    parse_query_hash(query)
+  def basic_search(query = "", exclusive = true)
+    exclusive, query = munge_exclusive_and_query(exclusive, query)
+    parsed_query_hash = parse_query_hash(query)
+    similarities, conditions = basic_similarities_and_conditions(parsed_query_hash)
+    assemble_query(similarities, conditions, exclusive)
+  end
 
-    rank = connection.quote_column_name('rank' + rand.to_s)
+  def advanced_search(query = "", exclusive = true)
+    exclusive, query = munge_exclusive_and_query(exclusive, query)
+    parsed_query_hash = parse_query_hash(query)
+    similarities, conditions = advanced_similarities_and_conditions(parsed_query_hash)
+    assemble_query(similarities, conditions, exclusive)
+  end
 
-    select("#{quoted_table_name + '.*,' if scoped.select_values.empty?} #{@similarities.join(" + ")} AS #{rank}").
-      where(@conditions.join(exclusive ? " AND " : " OR ")).
-      order("#{rank} DESC")
+  def fuzzy_search(query = '', exclusive = true)
+    exclusive, query = munge_exclusive_and_query(exclusive, query)
+    parsed_query_hash = parse_query_hash(query)
+    similarities, conditions = fuzzy_similarities_and_conditions(parsed_query_hash)
+    assemble_query(similarities, conditions, exclusive)
   end
 
   def method_missing(method, *search_terms)
@@ -31,7 +43,7 @@ module Texticle
         query = columns.inject({}) do |query, column|
           query.merge column => args.shift
         end
-        search(query, exclusive)
+        self.send(Helper.search_type(method), query, exclusive)
       end
       __send__(method, *search_terms, exclusive)
     else
@@ -50,20 +62,93 @@ module Texticle
 
   private
 
+  def munge_exclusive_and_query(exclusive, query)
+    unless query.is_a?(Hash)
+      exclusive = false
+      query = searchable_columns.inject({}) do |terms, column|
+        terms.merge column => query.to_s
+      end
+    end
+
+    [exclusive, query]
+  end
+
   def parse_query_hash(query, table_name = quoted_table_name)
-    language = connection.quote(searchable_language)
     table_name = connection.quote_table_name(table_name)
 
+    results = []
+
     query.each do |column_or_table, search_term|
       if search_term.is_a?(Hash)
-        parse_query_hash(search_term, column_or_table)
+        results += 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)"
+
+        results << [table_name, column, search_term]
       end
     end
+
+    results
+  end
+
+  def basic_similarities_and_conditions(parsed_query_hash)
+    parsed_query_hash.inject([[], []]) do |(similarities, conditions), query_args|
+      similarities << basic_similarity_string(*query_args)
+      conditions << basic_condition_string(*query_args)
+
+      [similarities, conditions]
+    end
+  end
+
+  def basic_similarity_string(table_name, column, search_term)
+    "ts_rank(to_tsvector(#{quoted_language}, #{table_name}.#{column}::text), plainto_tsquery(#{quoted_language}, #{search_term}::text))"
+  end
+
+  def basic_condition_string(table_name, column, search_term)
+    "to_tsvector(#{quoted_language}, #{table_name}.#{column}::text) @@ plainto_tsquery(#{quoted_language}, #{search_term}::text)"
+  end
+
+  def advanced_similarities_and_conditions(parsed_query_hash)
+    parsed_query_hash.inject([[], []]) do |(similarities, conditions), query_args|
+      similarities << advanced_similarity_string(*query_args)
+      conditions << advanced_condition_string(*query_args)
+
+      [similarities, conditions]
+    end
+  end
+
+  def advanced_similarity_string(table_name, column, search_term)
+    "ts_rank(to_tsvector(#{quoted_language}, #{table_name}.#{column}::text), to_tsquery(#{quoted_language}, #{search_term}::text))"
+  end
+
+  def advanced_condition_string(table_name, column, search_term)
+    "to_tsvector(#{quoted_language}, #{table_name}.#{column}::text) @@ to_tsquery(#{quoted_language}, #{search_term}::text)"
+  end
+
+  def fuzzy_similarities_and_conditions(parsed_query_hash)
+    parsed_query_hash.inject([[], []]) do |(similarities, conditions), query_args|
+      similarities << fuzzy_similarity_string(*query_args)
+      conditions << fuzzy_condition_string(*query_args)
+
+      [similarities, conditions]
+    end
+  end
+
+  def fuzzy_similarity_string(table_name, column, search_term)
+    "similarity(#{table_name}.#{column}, #{search_term})"
+  end
+
+  def fuzzy_condition_string(table_name, column, search_term)
+    "(#{table_name}.#{column} % #{search_term})"
+  end
+
+  def assemble_query(similarities, conditions, exclusive)
+    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 ")).
+      order("#{rank} DESC")
   end
 
   def normalize(query)
@@ -74,8 +159,12 @@ module Texticle
     columns.select {|column| [:string, :text].include? column.type }.map(&:name)
   end
 
+  def quoted_language
+    @quoted_language ||= connection.quote(searchable_language)
+  end
+
   def searchable_language
-    'english'
+    Texticle.searchable_language
   end
 
   module Helper
@@ -84,8 +173,16 @@ module Texticle
         query.to_s.gsub(' ', '\\\\ ')
       end
 
+      def method_name_regex
+        /^(?<search_type>((basic|advanced|fuzzy)_)?search)_by_(?<columns>[_a-zA-Z]\w*)$/
+      end
+
+      def search_type(method)
+        method.to_s.match(method_name_regex)[:search_type]
+      end
+
       def exclusive_dynamic_search_columns(method)
-        if match = method.to_s.match(/^search_by_(?<columns>[_a-zA-Z]\w*)$/)
+        if match = method.to_s.match(method_name_regex)
           match[:columns].split('_and_')
         else
           []
@@ -93,7 +190,7 @@ module Texticle
       end
 
       def inclusive_dynamic_search_columns(method)
-        if match = method.to_s.match(/^search_by_(?<columns>[_a-zA-Z]\w*)$/)
+        if match = method.to_s.match(method_name_regex)
           match[:columns].split('_or_')
         else
           []
@@ -127,3 +224,5 @@ module Texticle
     end
   end
 end
+
+require File.expand_path(File.dirname(__FILE__) + '/texticle/full_text_indexer')

data/lib/texticle/full_text_indexer.rb

@@ -0,0 +1,79 @@
+class Texticle::FullTextIndexer
+  def generate_migration(model_name)
+    stream_output do |io|
+      io.puts(<<-MIGRATION)
+class #{model_name}FullTextSearch < ActiveRecord::Migration
+  def self.up
+    execute(<<-SQL.strip)
+      #{up_migration(model_name)}
+    SQL
+  end
+
+  def self.down
+    execute(<<-SQL.strip)
+      #{down_migration(model_name)}
+    SQL
+  end
+end
+MIGRATION
+    end
+  end
+
+  def stream_output(now = Time.now.utc, &block)
+    if !@output_stream && defined?(Rails)
+      File.open(migration_file_name(now), 'w', &block)
+    else
+      @output_stream ||= $stdout
+
+      yield @output_stream
+    end
+  end
+
+  private
+
+  def migration_file_name(now = Time.now.utc)
+    File.join(Rails.root, 'db', 'migrate',"#{now.strftime('%Y%m%d%H%M%S')}_full_text_search.rb")
+  end
+
+  def up_migration(model_name)
+    migration_with_type(model_name, :up)
+  end
+
+  def down_migration(model_name)
+    migration_with_type(model_name, :down)
+  end
+
+  def migration_with_type(model_name, type)
+    sql_lines = ''
+
+    model = Kernel.const_get(model_name)
+    model.indexable_columns.each do |column|
+      sql_lines << drop_index_sql_for(model, column)
+      sql_lines << create_index_sql_for(model, column) if type == :up
+    end
+
+    sql_lines.strip.gsub("\n","\n      ")
+  end
+
+  def drop_index_sql_for(model, column)
+    "DROP index IF EXISTS #{index_name_for(model, column)};\n"
+  end
+
+  def create_index_sql_for(model, column)
+    # The spacing gets sort of wonky in here.
+
+    <<-SQL
+CREATE index #{index_name_for(model, column)}
+  ON #{model.table_name}
+  USING gin(to_tsvector("#{dictionary}", "#{model.table_name}"."#{column}"::text));
+SQL
+  end
+
+  def index_name_for(model, column)
+    "#{model.table_name}_#{column}_fts_idx"
+  end
+
+  def dictionary
+    Texticle.searchable_language
+  end
+end

data/lib/texticle/postgres_module_installer.rb

@@ -0,0 +1,57 @@
+module Texticle
+  class PostgresModuleInstaller
+    def install_module(module_name)
+      major, minor, patch = postgres_version.split('.')
+
+      if major.to_i >= 9 && minor.to_i >= 1
+        install_postgres_91_module(module_name)
+      else
+        install_postgres_90_module(module_name)
+      end
+    end
+
+    def db_name
+      @db_name ||= ActiveRecord::Base.connection.current_database
+    end
+
+    private
+
+    def postgres_version
+      @postgres_version ||= ask_pg_config('version').match(/PostgreSQL ([0-9]+(\.[0-9]+)*)/)[1]
+    end
+
+    def postgres_share_dir
+      @share_dir ||= ask_pg_config('sharedir')
+    end
+
+    def ask_pg_config(argument)
+      result = `pg_config --#{argument}`.chomp
+
+      raise RuntimeError, "Cannot find Postgres's #{argument}." unless $?.success?
+
+      result
+    end
+
+    def install_postgres_90_module(module_name)
+      module_location = "#{postgres_share_dir}/contrib/#{module_name}.sql"
+
+      unless system("ls #{module_location}")
+        raise RuntimeError, "Cannot find the #{module_name} module. Was it compiled and installed?"
+      end
+
+      unless system("psql -d #{db_name} -f #{module_location}")
+        raise RuntimeError, "`psql -d #{db_name} -f #{module_location}` cannot complete successfully."
+      end
+    end
+
+    def install_postgres_91_module(module_name)
+      module_location = "#{postgres_share_dir}/extension/#{module_name}.control"
+
+      unless system("ls #{module_location}")
+        raise RuntimeError, "Cannot find the #{module_name} module. Was it compiled and installed?"
+      end
+
+      ActiveRecord::Base.connection.execute("CREATE EXTENSION #{module_name};")
+    end
+  end
+end

data/lib/texticle/searchable.rb

@@ -10,6 +10,10 @@ def Searchable(*searchable_columns)
     end
 
     private :searchable_columns
+
+    def indexable_columns
+      searchable_columns.to_enum
+    end
   end
 end
 

data/lib/texticle/tasks.rb

@@ -0,0 +1,18 @@
+require 'rake'
+require 'texticle'
+
+namespace :texticle do
+  desc 'Create full text search index migration, give the model for which you want to create the indexes'
+  task :create_index_migration, [:model_name] => :environment do |task, args|
+    raise 'A model name is required' unless args[:model_name]
+    Texticle::FullTextIndexer.new.generate_migration(args[:model_name])
+  end
+
+  desc "Install trigram text search module"
+  task :install_trigram => [:environment] do
+    installer = Texticle::PostgresModuleInstaller.new
+    installer.install_module('pg_trgm')
+
+    puts "Trigram text search module successfully installed into '#{installer.db_name}' database."
+  end
+end

data/spec/{config.yml → config.yml.example}

@@ -1,4 +1,4 @@
 database: texticle
-username: ncrespo
+username: <username>
 pool: 5
 timeout: 5000

data/spec/fixtures/game.rb

@@ -0,0 +1,9 @@
+require 'active_record'
+
+class Game < ActiveRecord::Base
+  # string :system
+  # string :title
+  # text :description
+end
+
+class GameFail < Game; end

data/spec/fixtures/webcomic.rb

@@ -0,0 +1,9 @@
+require 'active_record'
+
+class WebComic < ActiveRecord::Base
+  # string :name
+  # string :author
+  # integer :id
+
+  has_many :characters
+end

data/spec/spec_helper.rb

@@ -3,7 +3,76 @@ $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
 require 'yaml'
 require 'texticle'
 require 'shoulda'
-require 'ruby-debug'
+require 'pry'
+require 'active_record'
+require 'texticle'
+require 'texticle/searchable'
 
 config = YAML.load_file File.expand_path(File.dirname(__FILE__) + '/config.yml')
 ActiveRecord::Base.establish_connection config.merge(:adapter => :postgresql)
+
+class ARStandIn < ActiveRecord::Base;
+  self.abstract_class = true
+  extend Texticle
+end
+
+class NotThere < ARStandIn; end
+
+class TexticleWebComic < ARStandIn;
+  has_many :characters, :foreign_key => :web_comic_id
+  self.table_name = :web_comics
+end
+
+
+class WebComic < ActiveRecord::Base
+  # string :name
+  # string :author
+  # integer :id
+
+  has_many :characters
+end
+
+class WebComicWithSearchable < WebComic
+  extend Searchable
+end
+
+class WebComicWithSearchableName < WebComic
+  extend Searchable(:name)
+end
+
+class WebComicWithSearchableNameAndAuthor < WebComic
+  extend Searchable(:name, :author)
+end
+
+
+class Character < ActiveRecord::Base
+  # string :name
+  # string :description
+  # integer :web_comic_id
+
+  belongs_to :web_comic
+end
+
+
+class Game < ActiveRecord::Base
+  # string :system
+  # string :title
+  # text :description
+end
+
+class GameExtendedWithTexticle < Game
+  extend Texticle
+end
+
+class GameExtendedWithTexticleAndCustomLanguage < GameExtendedWithTexticle
+  def searchable_language
+    'spanish'
+  end
+end
+
+
+class GameFail < Game; end
+
+class GameFailExtendedWithTexticle < GameFail
+  extend Texticle
+end

data/spec/texticle/searchable_spec.rb

@@ -1,60 +1,91 @@
 require 'spec_helper'
-require 'fixtures/webcomic'
 require 'texticle/searchable'
 
 class SearchableTest < Test::Unit::TestCase
   context "when extending an ActiveRecord::Base subclass" do
-    setup do
-      @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"
-    end
-
-    teardown do
-      WebComic.delete_all
-      #Object.send(:remove_const, :WebComic) if defined?(WebComic)
-    end
-
     context "with no parameters" do
       setup do
-        WebComic.extend Searchable
+        @qcont = WebComicWithSearchable.create :name => "Questionable Content", :author => "Jeph Jaques"
+        @jhony = WebComicWithSearchable.create :name => "Johnny Wander", :author => "Ananth & Yuko"
+        @ddeeg = WebComicWithSearchable.create :name => "Dominic Deegan", :author => "Mookie"
+        @penny = WebComicWithSearchable.create :name => "Penny Arcade", :author => "Tycho & Gabe"
+      end
+
+      teardown do
+        WebComicWithSearchable.delete_all
       end
 
       should "search across all columns" do
-        assert_equal [@penny], WebComic.search("Penny")
-        assert_equal [@ddeeg], WebComic.search("Dominic")
+        assert_equal [@penny], WebComicWithSearchable.advanced_search("Penny")
+        assert_equal [@ddeeg], WebComicWithSearchable.advanced_search("Dominic")
       end
     end
 
     context "with one column as parameter" do
       setup do
-        WebComic.extend Searchable(:name)
+        @qcont = WebComicWithSearchableName.create :name => "Questionable Content", :author => "Jeph Jaques"
+        @jhony = WebComicWithSearchableName.create :name => "Johnny Wander", :author => "Ananth & Yuko"
+        @ddeeg = WebComicWithSearchableName.create :name => "Dominic Deegan", :author => "Mookie"
+        @penny = WebComicWithSearchableName.create :name => "Penny Arcade", :author => "Tycho & Gabe"
+      end
+
+      teardown do
+        WebComicWithSearchableName.delete_all
       end
 
       should "only search across the given column" do
-        assert_equal [@penny], WebComic.search("Penny")
-        assert_empty WebComic.search("Tycho")
+        assert_equal [@penny], WebComicWithSearchableName.advanced_search("Penny")
+        assert_empty WebComicWithSearchableName.advanced_search("Tycho")
+      end
+
+      ["hello \\", "tebow!" , "food &"].each do |search_term|
+        should "be fine with searching for crazy character #{search_term} with plain search" do
+          # Uses plainto_tsquery
+          assert_equal [], WebComicWithSearchableName.basic_search(search_term)
+        end
+
+        should "be not fine with searching for crazy character #{search_term} with advanced search" do
+          # Uses to_tsquery
+          assert_raise(ActiveRecord::StatementInvalid) do
+            WebComicWithSearchableName.advanced_search(search_term).all
+          end
+        end
+      end
+
+      should "fuzzy search stuff" do
+        assert_equal [@qcont], WebComicWithSearchableName.fuzzy_search('Questio')
       end
 
       should "define :searchable_columns as private" do
-        assert_raise(NoMethodError) { WebComic.searchable_columns }
+        assert_raise(NoMethodError) { WebComicWithSearchableName.searchable_columns }
         begin
-          WebComic.searchable_columns
+          WebComicWithSearchableName.searchable_columns
         rescue NoMethodError => error
           assert_match error.message, /private method/
         end
       end
+
+      should "define #indexable_columns which returns a write-proof Enumerable" do
+        assert_equal(Enumerator, WebComicWithSearchableName.indexable_columns.class)
+        assert_raise(NoMethodError) { WebComicWithSearchableName.indexable_columns[0] = 'foo' }
+      end
     end
 
     context "with two columns as parameters" do
       setup do
-        WebComic.extend Searchable(:name, :author)
+        @qcont = WebComicWithSearchableNameAndAuthor.create :name => "Questionable Content", :author => "Jeph Jaques"
+        @jhony = WebComicWithSearchableNameAndAuthor.create :name => "Johnny Wander", :author => "Ananth & Yuko"
+        @ddeeg = WebComicWithSearchableNameAndAuthor.create :name => "Dominic Deegan", :author => "Mookie"
+        @penny = WebComicWithSearchableNameAndAuthor.create :name => "Penny Arcade", :author => "Tycho & Gabe"
+      end
+
+      teardown do
+        WebComicWithSearchableNameAndAuthor.delete_all
       end
 
       should "only search across the given column" do
-        assert_equal [@penny], WebComic.search("Penny")
-        assert_equal [@penny], WebComic.search("Tycho")
+        assert_equal [@penny], WebComicWithSearchableNameAndAuthor.advanced_search("Penny")
+        assert_equal [@penny], WebComicWithSearchableNameAndAuthor.advanced_search("Tycho")
       end
     end
   end

data/spec/texticle_spec.rb

@@ -1,18 +1,11 @@
 # coding: utf-8
 require 'spec_helper'
-require 'fixtures/webcomic'
-require 'fixtures/character'
-require 'fixtures/game'
 
 class TexticleTest < Test::Unit::TestCase
   context "after extending ActiveRecord::Base" do
-    # before(:all)
-    ActiveRecord::Base.extend(Texticle)
-    class NotThere < ActiveRecord::Base; end
-
     should "not break #respond_to?" do
       assert_nothing_raised do
-        ActiveRecord::Base.respond_to? :abstract_class?
+        ARStandIn.respond_to? :abstract_class?
       end
     end
 
@@ -24,9 +17,9 @@ class TexticleTest < Test::Unit::TestCase
     end
 
     should "not break #method_missing" do
-      assert_raise(NoMethodError) { ActiveRecord::Base.random }
+      assert_raise(NoMethodError) { ARStandIn.random }
       begin
-        ActiveRecord::Base.random
+        ARStandIn.random
       rescue NoMethodError => error
         assert_match error.message, /undefined method `random'/
       end
@@ -44,9 +37,9 @@ class TexticleTest < Test::Unit::TestCase
 
     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"
+        @qc = TexticleWebComic.create :name => "Questionable Content", :author => "Jeph Jaques"
+        @jw = TexticleWebComic.create :name => "Johnny Wander", :author => "Ananth & Yuko"
+        @pa = TexticleWebComic.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'
@@ -63,169 +56,161 @@ class TexticleTest < Test::Unit::TestCase
       end
 
       teardown do
-        WebComic.delete_all
+        TexticleWebComic.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
+        assert_equal [@jw], TexticleWebComic.joins(:characters).advanced_search(:characters => {:description => 'tall'})
+        assert_equal [@pa, @jw, @qc].sort, TexticleWebComic.joins(:characters).advanced_search(:characters => {:description => 'anger'}).sort
+        assert_equal [@pa, @qc].sort, TexticleWebComic.joins(:characters).advanced_search(:characters => {:description => 'crude'}).sort
       end
     end
   end
 
   context "after extending an ActiveRecord::Base subclass" do
-    # before(:all)
-    class ::GameFail < Game; end
-
     setup do
-      @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 => "カッコイイ！"
+      @zelda = GameExtendedWithTexticle.create :system => "NES",     :title => "Legend of Zelda",    :description => "A Link to the Past."
+      @mario = GameExtendedWithTexticle.create :system => "NES",     :title => "Super Mario Bros.",  :description => "The original platformer."
+      @sonic = GameExtendedWithTexticle.create :system => "Genesis", :title => "Sonic the Hedgehog", :description => "Spiky."
+      @dkong = GameExtendedWithTexticle.create :system => "SNES",    :title => "Diddy's Kong Quest", :description => "Donkey Kong Country 2"
+      @megam = GameExtendedWithTexticle.create :system => nil,       :title => "Mega Man",           :description => "Beware Dr. Brain"
+      @sfnes = GameExtendedWithTexticle.create :system => "SNES",    :title => "Street Fighter 2",   :description => "Yoga Flame!"
+      @sfgen = GameExtendedWithTexticle.create :system => "Genesis", :title => "Street Fighter 2",   :description => "Yoga Flame!"
+      @takun = GameExtendedWithTexticle.create :system => "Saturn",  :title => "Magical Tarurūto-kun", :description => "カッコイイ！"
     end
 
     teardown do
-      Game.delete_all
+      GameExtendedWithTexticle.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
+      GameFailExtendedWithTexticle.establish_connection({:adapter => :postgresql, :database =>'unavailable', :username=>'bad', :pool=>5, :timeout=>5000}) rescue nil
 
       assert_nothing_raised do
-        GameFail.respond_to?(:search)
+        GameFailExtendedWithTexticle.respond_to?(:advanced_search)
       end
-
     end
 
     should "define a #search method" do
-      assert Game.respond_to?(:search)
+      assert GameExtendedWithTexticle.respond_to?(:search)
     end
 
     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")
-        assert_equal Set.new([@mario, @zelda]), Game.search("NES").to_set
+        assert_equal [@mario], GameExtendedWithTexticle.advanced_search("Mario")
+        assert_equal Set.new([@mario, @zelda]), GameExtendedWithTexticle.advanced_search("NES").to_set
       end
 
       should "work if the query contains an apostrophe" do
-        assert_equal [@dkong], Game.search("Diddy's")
+        assert_equal [@dkong], GameExtendedWithTexticle.advanced_search("Diddy's")
       end
 
       should "work if the query contains whitespace" do
-        assert_equal [@megam], Game.search("Mega Man")
+        assert_equal [@megam], GameExtendedWithTexticle.advanced_search("Mega Man")
       end
 
       should "work if the query contains an accent" do
-        assert_equal [@takun], Game.search("Tarurūto-kun")
+        assert_equal [@takun], GameExtendedWithTexticle.advanced_search("Tarurūto-kun")
       end
 
       should "search across records with NULL values" do
-        assert_equal [@megam], Game.search("Mega")
+        assert_equal [@megam], GameExtendedWithTexticle.advanced_search("Mega")
       end
 
       should "scope consecutively" do
-        assert_equal [@sfgen], Game.search("Genesis").search("Street Fighter")
+        assert_equal [@sfgen], GameExtendedWithTexticle.advanced_search("Genesis").advanced_search("Street Fighter")
       end
     end
 
     context "when searching with a Hash argument" do
       should "search across the given columns" do
-        assert_empty Game.search(:title => "NES")
-        assert_empty Game.search(:system => "Mario")
-        assert_empty Game.search(:system => "NES", :title => "Sonic")
+        assert_empty GameExtendedWithTexticle.advanced_search(:title => "NES")
+        assert_empty GameExtendedWithTexticle.advanced_search(:system => "Mario")
+        assert_empty GameExtendedWithTexticle.advanced_search(:system => "NES", :title => "Sonic")
 
-        assert_equal [@mario], Game.search(:title => "Mario")
+        assert_equal [@mario], GameExtendedWithTexticle.advanced_search(:title => "Mario")
 
-        assert_equal 2, Game.search(:system => "NES").count
+        assert_equal 2, GameExtendedWithTexticle.advanced_search(:system => "NES").count
 
-        assert_equal [@zelda], Game.search(:system => "NES", :title => "Zelda")
-        assert_equal [@megam], Game.search(:title => "Mega")
+        assert_equal [@zelda], GameExtendedWithTexticle.advanced_search(:system => "NES", :title => "Zelda")
+        assert_equal [@megam], GameExtendedWithTexticle.advanced_search(:title => "Mega")
       end
 
       should "scope consecutively" do
-        assert_equal [@sfgen], Game.search(:system => "Genesis").search(:title => "Street Fighter")
+        assert_equal [@sfgen], GameExtendedWithTexticle.advanced_search(:system => "Genesis").advanced_search(:title => "Street Fighter")
       end
 
       should "cast non-:string columns as text" do
-        assert_equal [@mario], Game.search(:id => @mario.id)
+        assert_equal [@mario], GameExtendedWithTexticle.advanced_search(:id => @mario.id)
       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")
-        assert_equal [@takun], Game.search_by_system("Saturn")
+        assert_equal [@mario], GameExtendedWithTexticle.advanced_search_by_title("Mario")
+        assert_equal [@takun], GameExtendedWithTexticle.advanced_search_by_system("Saturn")
       end
 
       should "generate methods for each :text column" do
-        assert_equal [@mario], Game.search_by_description("platform")
+        assert_equal [@mario], GameExtendedWithTexticle.advanced_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")
+        assert_equal [@mario], GameExtendedWithTexticle.advanced_search_by_title_and_system("Mario", "NES")
+        assert_equal [@sonic], GameExtendedWithTexticle.advanced_search_by_system_and_title("Genesis", "Sonic")
+        assert_equal [@mario], GameExtendedWithTexticle.advanced_search_by_title_and_title("Mario", "Mario")
+        assert_equal [@megam], GameExtendedWithTexticle.advanced_search_by_title_and_description("Man", "Brain")
       end
 
       should "generate methods for inclusive searches" do
-        assert_equal Set.new([@megam, @takun]), Game.search_by_system_or_title("Saturn", "Mega Man").to_set
+        assert_equal Set.new([@megam, @takun]), GameExtendedWithTexticle.advanced_search_by_system_or_title("Saturn", "Mega Man").to_set
       end
 
       should "scope consecutively" do
-        assert_equal [@sfgen], Game.search_by_system("Genesis").search_by_title("Street Fighter")
+        assert_equal [@sfgen], GameExtendedWithTexticle.advanced_search_by_system("Genesis").advanced_search_by_title("Street Fighter")
       end
 
       should "generate methods for non-:string columns" do
-        assert_equal [@mario], Game.search_by_id(@mario.id)
+        assert_equal [@mario], GameExtendedWithTexticle.advanced_search_by_id(@mario.id)
       end
 
       should "work with #respond_to?" do
-        assert Game.respond_to?(:search_by_system)
-        assert Game.respond_to?(:search_by_title)
-        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 GameExtendedWithTexticle.respond_to?(:advanced_search_by_system)
+        assert GameExtendedWithTexticle.respond_to?(:advanced_search_by_title)
+        assert GameExtendedWithTexticle.respond_to?(:advanced_search_by_system_and_title)
+        assert GameExtendedWithTexticle.respond_to?(:advanced_search_by_system_or_title)
+        assert GameExtendedWithTexticle.respond_to?(:advanced_search_by_title_and_title_and_title)
+        assert GameExtendedWithTexticle.respond_to?(:advanced_search_by_id)
 
-        assert !Game.respond_to?(:search_by_title_and_title_or_title)
+        assert !GameExtendedWithTexticle.respond_to?(:advanced_search_by_title_and_title_or_title)
       end
 
       should "allow for 2 arguments to #respond_to?" do
-        assert Game.respond_to?(:normalize, true)
+        assert GameExtendedWithTexticle.respond_to?(:normalize, true)
       end
     end
 
     context "when searching after selecting columns to return" do
       should "not fetch extra columns" do
         assert_raise(ActiveModel::MissingAttributeError) do
-          Game.select(:title).search("Mario").first.system
+          GameExtendedWithTexticle.select(:title).advanced_search("Mario").first.system
         end
       end
     end
-  end
-
-  context "when setting a custom search language" do
-    def Game.searchable_language
-      'spanish'
-    end
 
-    setup do
-      Game.create :system => "PS3", :title => "Harry Potter & the Deathly Hallows"
-    end
+    context "when setting a custom search language" do
+      setup do
+        GameExtendedWithTexticleAndCustomLanguage.create :system => "PS3", :title => "Harry Potter & the Deathly Hallows"
+      end
 
-    teardown do
-      Game.delete_all
-    end
+      teardown do
+        GameExtendedWithTexticleAndCustomLanguage.delete_all
+      end
 
-    should "still find results" do
-      assert_not_empty Game.search_by_title("harry")
+      should "still find results" do
+        assert_not_empty GameExtendedWithTexticleAndCustomLanguage.advanced_search_by_title("harry")
+      end
     end
   end
 end

metadata

@@ -1,20 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: texticle
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
+- Ben Hamill
 - ecin
 - Aaron Patterson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-30 00:00:00.000000000 Z
+date: 2013-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &70337748621180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +23,15 @@ dependencies:
         version: 0.11.0
   type: :development
   prerelease: false
-  version_requirements: *70337748621180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70337748620400 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,32 +39,63 @@ dependencies:
         version: 2.11.3
   type: :development
   prerelease: false
-  version_requirements: *70337748620400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.3
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70337748619540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *70337748619540
-- !ruby/object:Gem::Dependency
-  name: ruby-debug19
-  requirement: &70337748618760 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.11.6
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70337748618760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70337748617780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +103,16 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70337748617780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: ! "Texticle exposes full text search capabilities from PostgreSQL, extending\n
   \   ActiveRecord with scopes making search easy and fun!"
 email:
+- git-commits@benhamill.com
 - ecin@copypastel.com
 executables: []
 extensions: []
@@ -79,18 +122,26 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - CHANGELOG.rdoc
+- Gemfile
 - Manifest.txt
 - README.rdoc
 - Rakefile
 - lib/texticle.rb
-- lib/texticle/searchable.rb
+- lib/texticle/full_text_indexer.rb
 - lib/texticle/rails.rb
+- lib/texticle/searchable.rb
+- lib/texticle/tasks.rb
+- lib/texticle/postgres_module_installer.rb
+- spec/config.yml.example
+- spec/fixtures/character.rb
+- spec/fixtures/game.rb
+- spec/fixtures/webcomic.rb
 - spec/spec_helper.rb
-- spec/texticle_spec.rb
 - spec/texticle/searchable_spec.rb
-- spec/config.yml
-homepage: http://tenderlove.github.com/texticle
-licenses: []
+- spec/texticle_spec.rb
+homepage: http://texticle.github.com/texticle
+licenses:
+- MIT
 post_install_message: 
 rdoc_options:
 - --main
@@ -110,12 +161,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: texticle
-rubygems_version: 1.8.10
+rubyforge_project: 
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Texticle exposes full text search capabilities from PostgreSQL
 test_files:
+- spec/config.yml.example
+- spec/fixtures/character.rb
+- spec/fixtures/game.rb
+- spec/fixtures/webcomic.rb
 - spec/spec_helper.rb
+- spec/texticle/searchable_spec.rb
 - spec/texticle_spec.rb
-- spec/config.yml
+has_rdoc: