pg_search 2.3.0 → 2.3.5

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, ->(*) { {} }
 
@@ -144,7 +145,7 @@ describe "an Active Record model which includes PgSearch" do
   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 +158,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 +175,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 +192,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 +201,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 +271,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 +284,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
 
@@ -451,7 +452,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 +482,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 +521,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 +563,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,
@@ -712,7 +713,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 +729,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 +745,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 +761,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 +839,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 +878,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 +951,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 +1012,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 +1030,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 +1067,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 +1078,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 +1097,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 +1117,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 +1125,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 +1166,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 +1190,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 +1204,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 +1241,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 +1256,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 +1271,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 +1308,4 @@ describe "an Active Record model which includes PgSearch" do
     end
   end
 end
+# rubocop:enable RSpec/NestedGroups

data/spec/lib/pg_search/configuration/association_spec.rb

@@ -2,6 +2,7 @@
 
 require "spec_helper"
 
+# rubocop:disable RSpec/NestedGroups
 describe PgSearch::Configuration::Association do
   with_model :Avatar do
     table do |t|
@@ -39,7 +40,7 @@ describe PgSearch::Configuration::Association do
     end
   end
 
-  context "has_one" do
+  context "with has_one" do
     let(:association) { described_class.new(User, :avatar, :url) }
 
     describe "#table_name" do
@@ -50,7 +51,7 @@ describe PgSearch::Configuration::Association do
 
     describe "#join" do
       let(:expected_sql) do
-        <<-SQL.gsub(/\s+/, ' ').strip
+        <<~SQL.squish
           LEFT OUTER JOIN
             (SELECT model_id AS id,
                     #{column_select} AS #{association.columns.first.alias}
@@ -70,7 +71,7 @@ describe PgSearch::Configuration::Association do
     end
   end
 
-  context "belongs_to" do
+  context "with belongs_to" do
     let(:association) { described_class.new(User, :site, :title) }
 
     describe "#table_name" do
@@ -81,7 +82,7 @@ describe PgSearch::Configuration::Association do
 
     describe "#join" do
       let(:expected_sql) do
-        <<-SQL.gsub(/\s+/, ' ').strip
+        <<~SQL.squish
           LEFT OUTER JOIN
             (SELECT model_id AS id,
                     #{column_select} AS #{association.columns.first.alias}
@@ -101,7 +102,7 @@ describe PgSearch::Configuration::Association do
     end
   end
 
-  context "has_many" do
+  context "with has_many" do
     let(:association) { described_class.new(Site, :users, :name) }
 
     describe "#table_name" do
@@ -112,7 +113,7 @@ describe PgSearch::Configuration::Association do
 
     describe "#join" do
       let(:expected_sql) do
-        <<-SQL.gsub(/\s+/, ' ').strip
+        <<~SQL.squish
           LEFT OUTER JOIN
             (SELECT model_id AS id,
                     string_agg(\"#{association.table_name}\".\"name\"::text, ' ') AS #{association.columns.first.alias}
@@ -138,3 +139,4 @@ describe PgSearch::Configuration::Association do
     end
   end
 end
+# rubocop:enable RSpec/NestedGroups