textacular 3.0.0 → 3.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53d7c937b144d66969445fd4dfeca06cf295ef44
+  data.tar.gz: 2c7b41331400ed32398a4e8f21c39c9c46513c30
+SHA512:
+  metadata.gz: 709e443eb8c73f0658b5b76418b08e59a9c1caa23f358b6782910554e44a899693aeb57735dc0180e8b08b92fae77c81cbf4ca2565bfcd537914e47be7633082
+  data.tar.gz: 53351eed3f6f8177aee50c80f2c596722f546d12e2cbbe4e92942c4f27cbbc28147cddd926bbdaf33b32d2be2c95031110474d7c0140aef789711b1ca672b1f7

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+## 3.1.0
+
+* Avoid Deprecation warnings from ActiveRecord 4.0.0.rc2.
+* Fix `method_missing` in ActiveRecord 4.0.0.rc2.
+* Remove unused `Textacular#normalize` method.
+* Add `OR` example to the README.
+* Fix tests for Ruby 2.0.0 & related improvements.
+* Improve Rails integration.
+* Fix dependency loading for textacular rake tasks.
+* Fix ranking failures when rows had `NULL` column values.
+* Clean up Rakefile; should make developing the gem nicer.
+* DEPRECATION: The dynamic search helpers will be removed at the next major
+  release.
+
 ## 3.0.0
 
 * All deprecations have been resolved. This breaks backwards compatibility.

data/README.md

@@ -22,8 +22,9 @@ extending ActiveRecord with scopes making search easy and fun!
 
 In the project's Gemfile add
 
-    gem 'textacular', '~> 3.0', require: 'textacular/rails'
-
+```ruby
+gem 'textacular', '~> 3.0'
+```
 
 #### ActiveRecord outside of Rails
 
@@ -57,7 +58,24 @@ Game.advanced_search(system: '!PS2')
 ```
 
 Finally, the `#fuzzy_search` method lets you use Postgres's trigram search
-funcionality:
+funcionality.
+
+In order to use this, you'll need to make sure your database has the `pg_trgm`
+module installed. On your development machine, you can `require textacular/tasks` and run
+
+```
+rake textacular:install_trigram
+```
+
+Depending on your production environment, you might be able to use the rake
+task, or you might have to manually run a command. For Postgres 9.1 and above,
+you'll want to run
+
+```sql
+CREATE EXTENSION pg_trgm;
+```
+
+Once that's installed, you can use it like this:
 
 ```ruby
 Comic.fuzzy_search(title: 'Questio') # matches Questionable Content
@@ -69,6 +87,13 @@ Searches are also chainable:
 Game.fuzzy_search(title: 'tree').basic_search(system: 'SNES')
 ```
 
+If you want to search on two or more fields with the OR operator use a hash for
+the conditions and pass false as the second parameter:
+
+```ruby
+Game.basic_search({name: 'Mario', nickname: 'Mario'}, false)
+```
+
 
 ### Setting Language
 
@@ -116,6 +141,25 @@ config.active_record.schema_format = :sql
 $ gem install textacular
 ```
 
+## Contributing
+
+Help is gladly welcomed. If you have a feature you'd like to add, it's much more
+likely to get in (or get in faster) the closer you stick to these steps:
+
+1. Open an Issue to talk about it. We can discuss whether it's the right
+  direction or maybe help track down a bug, etc.
+1. Fork the project, and make a branch to work on your feature/fix. Master is
+  where you'll want to start from.
+1. Write a test for the feature you are about to add
+1. Run the tests
+1. Turn the Issue into a Pull Request. There are several ways to do this, but
+  [hub](https://github.com/defunkt/hub) is probably the easiest.
+1. Bonus points if your Pull Request updates `CHANGES.md` to include a summary
+   of your changes and your name like the other entries. If the last entry is
+   the last release, add a new `## Unreleased` heading.
+
+If you don't know how to fix something, even just a Pull Request that includes a
+failing test can be helpful. If in doubt, make an Issue to discuss.
 
 ## LICENSE:
 

data/Rakefile

@@ -1,154 +1,60 @@
-require 'rubygems'
-
-require 'rake'
-require 'yaml'
-require 'pg'
 require 'active_record'
-require 'benchmark'
+require 'rake/testtask'
+require 'pry'
 
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/spec')
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.test_files = FileList[ 'spec/**/*_spec.rb' ]
+end
+task :default => :test
 
-task :default do
-  Rake::Task["db:setup"].invoke
-  Rake::Task["test"].invoke
+file 'spec/config.yml' do |t|
+  sh 'erb spec/config.yml.example > spec/config.yml'
 end
 
-desc "Fire up an interactive terminal to play with"
-task :console do
-  require 'pry'
-  require File.expand_path(File.dirname(__FILE__) + '/lib/textacular')
+desc 'Fire up an interactive terminal to play with'
+task :console => :'db:connect' do
+  Pry.start
+end
 
-  config = YAML.load_file File.expand_path(File.dirname(__FILE__) + '/spec/config.yml')
-  ActiveRecord::Base.establish_connection config.merge(:adapter => :postgresql)
+namespace :db do
 
-  class Character < ActiveRecord::Base
-    belongs_to :web_comic
+  task :connect => 'spec/config.yml' do |t|
+    ActiveRecord::Base.establish_connection \
+      YAML.load_file 'spec/config.yml'
   end
 
-  class WebComic < ActiveRecord::Base
-    has_many :characters
+  task :disconnect do
+    ActiveRecord::Base.clear_all_connections!
   end
 
-  class Game < ActiveRecord::Base
+  desc 'Create the test database'
+  task :create do
+    sh 'createdb textacular'
   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')
+  desc 'Drop the test database'
+  task :drop => :disconnect do
+    sh 'dropdb textacular'
   end
 
-  # start the console! :-)
-  welcome = <<-EOS
-    Welcome to the Textacular 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
+  namespace :migrate do
 
-      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 'textacular_spec'
-  require 'textacular/searchable_spec'
-  require 'textacular/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 textacular`
-
-      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.'
+    desc 'Run the test database migrations'
+    task :up => :'db:connect' do
+      ActiveRecord::Migrator.up 'db/migrate'
     end
-  end
-
-  desc 'Run migrations for test database'
-  task :migrate do
-    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
-        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
+    desc 'Reverse the test database migrations'
+    task :down => :'db:connect' do
+      ActiveRecord::Migrator.down 'db/migrate'
     end
   end
+  task :migrate => :'migrate:up'
 
-  desc 'Drop tables from test database'
-  task :drop do
-    config = YAML.load_file File.expand_path(File.dirname(__FILE__) + '/spec/config.yml')
-    ActiveRecord::Base.establish_connection config.merge(:adapter => :postgresql)
+  desc 'Create and configure the test database'
+  task :setup => [ :create, :migrate ]
 
-    ActiveRecord::Migration.instance_eval do
-      drop_table :games
-      drop_table :web_comics
-      drop_table :characters
-    end
-  end
+  desc 'Drop the test tables and database'
+  task :teardown => [ :'migrate:down', :drop ]
 end

data/lib/textacular.rb

@@ -3,6 +3,9 @@ require 'active_record'
 require 'textacular/version'
 
 module Textacular
+  autoload :FullTextIndexer,         'textacular/full_text_indexer'
+  autoload :PostgresModuleInstaller, 'textacular/postgres_module_installer'
+
   def self.searchable_language
     'english'
   end
@@ -33,8 +36,9 @@ module Textacular
   end
 
   def method_missing(method, *search_terms)
-    return super if self == ActiveRecord::Base
+    return super if self.abstract_class?
     if Helper.dynamic_search_method?(method, self.columns)
+      warn("You are using a dynamic Textacular search method #{method}. These methods are deprecated and will be removed at the next major version release. Please use the has syntax for basic_search and advanced_search.")
       exclusive = Helper.exclusive_dynamic_search_method?(method, self.columns)
       columns = exclusive ? Helper.exclusive_dynamic_search_columns(method) : Helper.inclusive_dynamic_search_columns(method)
       metaclass = class << self; self; end
