pg_search 2.3.5 → 2.3.7

data/spec/lib/pg_search/multisearch/rebuilder_spec.rb

@@ -2,14 +2,14 @@
 
 require "spec_helper"
 
-# rubocop:disable RSpec/NestedGroups
+# standard:disable RSpec/NestedGroups
 describe PgSearch::Multisearch::Rebuilder do
   with_table "pg_search_documents", &DOCUMENTS_SCHEMA
 
-  describe 'when initialized with a model that is not multisearchable' do
+  describe "when initialized with a model that is not multisearchable" do
     with_model :not_multisearchable
 
-    it 'raises an exception' do
+    it "raises an exception" do
       expect {
         described_class.new(NotMultisearchable)
       }.to raise_exception(
@@ -108,7 +108,7 @@ describe PgSearch::Multisearch::Rebuilder do
             end
           end
 
-          # rubocop:disable RSpec/ExampleLength
+          # standard:disable RSpec/ExampleLength
           it "executes the default SQL" do
             time = Time.utc(2001, 1, 1, 0, 0, 0)
             rebuilder = described_class.new(Model, -> { time })
@@ -137,7 +137,7 @@ describe PgSearch::Multisearch::Rebuilder do
             expect(executed_sql.length).to eq(1)
             expect(executed_sql.first.strip).to eq(expected_sql.strip)
           end
-          # rubocop:enable RSpec/ExampleLength
+          # standard:enable RSpec/ExampleLength
 
           context "with a model with a camel case column" do
             with_model :ModelWithCamelCaseColumn do
@@ -151,10 +151,10 @@ describe PgSearch::Multisearch::Rebuilder do
               end
             end
 
-            it "creates search document without PG error" do
+            it "rebuilds without error" do
               time = Time.utc(2001, 1, 1, 0, 0, 0)
               rebuilder = described_class.new(Model, -> { time })
-              rebuilder.rebuild
+              expect { rebuilder.rebuild }.not_to raise_error
             end
           end
 
@@ -170,7 +170,7 @@ describe PgSearch::Multisearch::Rebuilder do
               end
             end
 
-            # rubocop:disable RSpec/ExampleLength
+            # standard:disable RSpec/ExampleLength
             it "generates SQL with the correct primary key" do
               time = Time.utc(2001, 1, 1, 0, 0, 0)
               rebuilder = described_class.new(ModelWithNonStandardPrimaryKey, -> { time })
@@ -199,7 +199,7 @@ describe PgSearch::Multisearch::Rebuilder do
               expect(executed_sql.length).to eq(1)
               expect(executed_sql.first.strip).to eq(expected_sql.strip)
             end
-            # rubocop:enable RSpec/ExampleLength
+            # standard:enable RSpec/ExampleLength
           end
         end
 
@@ -215,7 +215,7 @@ describe PgSearch::Multisearch::Rebuilder do
             end
           end
 
-          # rubocop:disable RSpec/ExampleLength
+          # standard:disable RSpec/ExampleLength
           it "calls update_pg_search_document on each record" do
             record = Model.create!
 
@@ -241,7 +241,7 @@ describe PgSearch::Multisearch::Rebuilder do
 
             expect(record.pg_search_document).to be_present
           end
-          # rubocop:enable RSpec/ExampleLength
+          # standard:enable RSpec/ExampleLength
         end
 
         context "when only additional_attributes is set" do
@@ -253,7 +253,7 @@ describe PgSearch::Multisearch::Rebuilder do
             model do
               include PgSearch::Model
               multisearchable against: :name,
-                              additional_attributes: ->(obj) { { additional_attribute_column: "#{obj.class}::#{obj.id}" } }
+                additional_attributes: ->(obj) { {additional_attribute_column: "#{obj.class}::#{obj.id}"} }
             end
           end
 
@@ -285,7 +285,7 @@ describe PgSearch::Multisearch::Rebuilder do
             end
           end
 
-          # rubocop:disable RSpec/ExampleLength
+          # standard:disable RSpec/ExampleLength
           it "calls update_pg_search_document on each record" do
             record_1 = Model.create!(active: true)
             record_2 = Model.create!(active: false)
@@ -311,7 +311,7 @@ describe PgSearch::Multisearch::Rebuilder do
             expect(record_1.pg_search_document).to be_present
             expect(record_2.pg_search_document).not_to be_present
           end
-          # rubocop:enable RSpec/ExampleLength
+          # standard:enable RSpec/ExampleLength
         end
 
         context "via :unless" do
@@ -326,7 +326,7 @@ describe PgSearch::Multisearch::Rebuilder do
             end
           end
 
-          # rubocop:disable RSpec/ExampleLength
+          # standard:disable RSpec/ExampleLength
           it "calls update_pg_search_document on each record" do
             record_1 = Model.create!(inactive: true)
             record_2 = Model.create!(inactive: false)
@@ -352,10 +352,10 @@ describe PgSearch::Multisearch::Rebuilder do
             expect(record_1.pg_search_document).not_to be_present
             expect(record_2.pg_search_document).to be_present
           end
-          # rubocop:enable RSpec/ExampleLength
+          # standard:enable RSpec/ExampleLength
         end
       end
     end
   end
 end
-# rubocop:enable RSpec/NestedGroups
+# standard:enable RSpec/NestedGroups

data/spec/lib/pg_search/multisearch_spec.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require "spec_helper"
-require "active_support/deprecation"
+require "active_support/core_ext/kernel/reporting"
 
-# rubocop:disable RSpec/NestedGroups
+# standard:disable RSpec/NestedGroups
 describe PgSearch::Multisearch do
   with_table "pg_search_documents", &DOCUMENTS_SCHEMA
 
@@ -33,6 +33,15 @@ describe PgSearch::Multisearch do
       expect(model).to have_received(:transaction).once
     end
 
+    context "when transactional is false" do
+      it "does not operate inside a transaction" do
+        allow(model).to receive(:transaction)
+
+        described_class.rebuild(model, transactional: false)
+        expect(model).not_to have_received(:transaction)
+      end
+    end
+
     describe "cleaning up search documents for this model" do
       before do
         connection.execute <<~SQL.squish
@@ -73,7 +82,7 @@ describe PgSearch::Multisearch do
 
       context "when deprecated_clean_up is true" do
         it "deletes the document for the model" do
-          ActiveSupport::Deprecation.silence { described_class.rebuild(model, true) }
+          silence_warnings { described_class.rebuild(model, true) }
           expect(PgSearch::Document.count).to eq(1)
           expect(PgSearch::Document.first.searchable_type).to eq("Bar")
         end
@@ -81,7 +90,7 @@ describe PgSearch::Multisearch do
 
       context "when deprecated_clean_up is false" do
         it "does not delete the document for the model" do
-          ActiveSupport::Deprecation.silence { described_class.rebuild(model, false) }
+          silence_warnings { described_class.rebuild(model, false) }
           expect(PgSearch::Document.count).to eq(2)
         end
       end
@@ -126,7 +135,7 @@ describe PgSearch::Multisearch do
     end
 
     describe "the generated SQL" do
-      let(:now) { Time.now }
+      let(:now) { Time.now } # standard:disable Rails/TimeZone
 
       before { allow(Time).to receive(:now).and_return(now) }
 
@@ -186,4 +195,4 @@ describe PgSearch::Multisearch do
     end
   end
 end
-# rubocop:enable RSpec/NestedGroups
+# standard:enable RSpec/NestedGroups

data/spec/lib/pg_search/multisearchable_spec.rb

@@ -2,7 +2,7 @@
 
 require "spec_helper"
 
-# rubocop:disable RSpec/NestedGroups
+# standard:disable RSpec/NestedGroups
 describe PgSearch::Multisearchable do
   with_table "pg_search_documents", &DOCUMENTS_SCHEMA
 
@@ -36,7 +36,7 @@ describe PgSearch::Multisearchable do
         belongs_to :multisearchable_parent
 
         after_destroy do
-          multisearchable_parent.update_attribute(:secret, rand(1000).to_s) # rubocop:disable Rails/SkipsModelValidations
+          multisearchable_parent.update_attribute(:secret, rand(1000).to_s)
         end
       end
     end
@@ -149,17 +149,17 @@ describe PgSearch::Multisearchable do
       end
 
       context "when searching against a single column" do
-        let(:multisearchable_options) { { against: :some_content } }
+        let(:multisearchable_options) { {against: :some_content} }
         let(:text) { "foo bar" }
 
         before do
           without_partial_double_verification do
             allow(record).to receive(:some_content) { text }
           end
-          record.save
+          record.save!
         end
 
-        describe '#content' do
+        describe "#content" do
           subject { super().pg_search_document.content }
 
           it { is_expected.to eq(text) }
@@ -167,17 +167,17 @@ describe PgSearch::Multisearchable do
       end
 
       context "when searching against multiple columns" do
-        let(:multisearchable_options) { { against: %i[attr_1 attr_2] } }
+        let(:multisearchable_options) { {against: %i[attr_1 attr_2]} }
 
         before do
           without_partial_double_verification do
-            allow(record).to receive(:attr_1).and_return('1')
-            allow(record).to receive(:attr_2).and_return('2')
+            allow(record).to receive(:attr_1).and_return("1")
+            allow(record).to receive(:attr_2).and_return("2")
           end
-          record.save
+          record.save!
         end
 
-        describe '#content' do
+        describe "#content" do
           subject { super().pg_search_document.content }
 
           it { is_expected.to eq("1 2") }
@@ -195,17 +195,17 @@ describe PgSearch::Multisearchable do
       end
 
       context "when searching against a single column" do
-        let(:multisearchable_options) { { against: :some_content } }
+        let(:multisearchable_options) { {against: :some_content} }
         let(:text) { "foo bar" }
 
         before do
           without_partial_double_verification do
             allow(record).to receive(:some_content) { text }
           end
-          record.save
+          record.save!
         end
 
-        describe '#content' do
+        describe "#content" do
           subject { super().pg_search_document.content }
 
           it { is_expected.to eq(text) }
@@ -213,17 +213,17 @@ describe PgSearch::Multisearchable do
       end
 
       context "when searching against multiple columns" do
-        let(:multisearchable_options) { { against: %i[attr_1 attr_2] } }
+        let(:multisearchable_options) { {against: %i[attr_1 attr_2]} }
 
         before do
           without_partial_double_verification do
-            allow(record).to receive(:attr_1).and_return('1')
-            allow(record).to receive(:attr_2).and_return('2')
+            allow(record).to receive(:attr_1).and_return("1")
+            allow(record).to receive(:attr_2).and_return("2")
           end
-          record.save
+          record.save!
         end
 
-        describe '#content' do
+        describe "#content" do
           subject { super().pg_search_document.content }
 
           it { is_expected.to eq("1 2") }
@@ -234,7 +234,7 @@ describe PgSearch::Multisearchable do
         let(:multisearchable_options) do
           {
             additional_attributes: lambda do |record|
-              { foo: record.bar }
+              {foo: record.bar}
             end
           }
         end
@@ -244,10 +244,10 @@ describe PgSearch::Multisearchable do
           without_partial_double_verification do
             allow(record).to receive(:bar).and_return(text)
             allow(record).to receive(:create_pg_search_document)
-            record.save
+            record.save!
             expect(record)
               .to have_received(:create_pg_search_document)
-              .with(content: '', foo: text)
+              .with(content: "", foo: text)
           end
         end
       end
@@ -266,10 +266,10 @@ describe PgSearch::Multisearchable do
           without_partial_double_verification do
             allow(record).to receive(:bar?).and_return(false)
             allow(record).to receive(:create_pg_search_document)
-            record.save
+            record.save!
             expect(record)
               .to have_received(:create_pg_search_document)
-              .with(content: '')
+              .with(content: "")
           end
         end
 
@@ -286,7 +286,7 @@ describe PgSearch::Multisearchable do
             it "does not update the document" do
               without_partial_double_verification do
                 allow(record.pg_search_document).to receive(:update)
-                record.save
+                record.save!
                 expect(record.pg_search_document).not_to have_received(:update)
               end
             end
@@ -301,7 +301,7 @@ describe PgSearch::Multisearchable do
 
             it "updates the document" do
               allow(record.pg_search_document).to receive(:update)
-              record.save
+              record.save!
               expect(record.pg_search_document).to have_received(:update)
             end
           end
@@ -854,4 +854,4 @@ describe PgSearch::Multisearchable do
     end
   end
 end
-# rubocop:enable RSpec/NestedGroups
+# standard:enable RSpec/NestedGroups

data/spec/lib/pg_search/normalizer_spec.rb

@@ -2,13 +2,13 @@
 
 require "spec_helper"
 
-# rubocop:disable RSpec/NestedGroups
+# standard:disable RSpec/NestedGroups
 describe PgSearch::Normalizer do
   describe "#add_normalization" do
     context "when config[:ignore] includes :accents" do
       context "when passed an Arel node" do
         it "wraps the expression in unaccent()" do
-          config = instance_double("PgSearch::Configuration", "config", ignore: [:accents])
+          config = instance_double(PgSearch::Configuration, "config", ignore: [:accents])
           node = Arel::Nodes::NamedFunction.new("foo", [Arel::Nodes.build_quoted("bar")])
 
           normalizer = described_class.new(config)
@@ -20,7 +20,7 @@ describe PgSearch::Normalizer do
             allow(PgSearch).to receive(:unaccent_function).and_return("my_unaccent")
             node = Arel::Nodes::NamedFunction.new("foo", [Arel::Nodes.build_quoted("bar")])
 
-            config = instance_double("PgSearch::Configuration", "config", ignore: [:accents])
+            config = instance_double(PgSearch::Configuration, "config", ignore: [:accents])
 
             normalizer = described_class.new(config)
             expect(normalizer.add_normalization(node)).to eq("my_unaccent(foo('bar'))")
@@ -30,7 +30,7 @@ describe PgSearch::Normalizer do
 
       context "when passed a String" do
         it "wraps the expression in unaccent()" do
-          config = instance_double("PgSearch::Configuration", "config", ignore: [:accents])
+          config = instance_double(PgSearch::Configuration, "config", ignore: [:accents])
 
           normalizer = described_class.new(config)
           expect(normalizer.add_normalization("foo")).to eq("unaccent(foo)")
@@ -40,7 +40,7 @@ describe PgSearch::Normalizer do
           it "wraps the expression in that function" do
             allow(PgSearch).to receive(:unaccent_function).and_return("my_unaccent")
 
-            config = instance_double("PgSearch::Configuration", "config", ignore: [:accents])
+            config = instance_double(PgSearch::Configuration, "config", ignore: [:accents])
 
             normalizer = described_class.new(config)
             expect(normalizer.add_normalization("foo")).to eq("my_unaccent(foo)")
@@ -51,7 +51,7 @@ describe PgSearch::Normalizer do
 
     context "when config[:ignore] does not include :accents" do
       it "passes the expression through" do
-        config = instance_double("PgSearch::Configuration", "config", ignore: [])
+        config = instance_double(PgSearch::Configuration, "config", ignore: [])
 
         normalizer = described_class.new(config)
         expect(normalizer.add_normalization("foo")).to eq("foo")
@@ -59,4 +59,4 @@ describe PgSearch::Normalizer do
     end
   end
 end
-# rubocop:enable RSpec/NestedGroups
+# standard:enable RSpec/NestedGroups

data/spec/lib/pg_search_spec.rb

@@ -2,9 +2,9 @@
 
 require "spec_helper"
 
-# For Active Record 5.x and 6.0, the association reflection's cache needs be cleared
+# For Active Record 5.x, the association reflection's cache needs be cleared
 # because we're stubbing the related constants.
-if ActiveRecord::VERSION::MAJOR == 5 || (ActiveRecord::VERSION::MAJOR == 6 && ActiveRecord::VERSION::MINOR == 0)
+if ActiveRecord::VERSION::MAJOR == 5
   def clear_searchable_cache
     PgSearch::Document.reflect_on_association(:searchable).clear_association_scope_cache
   end
@@ -13,7 +13,7 @@ else
   end
 end
 
-# rubocop:disable RSpec/NestedGroups
+# standard:disable RSpec/NestedGroups
 describe PgSearch do
   describe ".multisearch" do
     with_table "pg_search_documents", &DOCUMENTS_SCHEMA
@@ -21,8 +21,8 @@ describe PgSearch do
     describe "delegation to PgSearch::Document.search" do
       subject { described_class.multisearch(query) }
 
-      let(:query) { instance_double("String", "query") }
-      let(:relation) { instance_double("ActiveRecord::Relation", "relation") }
+      let(:query) { instance_double(String, "query") }
+      let(:relation) { instance_double(ActiveRecord::Relation, "relation") }
 
       before do
         allow(PgSearch::Document).to receive(:search).with(query).and_return(relation)
@@ -49,7 +49,7 @@ describe PgSearch do
         end
       end
 
-      let!(:soundalike_record) { MultisearchableModel.create!(title: 'foning') }
+      let!(:soundalike_record) { MultisearchableModel.create!(title: "foning") }
       let(:query) { "Phoning" }
 
       it { is_expected.to include(soundalike_record) }
@@ -65,9 +65,9 @@ describe PgSearch do
         allow(described_class).to receive(:multisearch_options) do
           lambda do |query, soundalike|
             if soundalike
-              { using: :dmetaphone, query: query }
+              {using: :dmetaphone, query: query}
             else
-              { query: query }
+              {query: query}
             end
           end
         end
@@ -83,7 +83,7 @@ describe PgSearch do
         end
       end
 
-      let!(:soundalike_record) { MultisearchableModel.create!(title: 'foning') }
+      let!(:soundalike_record) { MultisearchableModel.create!(title: "foning") }
       let(:query) { "Phoning" }
 
       context "with soundalike true" do
@@ -103,8 +103,8 @@ describe PgSearch do
       context "with standard type column" do
         with_model :SuperclassModel do
           table do |t|
-            t.text 'content'
-            t.string 'type'
+            t.text "content"
+            t.string "type"
           end
         end
 
@@ -149,7 +149,7 @@ describe PgSearch do
           expect(results.size).to eq(SearchableSubclassModel.count)
         end
 
-        # rubocop:disable RSpec/MultipleExpectations
+        # standard:disable RSpec/MultipleExpectations
         specify "reindexing works" do
           NonSearchableSubclassModel.create!(content: "foo bar")
           NonSearchableSubclassModel.create!(content: "baz")
@@ -171,7 +171,7 @@ describe PgSearch do
           expect(PgSearch::Document.first.searchable.class).to be SearchableSubclassModel
           expect(PgSearch::Document.first.searchable).to eq expected
         end
-        # rubocop:enable RSpec/MultipleExpectations
+        # standard:enable RSpec/MultipleExpectations
 
         it "reindexing searchable STI doesn't clobber other related STI models" do
           SearchableSubclassModel.create!(content: "baz")
@@ -191,12 +191,12 @@ describe PgSearch do
       context "with custom type column" do
         with_model :SuperclassModel do
           table do |t|
-            t.text 'content'
-            t.string 'inherit'
+            t.text "content"
+            t.string "inherit"
           end
 
           model do
-            self.inheritance_column = 'inherit'
+            self.inheritance_column = "inherit"
           end
         end
 
@@ -254,7 +254,7 @@ describe PgSearch do
           multisearch_enabled_inside = described_class.multisearch_enabled?
           raise
         end
-      rescue StandardError
+      rescue
       end
       multisearch_enabled_after = described_class.multisearch_enabled?
 
@@ -263,7 +263,7 @@ describe PgSearch do
       expect(multisearch_enabled_after).to be(true)
     end
 
-    # rubocop:disable RSpec/ExampleLength
+    # standard:disable RSpec/ExampleLength
     it "does not disable multisearch on other threads" do
       values = Queue.new
       sync = Queue.new
@@ -288,7 +288,7 @@ describe PgSearch do
       expect(multisearch_enabled_inside).to be(true)
       expect(multisearch_enabled_after).to be(true)
     end
-    # rubocop:enable RSpec/ExampleLength
+    # standard:enable RSpec/ExampleLength
   end
 end
-# rubocop:enable RSpec/NestedGroups
+# standard:enable RSpec/NestedGroups

data/spec/spec_helper.rb

@@ -1,11 +1,17 @@
 # frozen_string_literal: true
 
-require 'warning'
-# Ignore Ruby 2.7 warnings from Active Record
-Warning.ignore :keyword_separation
-
-require 'simplecov'
-SimpleCov.start
+require "warning"
+
+# https://github.com/grodowski/undercover#setting-up-required-lcov-reporting
+require "simplecov"
+require "simplecov-lcov"
+SimpleCov::Formatter::LcovFormatter.config.report_with_single_file = true
+SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
+SimpleCov.start do
+  add_filter(%r{^/spec/})
+  enable_coverage(:branch)
+end
+require "undercover"
 
 require "bundler/setup"
 require "pg_search"
@@ -21,11 +27,11 @@ RSpec.configure do |config|
     mocks.verify_partial_doubles = true
   end
 
-  config.example_status_persistence_file_path = 'tmp/examples.txt'
+  config.example_status_persistence_file_path = "tmp/examples.txt"
 end
 
-require 'support/database'
-require 'support/with_model'
+require "support/database"
+require "support/with_model"
 
 DOCUMENTS_SCHEMA = lambda do |t|
   t.belongs_to :searchable, polymorphic: true, index: true

data/spec/support/database.rb

@@ -10,10 +10,12 @@ else
 end
 
 begin
-  ActiveRecord::Base.establish_connection(adapter: 'postgresql',
-                                          database: 'pg_search_test',
-                                          username: (ENV["TRAVIS"] ? "postgres" : ENV["USER"]),
-                                          min_messages: 'warning')
+  connection_options = {adapter: "postgresql", database: "pg_search_test", min_messages: "warning"}
+  if ENV["CI"]
+    connection_options[:username] = "postgres"
+    connection_options[:password] = "postgres"
+  end
+  ActiveRecord::Base.establish_connection(connection_options)
   connection = ActiveRecord::Base.connection
   connection.execute("SELECT 1")
 rescue ERROR_CLASS, ActiveRecord::NoDatabaseError => e
@@ -38,7 +40,7 @@ def install_extension(name)
   return unless extension.none?
 
   connection.execute "CREATE EXTENSION #{name};"
-rescue StandardError => e
+rescue => e
   at_exit do
     puts "-" * 80
     puts "Please install the #{name} extension"
@@ -50,7 +52,7 @@ end
 def install_extension_if_missing(name, query, expected_result)
   result = ActiveRecord::Base.connection.select_value(query)
   raise "Unexpected output for #{query}: #{result.inspect}" unless result.casecmp(expected_result).zero?
-rescue StandardError
+rescue
   install_extension(name)
 end
 
@@ -60,7 +62,7 @@ install_extension_if_missing("fuzzystrmatch", "SELECT dmetaphone('foo')", "f")
 
 def load_sql(filename)
   connection = ActiveRecord::Base.connection
-  file_contents = File.read(File.join(File.dirname(__FILE__), '..', '..', 'sql', filename))
+  file_contents = File.read(File.join(File.dirname(__FILE__), "..", "..", "sql", filename))
   connection.execute(file_contents)
 end