pg_search 2.3.0 → 2.3.6

data/spec/integration/associations_spec.rb

@@ -2,8 +2,9 @@
 
 require "spec_helper"
 
-describe PgSearch do
-  context "joining to another table" do
+# rubocop:disable RSpec/NestedGroups
+describe "a pg_search_scope" do
+  context "when joining to another table" do
     context "without an :against" do
       with_model :AssociatedModel do
         table do |t|
@@ -41,7 +42,7 @@ describe PgSearch do
       end
     end
 
-    context "through a belongs_to association" do
+    context "via a belongs_to association" do
       with_model :AssociatedModel do
         table do |t|
           t.string 'title'
@@ -77,7 +78,7 @@ describe PgSearch do
       end
     end
 
-    context "through a has_many association" do
+    context "via a has_many association" do
       with_model :AssociatedModelWithHasMany do
         table do |t|
           t.string 'title'
@@ -141,8 +142,8 @@ describe PgSearch do
       end
     end
 
-    context "across multiple associations" do
-      context "on different tables" do
+    context "when across multiple associations" do
+      context "when on different tables" do
         with_model :FirstAssociatedModel do
           table do |t|
             t.string 'title'
@@ -207,7 +208,7 @@ describe PgSearch do
         end
       end
 
-      context "on the same table" do
+      context "when on the same table" do
         with_model :DoublyAssociatedModel do
           table do |t|
             t.string 'title'
@@ -268,7 +269,7 @@ describe PgSearch do
       end
     end
 
-    context "against multiple attributes on one association" do
+    context "when against multiple attributes on one association" do
       with_model :AssociatedModel do
         table do |t|
           t.string 'title'
@@ -289,7 +290,7 @@ describe PgSearch do
         end
       end
 