@@ -53,7 +57,7 @@ module Textacular
   end
 
   def respond_to?(method, include_private = false)
-    return super if self == ActiveRecord::Base
+    return super if self.abstract_class?
     Helper.dynamic_search_method?(method, self.columns) or super
   rescue StandardError
     super
@@ -82,7 +86,7 @@ module Textacular
         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))
+        search_term = connection.quote Helper.normalize(search_term)
 
         results << [table_name, column, search_term]
       end
@@ -101,7 +105,7 @@ module Textacular
   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))"
+    "COALESCE(ts_rank(to_tsvector(#{quoted_language}, #{table_name}.#{column}::text), plainto_tsquery(#{quoted_language}, #{search_term}::text)), 0)"
   end
 
   def basic_condition_string(table_name, column, search_term)
@@ -118,7 +122,7 @@ module Textacular
   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))"
+    "COALESCE(ts_rank(to_tsvector(#{quoted_language}, #{table_name}.#{column}::text), to_tsquery(#{quoted_language}, #{search_term}::text)), 0)"
   end
 
   def advanced_condition_string(table_name, column, search_term)
@@ -143,15 +147,19 @@ module Textacular
   end
 
   def assemble_query(similarities, conditions, exclusive)
-    rank = connection.quote_column_name('rank' + rand.to_s)
+    rank = connection.quote_column_name('rank' + rand(100000000000000000).to_s)
 
-    select("#{quoted_table_name + '.*,' if scoped.select_values.empty?} #{similarities.join(" + ")} AS #{rank}").
+    select("#{quoted_table_name + '.*,' if select_values.empty?} #{similarities.join(" + ")} AS #{rank}").
       where(conditions.join(exclusive ? " AND " : " OR ")).
       order("#{rank} DESC")
   end
 
-  def normalize(query)
-    query
+  def select_values
+    if ActiveRecord::VERSION::MAJOR == 4
+      all.select_values
+    else
+      scoped.select_values
+    end
   end
 
   def searchable_columns
@@ -224,4 +232,4 @@ module Textacular
   end
 end
 
-require File.expand_path(File.dirname(__FILE__) + '/textacular/full_text_indexer')
+require 'textacular/rails' if defined?(::Rails)

data/lib/textacular/full_text_indexer.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 class Textacular::FullTextIndexer
   def generate_migration(model_name)
     stream_output do |io|
@@ -21,6 +23,7 @@ MIGRATION
 
   def stream_output(now = Time.now.utc, &block)
     if !@output_stream && defined?(Rails)
+      FileUtils.mkdir_p(File.dirname(migration_file_name(now)))
       File.open(migration_file_name(now), 'w', &block)
     else
       @output_stream ||= $stdout

data/lib/textacular/rails.rb

@@ -6,5 +6,9 @@ module Textacular
     initializer "textacular.configure_rails_initialization" do
       ActiveRecord::Base.extend(Textacular)
     end
+
+    rake_tasks do
+      load 'textacular/tasks.rb'
+    end
   end
 end

data/lib/textacular/version.rb

@@ -1,5 +1,5 @@
 module Textacular
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 
   def self.version
     VERSION

data/spec/config.yml.example

@@ -1,4 +1,5 @@
 database: textacular
-username: <username>
+username: <%= ENV[ 'USER' ] %>
 pool: 5
 timeout: 5000
+adapter: postgresql

data/spec/fixtures/character.rb

@@ -0,0 +1,6 @@
+class Character < ActiveRecord::Base
+  # string :name
+  # string :description
+  # integer :web_comic_id
+  belongs_to :web_comic
+end

data/spec/fixtures/game.rb

@@ -1,5 +1,3 @@
-require 'active_record'
-
 class Game < ActiveRecord::Base
   # string :system
   # string :title

data/spec/fixtures/webcomic.rb

