textacular 3.0.0

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'yaml'
+require 'textacular'
+require 'shoulda'
+require 'pry'
+require 'active_record'
+require 'textacular'
+require 'textacular/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 Textacular
+end
+
+class NotThere < ARStandIn; end
+
+class TextacularWebComic < 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 GameExtendedWithTextacular < Game
+  extend Textacular
+end
+
+class GameExtendedWithTextacularAndCustomLanguage < GameExtendedWithTextacular
+  def searchable_language
+    'spanish'
+  end
+end
+
+
+class GameFail < Game; end
+
+class GameFailExtendedWithTextacular < GameFail
+  extend Textacular
+end

data/spec/textacular/searchable_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+require 'textacular/searchable'
+
+class SearchableTest < Test::Unit::TestCase
+  context "when extending an ActiveRecord::Base subclass" do
+    context "with no parameters" do
+      setup do
+        @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], WebComicWithSearchable.advanced_search("Penny")
+        assert_equal [@ddeeg], WebComicWithSearchable.advanced_search("Dominic")
+      end
+    end
+
+    context "with one column as parameter" do
+      setup do
+        @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], 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) { WebComicWithSearchableName.searchable_columns }
+        begin
+          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
+        @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], WebComicWithSearchableNameAndAuthor.advanced_search("Penny")
+        assert_equal [@penny], WebComicWithSearchableNameAndAuthor.advanced_search("Tycho")
+      end
+    end
+  end
+end

data/spec/textacular_spec.rb