-      it "should only do one join" do
+      it "joins only once" do
         included = [
           ModelWithAssociation.create!(
             another_model: AssociatedModel.create!(
@@ -321,7 +322,7 @@ describe PgSearch do
       end
     end
 
-    context "against non-text columns" do
+    context "when against non-text columns" do
       with_model :AssociatedModel do
         table do |t|
           t.integer 'number'
@@ -342,7 +343,7 @@ describe PgSearch do
         end
       end
 
-      it "should cast the columns to text" do
+      it "casts the columns to text" do
         associated = AssociatedModel.create!(number: 123)
         included = [
           Model.create!(number: 123, another_model: associated),
@@ -395,7 +396,7 @@ describe PgSearch do
     end
   end
 
-  context "merging a pg_search_scope into another model's scope" do
+  context "when merging a pg_search_scope into another model's scope" do
     with_model :ModelWithAssociation do
       model do
         has_many :associated_models
@@ -416,7 +417,7 @@ describe PgSearch do
       end
     end
 
-    it "should find records of the other model" do
+    it "finds records of the other model" do
       included_associated_1 = AssociatedModel.create(content: "foo bar")
       included_associated_2 = AssociatedModel.create(content: "foo baz")
       excluded_associated_1 = AssociatedModel.create(content: "baz quux")
@@ -441,7 +442,7 @@ describe PgSearch do
     end
   end
 
-  context "chained onto a has_many association" do
+  context "when chained onto a has_many association" do
     with_model :Company do
       model do
         has_many :positions
@@ -461,48 +462,7 @@ describe PgSearch do
     end
 
     # https://github.com/Casecommons/pg_search/issues/106
-    it "should handle numbers in a trigram query properly" do
-      company = Company.create!
-      another_company = Company.create!
-
-      included = [
-        Position.create!(company_id: company.id, title: "teller 1")
-      ]
-
-      excluded = [
-        Position.create!(company_id: nil, title: "teller 1"),
-        Position.create!(company_id: another_company.id, title: "teller 1"),
-        Position.create!(company_id: company.id, title: "penn 1")
-      ]
-
-      results = company.positions.search('teller 1')
-
-      expect(results).to include(*included)
-      expect(results).not_to include(*excluded)
-    end
-  end
-
-  context "chained onto a has_many association" do
-    with_model :Company do
-      model do
-        has_many :positions
-      end
-    end
-
-    with_model :Position do
-      table do |t|
-        t.string :title
-        t.belongs_to :company
-      end
-
-      model do
-        include PgSearch::Model
-        pg_search_scope :search, against: :title, using: %i[tsearch trigram]
-      end
-    end
-
-    # https://github.com/Casecommons/pg_search/issues/106
-    it "should handle numbers in a trigram query properly" do
+    it "handles numbers in a trigram query properly" do
       company = Company.create!
       another_company = Company.create!
 
@@ -524,3 +484,4 @@ describe PgSearch do
     end
   end
 end
+# rubocop:enable RSpec/NestedGroups

data/spec/integration/deprecation_spec.rb

@@ -23,7 +23,7 @@ describe "Including the deprecated PgSearch module" do
     AnotherModel.include(PgSearch)
 
     expect(ActiveSupport::Deprecation).to have_received(:warn).with(
-      <<-MESSAGE.strip_heredoc
+      <<~MESSAGE
         Directly including `PgSearch` into an Active Record model is deprecated and will be removed in pg_search 3.0.
 
         Please replace `include PgSearch` with `include PgSearch::Model`.

data/spec/integration/pg_search_spec.rb

@@ -2,6 +2,7 @@
 
 require "spec_helper"
 
+# rubocop:disable RSpec/NestedGroups
 describe "an Active Record model which includes PgSearch" do
   with_model :ModelWithPgSearch do
     table do |t|
@@ -64,7 +65,7 @@ describe "an Active Record model which includes PgSearch" do
         }.to raise_error(ArgumentError, /foo/)
       end
 
-      context "dynamically" do
+      context "with a lambda" do
         it "raises an exception when invoked" do
           ModelWithPgSearch.pg_search_scope :with_unknown_option,
                                             ->(*) { { against: :content, foo: :bar } }
@@ -87,7 +88,7 @@ describe "an Active Record model which includes PgSearch" do
         }.to raise_error(ArgumentError, /foo/)
       end
 
-      context "dynamically" do
+      context "with a lambda" do
         it "raises an exception when invoked" do
           ModelWithPgSearch.pg_search_scope :with_unknown_using,
                                             ->(*) { { against: :content, using: :foo } }
@@ -110,7 +111,7 @@ describe "an Active Record model which includes PgSearch" do
         }.to raise_error(ArgumentError, /ignoring.*foo/)
       end
 
-      context "dynamically" do
+      context "with a lambda" do
         it "raises an exception when invoked" do
           ModelWithPgSearch.pg_search_scope :with_unknown_ignoring,
                                             ->(*) { { against: :content, ignoring: :foo } }
@@ -130,7 +131,7 @@ describe "an Active Record model which includes PgSearch" do
           }.to raise_error(ArgumentError, /against/)
         end
 
-        context "dynamically" do
+        context "with a lambda" do
           it "raises an exception when invoked" do
             ModelWithPgSearch.pg_search_scope :with_unknown_ignoring, ->(*) { {} }
 
@@ -139,12 +140,28 @@ describe "an Active Record model which includes PgSearch" do
             }.to raise_error(ArgumentError, /against/)
           end
         end
+
+        context "when a tsvector column is specified" do
+          it "does not raise an exception when invoked" do
+            ModelWithPgSearch.pg_search_scope :with_unknown_ignoring, {
+              using: {
+                tsearch: {
+                  tsvector_column: "tsv"
+                }
+              }
+            }
+
+            expect {
+              ModelWithPgSearch.with_unknown_ignoring("foo")
+            }.not_to raise_error
+          end
+        end
       end
     end
   end
 
   describe "a search scope" do
-    context "against a single column" do
+    context "when against a single column" do
       before do
         ModelWithPgSearch.pg_search_scope :search_content, against: :content
       end
@@ -157,7 +174,7 @@ describe "an Active Record model which includes PgSearch" do
           results = ModelWithPgSearch.select('id, title').search_content('foo')
 
           expect(results).to include(included)
-          expect(results).to_not include(excluded)
+          expect(results).not_to include(excluded)
 
           expect(results.first.attributes.key?('content')).to eq false
 
@@ -174,7 +191,7 @@ describe "an Active Record model which includes PgSearch" do
           results = ModelWithPgSearch.search_content('foo').select('id, title')
 
           expect(results).to include(included)
-          expect(results).to_not include(excluded)
+          expect(results).not_to include(excluded)
 
           expect(results.first.attributes.key?('content')).to eq false
 
@@ -191,7 +208,7 @@ describe "an Active Record model which includes PgSearch" do
           results = ModelWithPgSearch.select('id').search_content('foo').select('title')
 
           expect(results).to include(included)
-          expect(results).to_not include(excluded)
+          expect(results).not_to include(excluded)
 
           expect(results.first.attributes.key?('content')).to eq false
 
@@ -200,7 +217,7 @@ describe "an Active Record model which includes PgSearch" do
         end
       end
 
-      context "chained to a cross-table scope" do
+      context "when chained to a cross-table scope" do
         with_model :House do
           table do |t|
             t.references :person
@@ -270,7 +287,7 @@ describe "an Active Record model which includes PgSearch" do
           it "does not raise an exception" do
             relation = Person.named('foo').house_search_city('bar')
 
-            expect { relation.to_a }.to_not raise_error
+            expect { relation.to_a }.not_to raise_error
           end
         end
       end
@@ -283,7 +300,7 @@ describe "an Active Record model which includes PgSearch" do
         it "does not raise an exception" do
           relation = ModelWithPgSearch.search_content('foo').search_title('bar')
 
-          expect { relation.to_a }.to_not raise_error
+          expect { relation.to_a }.not_to raise_error
         end
       end
 
@@ -406,6 +423,15 @@ describe "an Active Record model which includes PgSearch" do
         expect(results).to eq([winner, loser])
       end
 
+      it 'preserves column selection when with_pg_search_rank is chained after a select()' do
+        loser = ModelWithPgSearch.create!(title: 'foo', content: 'bar')
+
+        results = ModelWithPgSearch.search_content('bar').select(:content).with_pg_search_rank
+
+        expect(results.length).to be 1
+        expect(results.first.as_json.keys).to contain_exactly('id', 'content', 'pg_search_rank')
+      end
+
       it 'allows pg_search_rank along with a join' do
         parent_1 = ParentModel.create!(id: 98)
         parent_2 = ParentModel.create!(id: 99)
@@ -451,7 +477,7 @@ describe "an Active Record model which includes PgSearch" do
 
       it "accepts non-string queries and calls #to_s on them" do
         foo = ModelWithPgSearch.create!(content: "foo")
-        not_a_string = double(to_s: "foo")
+        not_a_string = instance_double("Object", to_s: "foo")
         expect(ModelWithPgSearch.search_content(not_a_string)).to eq([foo])
       end
 
@@ -481,7 +507,7 @@ describe "an Active Record model which includes PgSearch" do
       end
     end
 
-    context "against multiple columns" do
+    context "when against multiple columns" do
       before do
         ModelWithPgSearch.pg_search_scope :search_title_and_content, against: %i[title content]
       end
@@ -520,7 +546,7 @@ describe "an Active Record model which includes PgSearch" do
       end
     end
 
-    context "using trigram" do
+    context "when using trigram" do
       before do
         ModelWithPgSearch.pg_search_scope :with_trigrams, against: %i[title content], using: :trigram
       end
@@ -562,7 +588,7 @@ describe "an Active Record model which includes PgSearch" do
       end
     end
 
-    context "using tsearch" do
+    context "when using tsearch" do
       before do
         ModelWithPgSearch.pg_search_scope :search_title_with_prefixes,
                                           against: :title,
@@ -613,7 +639,7 @@ describe "an Active Record model which includes PgSearch" do
       describe "highlighting" do
         before do
           ["Strip Down", "Down", "Down and Out", "Won't Let You Down"].each do |name|
-            ModelWithPgSearch.create! content: name
+            ModelWithPgSearch.create! title: 'Just a title', content: name
           end
         end
 
@@ -634,6 +660,12 @@ describe "an Active Record model which includes PgSearch" do
 
             expect(result.pg_search_highlight).to eq("Won't <b>Let</b> You Down")
           end
+
+          it 'preserves column selection when with_pg_search_highlight is chained after a select()' do
+            result = ModelWithPgSearch.search_content("Let").select(:content).with_pg_search_highlight.first
+
+            expect(result.as_json.keys).to contain_exactly('id', 'content', 'pg_search_highlight')
+          end
         end
 
         context "with custom highlighting options" do
@@ -712,7 +744,7 @@ describe "an Active Record model which includes PgSearch" do
         end
       end
 
-      context "against columns ranked with arrays" do
+      context "when against columns ranked with arrays" do
         before do
           ModelWithPgSearch.pg_search_scope :search_weighted_by_array_of_arrays,
                                             against: [[:content, 'B'], [:title, 'A']]
@@ -728,7 +760,7 @@ describe "an Active Record model which includes PgSearch" do
         end
       end
 
-      context "against columns ranked with a hash" do
+      context "when against columns ranked with a hash" do
         before do
           ModelWithPgSearch.pg_search_scope :search_weighted_by_hash,
                                             against: { content: 'B', title: 'A' }
@@ -744,7 +776,7 @@ describe "an Active Record model which includes PgSearch" do
         end
       end
 
-      context "against columns of which only some are ranked" do
+      context "when against columns of which only some are ranked" do
         before do
           ModelWithPgSearch.pg_search_scope :search_weighted,
                                             against: [:content, [:title, 'A']]
@@ -760,7 +792,7 @@ describe "an Active Record model which includes PgSearch" do
         end
       end
 
-      context "searching any_word option" do
+      context "when searching any_word option" do
         before do
           ModelWithPgSearch.pg_search_scope :search_title_with_any_word,
                                             against: :title,
@@ -838,7 +870,7 @@ describe "an Active Record model which includes PgSearch" do
       end
     end
 
-    context "using dmetaphone" do
+    context "when using dmetaphone" do
       before do
         ModelWithPgSearch.pg_search_scope :with_dmetaphones,
                                           against: %i[title content],
@@ -877,7 +909,7 @@ describe "an Active Record model which includes PgSearch" do
       end
     end
 
-    context "using multiple features" do
+    context "when using multiple features" do
       before do
         ModelWithPgSearch.pg_search_scope :with_tsearch,
                                           against: :title,
@@ -950,33 +982,40 @@ describe "an Active Record model which includes PgSearch" do
       end
 
       context "with feature-specific configuration" do
-        before do
-          @tsearch_config = tsearch_config = { dictionary: 'english' }
-          @trigram_config = trigram_config = { foo: 'bar' }
+        let(:tsearch_config) { { dictionary: 'english' } }
+        let(:trigram_config) { { foo: 'bar' } }
 
+        before do
           ModelWithPgSearch.pg_search_scope :with_tsearch_and_trigram_using_hash,
                                             against: :title,
-                                            using: {
-                                              tsearch: tsearch_config,
-                                              trigram: trigram_config
-                                            }
+                                            using: { tsearch: tsearch_config, trigram: trigram_config }
         end
 
-        it "should pass the custom configuration down to the specified feature" do
-          stub_feature = double(
+        it "passes the custom configuration down to the specified feature" do
+          tsearch_feature = instance_double(
+            "PgSearch::Features::TSearch",
             conditions: Arel::Nodes::Grouping.new(Arel.sql("1 = 1")),
             rank: Arel::Nodes::Grouping.new(Arel.sql("1.0"))
           )
 
-          expect(PgSearch::Features::TSearch).to receive(:new).with(anything, @tsearch_config, anything, anything, anything).at_least(:once).and_return(stub_feature)
-          expect(PgSearch::Features::Trigram).to receive(:new).with(anything, @trigram_config, anything, anything, anything).at_least(:once).and_return(stub_feature)
+          trigram_feature = instance_double(
+            "PgSearch::Features::Trigram",
+            conditions: Arel::Nodes::Grouping.new(Arel.sql("1 = 1")),
+            rank: Arel::Nodes::Grouping.new(Arel.sql("1.0"))
+          )
+
+          allow(PgSearch::Features::TSearch).to receive(:new).with(anything, tsearch_config, anything, anything, anything).and_return(tsearch_feature)
+          allow(PgSearch::Features::Trigram).to receive(:new).with(anything, trigram_config, anything, anything, anything).and_return(trigram_feature)
 
           ModelWithPgSearch.with_tsearch_and_trigram_using_hash("foo")
+
+          expect(PgSearch::Features::TSearch).to have_received(:new).with(anything, tsearch_config, anything, anything, anything).at_least(:once)
+          expect(PgSearch::Features::Trigram).to have_received(:new).with(anything, trigram_config, anything, anything, anything).at_least(:once)
         end
       end
     end
 
-    context "using a tsvector column and an association" do
+    context "when using a tsvector column and an association" do
       with_model :Comment do
         table do |t|
           t.integer :post_id
@@ -1004,7 +1043,7 @@ describe "an Active Record model which includes PgSearch" do
       let!(:unexpected) { Post.create!(content: 'longcat is looooooooong') }
 
       before do
-        ActiveRecord::Base.connection.execute <<-SQL.strip_heredoc
+        ActiveRecord::Base.connection.execute <<~SQL.squish
           UPDATE #{Post.quoted_table_name}
           SET content_tsvector = to_tsvector('english'::regconfig, #{Post.quoted_table_name}."content")
         SQL
@@ -1022,20 +1061,20 @@ describe "an Active Record model which includes PgSearch" do
                              }
       end
 
-      it "should find by the tsvector column" do
+      it "finds by the tsvector column" do
         expect(Post.search_by_content_with_tsvector("phooey").map(&:id)).to eq([expected.id])
       end
 
-      it "should find by the associated record" do
+      it "finds by the associated record" do
         expect(Post.search_by_content_with_tsvector("commentone").map(&:id)).to eq([expected.id])
       end
 
-      it 'should find by a combination of the two' do
+      it 'finds by a combination of the two' do
         expect(Post.search_by_content_with_tsvector("phooey commentone").map(&:id)).to eq([expected.id])
       end
     end
 
-    context 'using multiple tsvector columns' do
+    context 'when using multiple tsvector columns' do
       with_model :ModelWithTsvector do
         model do
           include PgSearch::Model
@@ -1059,7 +1098,7 @@ describe "an Active Record model which includes PgSearch" do
       end
     end
 
-    context "using a tsvector column with" do
+    context "when using a tsvector column with" do
       with_model :ModelWithTsvector do
         table do |t|
           t.text 'content'
@@ -1070,10 +1109,11 @@ describe "an Active Record model which includes PgSearch" do
       end
 
       let!(:expected) { ModelWithTsvector.create!(content: 'tiling is grouty') }
-      let!(:unexpected) { ModelWithTsvector.create!(content: 'longcat is looooooooong') }
 
       before do
-        ActiveRecord::Base.connection.execute <<-SQL.strip_heredoc
+        ModelWithTsvector.create!(content: 'longcat is looooooooong')
+
+        ActiveRecord::Base.connection.execute <<~SQL.squish
           UPDATE #{ModelWithTsvector.quoted_table_name}
           SET content_tsvector = to_tsvector('english'::regconfig, #{ModelWithTsvector.quoted_table_name}."content")
         SQL
@@ -1088,11 +1128,11 @@ describe "an Active Record model which includes PgSearch" do
                                           }
       end
 
-      it "should not use to_tsvector in the query" do
+      it "does not use to_tsvector in the query" do
         expect(ModelWithTsvector.search_by_content_with_tsvector("tiles").to_sql).not_to match(/to_tsvector/)
       end
 
-      it "should find the expected result" do
+      it "finds the expected result" do
         expect(ModelWithTsvector.search_by_content_with_tsvector("tiles").map(&:id)).to eq([expected.id])
       end
 
@@ -1108,7 +1148,7 @@ describe "an Active Record model which includes PgSearch" do
           ModelWithTsvector.has_many :another_models
         end
 
-        it "should refer to the tsvector column in the query unambiguously" do
+        it "refers to the tsvector column in the query unambiguously" do
           expect {
             ModelWithTsvector.joins(:another_models).search_by_content_with_tsvector("test").to_a
           }.not_to raise_exception
@@ -1116,7 +1156,7 @@ describe "an Active Record model which includes PgSearch" do
       end
     end
 
-    context "ignoring accents" do
+    context "when ignoring accents" do
       before do
         ModelWithPgSearch.pg_search_scope :search_title_without_accents,
                                           against: :title,
@@ -1157,13 +1197,13 @@ describe "an Active Record model which includes PgSearch" do
                                           ranked_by: ":tsearch * importance"
       end
 
-      it "should return records with a rank attribute equal to the :ranked_by expression" do
+      it "returns records with a rank attribute equal to the :ranked_by expression" do
         ModelWithPgSearch.create!(content: 'foo', importance: 10)
         results = ModelWithPgSearch.search_content_with_importance_as_rank("foo").with_pg_search_rank
         expect(results.first.pg_search_rank).to eq(10)
       end
 
-      it "should substitute :tsearch with the tsearch rank expression in the :ranked_by expression" do
+      it "substitutes :tsearch with the tsearch rank expression in the :ranked_by expression" do
         ModelWithPgSearch.create!(content: 'foo', importance: 10)
 
         tsearch_result =
@@ -1181,7 +1221,7 @@ describe "an Active Record model which includes PgSearch" do
         expect(multiplied_rank).to be_within(0.001).of(tsearch_rank * 10)
       end
 
-      it "should return results in descending order of the value of the rank expression" do
+      it "returns results in descending order of the value of the rank expression" do
         records = [
           ModelWithPgSearch.create!(content: 'foo', importance: 1),
           ModelWithPgSearch.create!(content: 'foo', importance: 3),
@@ -1195,6 +1235,7 @@ describe "an Active Record model which includes PgSearch" do
       %w[tsearch trigram dmetaphone].each do |feature|
         context "using the #{feature} ranking algorithm" do
           let(:scope_name) { :"search_content_ranked_by_#{feature}" }
+
           before do
             ModelWithPgSearch.pg_search_scope scope_name,
                                               against: :content,
@@ -1231,7 +1272,7 @@ describe "an Active Record model which includes PgSearch" do
         end
       end
 
-      context "using the tsearch ranking algorithm" do
+      context "when using the tsearch ranking algorithm" do
         it "sorts results by the tsearch rank" do
           ModelWithPgSearch.pg_search_scope :search_content_ranked_by_tsearch,
                                             using: :tsearch,
@@ -1246,7 +1287,7 @@ describe "an Active Record model which includes PgSearch" do
         end
       end
 
-      context "using the trigram ranking algorithm" do
+      context "when using the trigram ranking algorithm" do
         it "sorts results by the trigram rank" do
           ModelWithPgSearch.pg_search_scope :search_content_ranked_by_trigram,
                                             using: :trigram,
@@ -1261,7 +1302,7 @@ describe "an Active Record model which includes PgSearch" do
         end
       end
 
-      context "using the dmetaphone ranking algorithm" do
+      context "when using the dmetaphone ranking algorithm" do
         it "sorts results by the dmetaphone rank" do
           ModelWithPgSearch.pg_search_scope :search_content_ranked_by_dmetaphone,
                                             using: :dmetaphone,
@@ -1298,3 +1339,4 @@ describe "an Active Record model which includes PgSearch" do
     end
   end
 end
+# rubocop:enable RSpec/NestedGroups