@@ -1,5 +1,3 @@
-require 'active_record'
-
 class WebComic < ActiveRecord::Base
   # string :name
   # string :author

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
-$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
-
+require 'bundler/setup'
 require 'yaml'
 require 'textacular'
 require 'shoulda'

data/spec/textacular/searchable_spec.rb

@@ -9,6 +9,7 @@ class SearchableTest < Test::Unit::TestCase
         @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"
+        @null  = WebComicWithSearchable.create :author => 'Foo'
       end
 
       teardown do
@@ -19,6 +20,13 @@ class SearchableTest < Test::Unit::TestCase
         assert_equal [@penny], WebComicWithSearchable.advanced_search("Penny")
         assert_equal [@ddeeg], WebComicWithSearchable.advanced_search("Dominic")
       end
+
+      should "still rank with NULL columns" do
+        comic = WebComicWithSearchable.basic_search('Foo').first
+        rank = comic.attributes.find { |key, value| key.to_s =~ /\Arank\d+\z/ }.last
+
+        assert rank
+      end
     end
 
     context "with one column as parameter" do
@@ -47,7 +55,7 @@ class SearchableTest < Test::Unit::TestCase
         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
+            WebComicWithSearchableName.advanced_search(search_term).first
           end
         end
       end
@@ -61,7 +69,7 @@ class SearchableTest < Test::Unit::TestCase
         begin
           WebComicWithSearchableName.searchable_columns
         rescue NoMethodError => error
-          assert_match error.message, /private method/
+          assert_match /private method/, error.message
         end
       end
 
@@ -87,6 +95,9 @@ class SearchableTest < Test::Unit::TestCase
         assert_equal [@penny], WebComicWithSearchableNameAndAuthor.advanced_search("Penny")
         assert_equal [@penny], WebComicWithSearchableNameAndAuthor.advanced_search("Tycho")
       end
+      should "allow includes" do
+        assert_equal [@penny], WebComicWithSearchableNameAndAuthor.includes(:characters).advanced_search("Penny")
+      end
     end
   end
 end

data/spec/textacular_spec.rb

@@ -21,7 +21,7 @@ class TextacularTest < Test::Unit::TestCase
       begin
         ARStandIn.random
       rescue NoMethodError => error
-        assert_match error.message, /undefined method `random'/
+        assert_match /undefined method `random'/, error.message
       end
     end
 
@@ -31,7 +31,7 @@ class TextacularTest < Test::Unit::TestCase
       begin
         NotThere.random
       rescue NoMethodError => error
-        assert_match error.message, /undefined method `random'/
+        assert_match /undefined method `random'/, error.message
       end
     end
 
@@ -187,7 +187,7 @@ class TextacularTest < Test::Unit::TestCase
       end
 
       should "allow for 2 arguments to #respond_to?" do
-        assert GameExtendedWithTextacular.respond_to?(:normalize, true)
+        assert GameExtendedWithTextacular.respond_to?(:searchable_language, true)
       end
     end
 

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: textacular
 version: !ruby/object:Gem::Version
-  version: 3.0.0
-  prerelease: 
+  version: 3.1.0
 platform: ruby
 authors:
 - Ben Hamill
@@ -11,28 +10,25 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-27 00:00:00.000000000 Z
+date: 2013-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -40,7 +36,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,7 +43,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -56,7 +50,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -64,41 +57,36 @@ dependencies:
 - !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: !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: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
     - - <
@@ -107,16 +95,16 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
     - - <
       - !ruby/object:Gem::Version
         version: '4.1'
-description: ! "Textacular exposes full text search capabilities from PostgreSQL,
-  extending\n    ActiveRecord with scopes making search easy and fun!"
+description: |-
+  Textacular exposes full text search capabilities from PostgreSQL, extending
+      ActiveRecord with scopes making search easy and fun!
 email:
 - git-commits@benhamill.com
 - ecin@copypastel.com
@@ -145,27 +133,26 @@ files:
 homepage: http://textacular.github.com/textacular
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Textacular exposes full text search capabilities from PostgreSQL
 test_files:
 - spec/config.yml.example