@@ -0,0 +1,216 @@
+# coding: utf-8
+require 'spec_helper'
+
+class TextacularTest < Test::Unit::TestCase
+  context "after extending ActiveRecord::Base" do
+    should "not break #respond_to?" do
+      assert_nothing_raised do
+        ARStandIn.respond_to? :abstract_class?
+      end
+    end
+
+    should "not break #respond_to? for table-less classes" do
+      assert !NotThere.table_exists?
+      assert_nothing_raised do
+        NotThere.respond_to? :system
+      end
+    end
+
+    should "not break #method_missing" do
+      assert_raise(NoMethodError) { ARStandIn.random }
+      begin
+        ARStandIn.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 = TextacularWebComic.create :name => "Questionable Content", :author => "Jeph Jaques"
+        @jw = TextacularWebComic.create :name => "Johnny Wander", :author => "Ananth & Yuko"
+        @pa = TextacularWebComic.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
+        TextacularWebComic.delete_all
+        Character.delete_all
+      end
+
+      should "look in the related model with nested searching syntax" do
+        assert_equal [@jw], TextacularWebComic.joins(:characters).advanced_search(:characters => {:description => 'tall'})
+        assert_equal [@pa, @jw, @qc].sort, TextacularWebComic.joins(:characters).advanced_search(:characters => {:description => 'anger'}).sort
+        assert_equal [@pa, @qc].sort, TextacularWebComic.joins(:characters).advanced_search(:characters => {:description => 'crude'}).sort
+      end
+    end
+  end
+
+  context "after extending an ActiveRecord::Base subclass" do
+    setup do
+      @zelda = GameExtendedWithTextacular.create :system => "NES",     :title => "Legend of Zelda",    :description => "A Link to the Past."
+      @mario = GameExtendedWithTextacular.create :system => "NES",     :title => "Super Mario Bros.",  :description => "The original platformer."
+      @sonic = GameExtendedWithTextacular.create :system => "Genesis", :title => "Sonic the Hedgehog", :description => "Spiky."
+      @dkong = GameExtendedWithTextacular.create :system => "SNES",    :title => "Diddy's Kong Quest", :description => "Donkey Kong Country 2"
+      @megam = GameExtendedWithTextacular.create :system => nil,       :title => "Mega Man",           :description => "Beware Dr. Brain"
+      @sfnes = GameExtendedWithTextacular.create :system => "SNES",    :title => "Street Fighter 2",   :description => "Yoga Flame!"
+      @sfgen = GameExtendedWithTextacular.create :system => "Genesis", :title => "Street Fighter 2",   :description => "Yoga Flame!"
+      @takun = GameExtendedWithTextacular.create :system => "Saturn",  :title => "Magical Tarurūto-kun", :description => "カッコイイ！"
+    end
+
+    teardown do
+      GameExtendedWithTextacular.delete_all
+    end
+
+    should "not break respond_to? when connection is unavailable" do
+      GameFailExtendedWithTextacular.establish_connection({:adapter => :postgresql, :database =>'unavailable', :username=>'bad', :pool=>5, :timeout=>5000}) rescue nil
+
+      assert_nothing_raised do
+        GameFailExtendedWithTextacular.respond_to?(:advanced_search)
+      end
+    end
+
+    should "define a #search method" do
+      assert GameExtendedWithTextacular.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], GameExtendedWithTextacular.advanced_search("Mario")
+        assert_equal Set.new([@mario, @zelda]), GameExtendedWithTextacular.advanced_search("NES").to_set
+      end
+
+      should "work if the query contains an apostrophe" do
+        assert_equal [@dkong], GameExtendedWithTextacular.advanced_search("Diddy's")
+      end
+
+      should "work if the query contains whitespace" do
+        assert_equal [@megam], GameExtendedWithTextacular.advanced_search("Mega Man")
+      end
+
+      should "work if the query contains an accent" do
+        assert_equal [@takun], GameExtendedWithTextacular.advanced_search("Tarurūto-kun")
+      end
+
+      should "search across records with NULL values" do
+        assert_equal [@megam], GameExtendedWithTextacular.advanced_search("Mega")
+      end
+
+      should "scope consecutively" do
+        assert_equal [@sfgen], GameExtendedWithTextacular.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 GameExtendedWithTextacular.advanced_search(:title => "NES")
+        assert_empty GameExtendedWithTextacular.advanced_search(:system => "Mario")
+        assert_empty GameExtendedWithTextacular.advanced_search(:system => "NES", :title => "Sonic")
+
+        assert_equal [@mario], GameExtendedWithTextacular.advanced_search(:title => "Mario")
+
+        assert_equal 2, GameExtendedWithTextacular.advanced_search(:system => "NES").count
+
+        assert_equal [@zelda], GameExtendedWithTextacular.advanced_search(:system => "NES", :title => "Zelda")
+        assert_equal [@megam], GameExtendedWithTextacular.advanced_search(:title => "Mega")
+      end
+
+      should "scope consecutively" do
+        assert_equal [@sfgen], GameExtendedWithTextacular.advanced_search(:system => "Genesis").advanced_search(:title => "Street Fighter")
+      end
+
+      should "cast non-:string columns as text" do
+        assert_equal [@mario], GameExtendedWithTextacular.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], GameExtendedWithTextacular.advanced_search_by_title("Mario")
+        assert_equal [@takun], GameExtendedWithTextacular.advanced_search_by_system("Saturn")
+      end
+
+      should "generate methods for each :text column" do
+        assert_equal [@mario], GameExtendedWithTextacular.advanced_search_by_description("platform")
+      end
+
+      should "generate methods for any combination of :string and :text columns" do
+        assert_equal [@mario], GameExtendedWithTextacular.advanced_search_by_title_and_system("Mario", "NES")
+        assert_equal [@sonic], GameExtendedWithTextacular.advanced_search_by_system_and_title("Genesis", "Sonic")
+        assert_equal [@mario], GameExtendedWithTextacular.advanced_search_by_title_and_title("Mario", "Mario")
+        assert_equal [@megam], GameExtendedWithTextacular.advanced_search_by_title_and_description("Man", "Brain")
+      end
+
+      should "generate methods for inclusive searches" do
+        assert_equal Set.new([@megam, @takun]), GameExtendedWithTextacular.advanced_search_by_system_or_title("Saturn", "Mega Man").to_set
+      end
+
+      should "scope consecutively" do
+        assert_equal [@sfgen], GameExtendedWithTextacular.advanced_search_by_system("Genesis").advanced_search_by_title("Street Fighter")
+      end
+
+      should "generate methods for non-:string columns" do
+        assert_equal [@mario], GameExtendedWithTextacular.advanced_search_by_id(@mario.id)
+      end
+
+      should "work with #respond_to?" do
+        assert GameExtendedWithTextacular.respond_to?(:advanced_search_by_system)
+        assert GameExtendedWithTextacular.respond_to?(:advanced_search_by_title)
+        assert GameExtendedWithTextacular.respond_to?(:advanced_search_by_system_and_title)
+        assert GameExtendedWithTextacular.respond_to?(:advanced_search_by_system_or_title)
+        assert GameExtendedWithTextacular.respond_to?(:advanced_search_by_title_and_title_and_title)
+        assert GameExtendedWithTextacular.respond_to?(:advanced_search_by_id)
+
+        assert !GameExtendedWithTextacular.respond_to?(:advanced_search_by_title_and_title_or_title)
+      end
+
+      should "allow for 2 arguments to #respond_to?" do
+        assert GameExtendedWithTextacular.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
+          GameExtendedWithTextacular.select(:title).advanced_search("Mario").first.system
+        end
+      end
+    end
+
+    context "when setting a custom search language" do
+      setup do
+        GameExtendedWithTextacularAndCustomLanguage.create :system => "PS3", :title => "Harry Potter & the Deathly Hallows"
+      end
+
+      teardown do
+        GameExtendedWithTextacularAndCustomLanguage.delete_all
+      end
+
+      should "still find results" do
+        assert_not_empty GameExtendedWithTextacularAndCustomLanguage.advanced_search_by_title("harry")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: textacular
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Ben Hamill
+- ecin
+- Aaron Patterson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-27 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
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        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: !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'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  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!"
+email:
+- git-commits@benhamill.com
+- ecin@copypastel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/textacular.rb
+- lib/textacular/full_text_indexer.rb
+- lib/textacular/postgres_module_installer.rb
+- lib/textacular/rails.rb
+- lib/textacular/searchable.rb
+- lib/textacular/tasks.rb
+- lib/textacular/version.rb
+- spec/config.yml.example
+- spec/fixtures/character.rb
+- spec/fixtures/game.rb
+- spec/fixtures/webcomic.rb
+- spec/spec_helper.rb
+- spec/textacular/searchable_spec.rb
+- spec/textacular_spec.rb
+homepage: http://textacular.github.com/textacular
+licenses:
+- MIT
+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
+signing_key: 
+specification_version: 3
+summary: Textacular 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/textacular/searchable_spec.rb
+- spec/textacular_spec.rb
+has_rdoc: