drtom-textacular 4.0.0.alpha.20160302

data/spec/support/ar_stand_in.rb

@@ -0,0 +1,4 @@
+class ARStandIn < ActiveRecord::Base;
+  self.abstract_class = true
+  extend Textacular
+end

data/spec/support/character.rb

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

data/spec/support/game.rb

@@ -0,0 +1,5 @@
+class Game < ActiveRecord::Base
+  # string :system
+  # string :title
+  # text :description
+end

data/spec/support/game_extended_with_textacular.rb

@@ -0,0 +1,5 @@
+require 'support/game'
+
+class GameExtendedWithTextacular < Game
+  extend Textacular
+end

data/spec/support/game_extended_with_textacular_and_custom_language.rb

@@ -0,0 +1,7 @@
+require 'support/game_extended_with_textacular'
+
+class GameExtendedWithTextacularAndCustomLanguage < GameExtendedWithTextacular
+  def searchable_language
+    'spanish'
+  end
+end

data/spec/support/game_fail.rb

@@ -0,0 +1,3 @@
+require 'support/game'
+
+class GameFail < Game; end

data/spec/support/game_fail_extended_with_textacular.rb

@@ -0,0 +1,5 @@
+require 'support/game_fail'
+
+class GameFailExtendedWithTextacular < GameFail
+  extend Textacular
+end

data/spec/support/not_there.rb

@@ -0,0 +1,3 @@
+require 'support/ar_stand_in'
+
+class NotThere < ARStandIn; end

data/spec/support/textacular_web_comic.rb

@@ -0,0 +1,7 @@
+require 'support/ar_stand_in'
+require 'support/character'
+
+class TextacularWebComic < ARStandIn;
+  has_many :characters, :foreign_key => :web_comic_id
+  self.table_name = :web_comics
+end

data/spec/support/web_comic.rb

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

data/spec/support/web_comic_with_searchable.rb

@@ -0,0 +1,6 @@
+require 'textacular/searchable'
+require 'support/web_comic'
+
+class WebComicWithSearchable < WebComic
+  extend Searchable
+end

data/spec/support/web_comic_with_searchable_name.rb

@@ -0,0 +1,6 @@
+require 'textacular/searchable'
+require 'support/web_comic'
+
+class WebComicWithSearchableName < WebComic
+  extend Searchable(:name)
+end

data/spec/support/web_comic_with_searchable_name_and_author.rb

@@ -0,0 +1,6 @@
+require 'textacular/searchable'
+require 'support/web_comic'
+
+class WebComicWithSearchableNameAndAuthor < WebComic
+  extend Searchable(:name, :author)
+end

data/spec/textacular/full_text_indexer_spec.rb

@@ -0,0 +1,69 @@
+require 'support/web_comic_with_searchable_name'
+require 'support/web_comic_with_searchable_name_and_author'
+
+RSpec.describe Textacular::FullTextIndexer do
+  context "with one specific field in a Searchable call" do
+    it "generates the right SQL" do
+      file_name = "web_comic_with_searchable_name_full_text_search"
+      content = <<-MIGRATION
+class WebComicWithSearchableNameFullTextSearch < ActiveRecord::Migration
+  def self.up
+    execute(<<-SQL.strip)
+      DROP index IF EXISTS web_comics_name_fts_idx;
+      CREATE index web_comics_name_fts_idx
+        ON web_comics
+        USING gin(to_tsvector("english", "web_comics"."name"::text));
+    SQL
+  end
+
+  def self.down
+    execute(<<-SQL.strip)
+      DROP index IF EXISTS web_comics_name_fts_idx;
+    SQL
+  end
+end
+MIGRATION
+
+      generator = double(:migration_generator)
+      expect(Textacular::MigrationGenerator).to receive(:new).with(content, file_name).and_return(generator)
+      expect(generator).to receive(:generate_migration)
+
+      Textacular::FullTextIndexer.new.generate_migration('WebComicWithSearchableName')
+    end
+  end
+
+  context "with two specific fields in a Searchable call" do
+    it "generates the right SQL" do
+      file_name = "web_comic_with_searchable_name_and_author_full_text_search"
+      content = <<-MIGRATION
+class WebComicWithSearchableNameAndAuthorFullTextSearch < ActiveRecord::Migration
+  def self.up
+    execute(<<-SQL.strip)
+      DROP index IF EXISTS web_comics_name_fts_idx;
+      CREATE index web_comics_name_fts_idx
+        ON web_comics
+        USING gin(to_tsvector("english", "web_comics"."name"::text));
+      DROP index IF EXISTS web_comics_author_fts_idx;
+      CREATE index web_comics_author_fts_idx
+        ON web_comics
+        USING gin(to_tsvector("english", "web_comics"."author"::text));
+    SQL
+  end
+
+  def self.down
+    execute(<<-SQL.strip)
+      DROP index IF EXISTS web_comics_name_fts_idx;
+      DROP index IF EXISTS web_comics_author_fts_idx;
+    SQL
+  end
+end
+MIGRATION
+
+      generator = double(:migration_generator)
+      expect(Textacular::MigrationGenerator).to receive(:new).with(content, file_name).and_return(generator)
+      expect(generator).to receive(:generate_migration)
+
+      Textacular::FullTextIndexer.new.generate_migration('WebComicWithSearchableNameAndAuthor')
+    end
+  end
+end

data/spec/textacular/migration_generator_spec.rb

@@ -0,0 +1,67 @@
+RSpec.describe Textacular::MigrationGenerator do
+  describe ".stream_output" do
+    context "when Rails is not defined" do
+      subject do
+        Textacular::MigrationGenerator.new('filename', 'content')
+      end
+
+      it "points to STDOUT" do
+        output_stream = nil
+
+        subject.stream_output do |io|
+          output_stream = io
+        end
+
+        expect(output_stream).to eq(STDOUT)
+      end
+    end
+
+    context "when Rails is defined" do
+      before do
+        module ::Rails
+          # Stub this out, sort of.
+          def self.root
+            File.join('.', 'fake_rails')
+          end
+        end
+      end
+
+      after do
+        Object.send(:remove_const, :Rails)
+        FileUtils.rm_rf(File.join('.', 'fake_rails'))
+      end
+
+      let(:now) do
+        Time.now
+      end
+
+      subject do
+        Textacular::MigrationGenerator.new('file_name', 'content')
+      end
+
+      it "points to a properly names migration file" do
+        expected_file_name = "./fake_rails/db/migrate/#{now.strftime('%Y%m%d%H%M%S')}_file_name.rb"
+
+        output_stream = nil
+
+        subject.stream_output(now) do |io|
+          output_stream = io
+        end
+
+        expect(output_stream.path).to eq(expected_file_name)
+      end
+    end
+
+    it "generates the right SQL" do
+      content = "content\n" #newline automatically added
+      output = StringIO.new
+
+      generator = Textacular::MigrationGenerator.new('file_name', content)
+      generator.instance_variable_set(:@output_stream, output)
+
+      generator.generate_migration
+
+      expect(output.string).to eq(content)
+    end
+  end
+end

data/spec/textacular/searchable_spec.rb

@@ -0,0 +1,194 @@
+require 'support/web_comic_with_searchable'
+require 'support/web_comic_with_searchable_name'
+require 'support/web_comic_with_searchable_name_and_author'
+require 'support/character'
+
+RSpec.describe "Searchable" do
+  context "when extending an ActiveRecord::Base subclass" do
+    context "with no parameters" do
+      let!(:questionable_content) do
+        WebComicWithSearchable.create(
+          name: 'Questionable Content',
+          author: 'Jeph Jaques',
+        )
+      end
+
+      let!(:johnny_wander) do
+        WebComicWithSearchable.create(
+          name: 'Johnny Wander',
+          author: 'Ananth & Yuko',
+        )
+      end
+
+      let!(:dominic_deegan) do
+        WebComicWithSearchable.create(
+          name: 'Dominic Deegan',
+          author: 'Mookie',
+        )
+      end
+
+      let!(:penny_arcade) do
+        WebComicWithSearchable.create(
+          name: 'Penny Arcade',
+          author: 'Tycho & Gabe',
+        )
+      end
+
+      let!(:null) do
+        WebComicWithSearchable.create(
+          author: 'Foo',
+        )
+      end
+
+      it "searches across all columns" do
+        expect(
+          WebComicWithSearchable.advanced_search("Penny")
+        ).to eq([penny_arcade])
+        expect(
+          WebComicWithSearchable.advanced_search("Dominic")
+        ).to eq([dominic_deegan])
+      end
+
+      it "ranks results, egen with NULL columns" do
+        comic = WebComicWithSearchable.basic_search('Foo').first
+        rank = comic.attributes.find { |key, value| key.to_s =~ /\Arank\d+\z/ }.last
+
+        expect(rank).to be_present
+      end
+    end
+
+    context "with one column as a parameter" do
+      let!(:questionable_content) do
+        WebComicWithSearchableName.create(
+          name: 'Questionable Content',
+          author: nil,
+        )
+      end
+
+      let!(:johnny_wander) do
+        WebComicWithSearchableName.create(
+          name: 'Johnny Wander',
+          author: 'Ananth & Yuko',
+        )
+      end
+
+      let!(:dominic_deegan) do
+        WebComicWithSearchableName.create(
+          name: 'Dominic Deegan',
+          author: 'Mookie',
+        )
+      end
+
+      let!(:penny_arcade) do
+        WebComicWithSearchableName.create(
+          name: 'Penny Arcade',
+          author: 'Tycho & Gabe',
+        )
+      end
+
+      it "only searches across the given column" do
+        expect(WebComicWithSearchableName.advanced_search("Penny")).to eq([penny_arcade])
+
+        expect(WebComicWithSearchableName.advanced_search("Tycho")).to be_empty
+      end
+
+      describe "basic search" do # Uses plainto_tsquery
+        ["hello \\", "tebow!" , "food &"].each do |search_term|
+          it "works with interesting term \"#{search_term}\"" do
+            expect(WebComicWithSearchableName.basic_search(search_term)).to be_empty
+          end
+        end
+      end
+
+      describe "advanced_search" do # Uses to_tsquery
+        ["hello \\", "tebow!" , "food &"].each do |search_term|
+          it "fails with interesting term \"#{search_term}\"" do
+            expect {
+              WebComicWithSearchableName.advanced_search(search_term).first
+            }.to raise_error(ActiveRecord::StatementInvalid)
+          end
+        end
+        it "searches with negation" do
+          expect(WebComicWithSearchableName.advanced_search('foo & ! bar')).to be_empty
+        end
+      end
+
+      it "does fuzzy searching" do
+        expect(
+          WebComicWithSearchableName.fuzzy_search('Questio')
+        ).to eq([questionable_content])
+      end
+
+      it "return a valid rank when fuzzy searching on NULL columns" do
+        qcont_with_author = questionable_content.becomes(WebComicWithSearchableNameAndAuthor)
+        search_result = WebComicWithSearchableNameAndAuthor.fuzzy_search('Questio')
+        expect([qcont_with_author]).to eq(search_result)
+        expect(search_result.first.attributes.find { |k, _| k[0..3] == 'rank' }.last).to be_truthy
+      end
+
+      it "defines :searchable_columns as private" do
+        expect { WebComicWithSearchableName.searchable_columns }.to raise_error(NoMethodError)
+
+        begin
+          WebComicWithSearchableName.searchable_columns
+        rescue NoMethodError => error
+          expect(error.message).to match(/private method/)
+        end
+      end
+
+      it "defines #indexable_columns which returns a write-proof Enumerable" do
+        expect(WebComicWithSearchableName.indexable_columns).to be_an(Enumerator)
+
+        expect {
+          WebComicWithSearchableName.indexable_columns[0] = 'foo'
+        }.to raise_error(NoMethodError)
+      end
+    end
+
+    context "with two columns as parameters" do
+      let!(:questionable_content) do
+        WebComicWithSearchableNameAndAuthor.create(
+          name: 'Questionable Content',
+          author: 'Jeph Jaques',
+        )
+      end
+
+      let!(:johnny_wander) do
+        WebComicWithSearchableNameAndAuthor.create(
+          name: 'Johnny Wander',
+          author: 'Ananth & Yuko',
+        )
+      end
+
+      let!(:dominic_deegan) do
+        WebComicWithSearchableNameAndAuthor.create(
+          name: 'Dominic Deegan',
+          author: 'Mookie',
+        )
+      end
+
+      let!(:penny_arcade) do
+        WebComicWithSearchableNameAndAuthor.create(
+          name: 'Penny Arcade',
+          author: 'Tycho & Gabe',
+        )
+      end
+
+      it "only searches across the given columns" do
+        expect(
+          WebComicWithSearchableNameAndAuthor.advanced_search("Penny")
+        ).to eq([penny_arcade])
+
+        expect(
+          WebComicWithSearchableNameAndAuthor.advanced_search("Tycho")
+        ).to eq([penny_arcade])
+      end
+
+      it "allows includes" do
+        expect(
+          WebComicWithSearchableNameAndAuthor.includes(:characters).advanced_search("Penny")
+        ).to eq([penny_arcade])
+      end
+    end
+  end
+end

data/spec/textacular/trigram_installer_spec.rb

@@ -0,0 +1,24 @@
+RSpec.describe "Textacular::TrigramInstaller" do
+  let(:content) do
+    <<-MIGRATION
+class InstallTrigram < ActiveRecord::Migration
+  def self.up
+    ActiveRecord::Base.connection.execute("CREATE EXTENSION IF NOT EXISTS pg_trgm;")
+  end
+
+  def self.down
+    ActiveRecord::Base.connection.execute("DROP EXTENSION pg_trgm;")
+  end
+end
+MIGRATION
+  end
+
+  it "generates a migration" do
+    generator = double(:migration_generator)
+
+    expect(Textacular::MigrationGenerator).to receive(:new).with('install_trigram', content).and_return(generator)
+    expect(generator).to receive(:generate_migration)
+
+    Textacular::TrigramInstaller.new.generate_migration
+  end
+end