pg_search 2.3.0 → 2.3.6

data/spec/lib/pg_search/normalizer_spec.rb

@@ -2,15 +2,16 @@
 
 require "spec_helper"
 
+# rubocop: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 = double("config", ignore: [:accents])
+          config = instance_double("PgSearch::Configuration", "config", ignore: [:accents])
           node = Arel::Nodes::NamedFunction.new("foo", [Arel::Nodes.build_quoted("bar")])
 
-          normalizer = PgSearch::Normalizer.new(config)
+          normalizer = described_class.new(config)
           expect(normalizer.add_normalization(node)).to eq("unaccent(foo('bar'))")
         end
 
@@ -19,9 +20,9 @@ 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 = double("config", ignore: [:accents])
+            config = instance_double("PgSearch::Configuration", "config", ignore: [:accents])
 
-            normalizer = PgSearch::Normalizer.new(config)
+            normalizer = described_class.new(config)
             expect(normalizer.add_normalization(node)).to eq("my_unaccent(foo('bar'))")
           end
         end
@@ -29,9 +30,9 @@ describe PgSearch::Normalizer do
 
       context "when passed a String" do
         it "wraps the expression in unaccent()" do
-          config = double("config", ignore: [:accents])
+          config = instance_double("PgSearch::Configuration", "config", ignore: [:accents])
 
-          normalizer = PgSearch::Normalizer.new(config)
+          normalizer = described_class.new(config)
           expect(normalizer.add_normalization("foo")).to eq("unaccent(foo)")
         end
 
@@ -39,9 +40,9 @@ describe PgSearch::Normalizer do
           it "wraps the expression in that function" do
             allow(PgSearch).to receive(:unaccent_function).and_return("my_unaccent")
 
-            config = double("config", ignore: [:accents])
+            config = instance_double("PgSearch::Configuration", "config", ignore: [:accents])
 
-            normalizer = PgSearch::Normalizer.new(config)
+            normalizer = described_class.new(config)
             expect(normalizer.add_normalization("foo")).to eq("my_unaccent(foo)")
           end
         end
@@ -50,11 +51,12 @@ describe PgSearch::Normalizer do
 
     context "when config[:ignore] does not include :accents" do
       it "passes the expression through" do
-        config = double("config", ignore: [])
+        config = instance_double("PgSearch::Configuration", "config", ignore: [])
 
-        normalizer = PgSearch::Normalizer.new(config)
+        normalizer = described_class.new(config)
         expect(normalizer.add_normalization("foo")).to eq("foo")
       end
     end
   end
 end
+# rubocop:enable RSpec/NestedGroups

data/spec/lib/pg_search_spec.rb

@@ -2,42 +2,43 @@
 
 require "spec_helper"
 
-# For AR 5 and greater, 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.
-class << PgSearch::Document
-  if ActiveRecord::VERSION::MAJOR >= 5
-    def clear_searchable_cache
-      reflect_on_association(:searchable).clear_association_scope_cache
-    end
-  else
-    def clear_searchable_cache
-    end
+if ActiveRecord::VERSION::MAJOR == 5
+  def clear_searchable_cache
+    PgSearch::Document.reflect_on_association(:searchable).clear_association_scope_cache
+  end
+else
+  def clear_searchable_cache
   end
 end
 
+# rubocop:disable RSpec/NestedGroups
 describe PgSearch do
   describe ".multisearch" do
-    with_table "pg_search_documents", {}, &DOCUMENTS_SCHEMA
+    with_table "pg_search_documents", &DOCUMENTS_SCHEMA
 
     describe "delegation to PgSearch::Document.search" do
-      subject { PgSearch.multisearch(query) }
+      subject { described_class.multisearch(query) }
+
+      let(:query) { instance_double("String", "query") }
+      let(:relation) { instance_double("ActiveRecord::Relation", "relation") }
 
-      let(:query) { double(:query) }
-      let(:relation) { double(:relation) }
       before do
-        expect(PgSearch::Document).to receive(:search).with(query).and_return(relation)
+        allow(PgSearch::Document).to receive(:search).with(query).and_return(relation)
       end
 
       it { is_expected.to eq(relation) }
     end
 
     context "with PgSearch.multisearch_options set to a Hash" do
-      before { allow(PgSearch).to receive(:multisearch_options).and_return(using: :dmetaphone) }
       subject do
-        PgSearch::Document.clear_searchable_cache
-        PgSearch.multisearch(query).map(&:searchable)
+        clear_searchable_cache
+        described_class.multisearch(query).map(&:searchable)
       end
 
+      before { allow(described_class).to receive(:multisearch_options).and_return(using: :dmetaphone) }
+
       with_model :MultisearchableModel do
         table do |t|
           t.string :title
@@ -50,17 +51,18 @@ describe PgSearch do
 
       let!(:soundalike_record) { MultisearchableModel.create!(title: 'foning') }
       let(:query) { "Phoning" }
+
       it { is_expected.to include(soundalike_record) }
     end
 
     context "with PgSearch.multisearch_options set to a Proc" do
       subject do
-        PgSearch::Document.clear_searchable_cache
-        PgSearch.multisearch(query, soundalike).map(&:searchable)
+        clear_searchable_cache
+        described_class.multisearch(query, soundalike).map(&:searchable)
       end
 
       before do
-        allow(PgSearch).to receive(:multisearch_options) do
+        allow(described_class).to receive(:multisearch_options) do
           lambda do |query, soundalike|
             if soundalike
               { using: :dmetaphone, query: query }
@@ -86,16 +88,18 @@ describe PgSearch do
 
       context "with soundalike true" do
         let(:soundalike) { true }
+
         it { is_expected.to include(soundalike_record) }
       end
 
       context "with soundalike false" do
         let(:soundalike) { false }
+
         it { is_expected.not_to include(soundalike_record) }
       end
     end
 
-    context "on an STI subclass" do
+    context "when on an STI subclass" do
       context "with standard type column" do
         with_model :SuperclassModel do
           table do |t|
@@ -128,7 +132,7 @@ describe PgSearch do
 
           expect(PgSearch::Document.count).to be 2
 
-          results = PgSearch.multisearch("foo bar")
+          results = described_class.multisearch("foo bar")
 
           expect(results).to eq [included.pg_search_document]
         end
@@ -141,11 +145,12 @@ describe PgSearch do
           model = SearchableSubclassModel.find(model.id)
           model.content = "foo"
           model.save!
-          results = PgSearch.multisearch("foo")
+          results = described_class.multisearch("foo")
           expect(results.size).to eq(SearchableSubclassModel.count)
         end
 
-        it "reindexing works" do
+        # rubocop:disable RSpec/MultipleExpectations
+        specify "reindexing works" do
           NonSearchableSubclassModel.create!(content: "foo bar")
           NonSearchableSubclassModel.create!(content: "baz")
           expected = SearchableSubclassModel.create!(content: "baz")
@@ -161,11 +166,12 @@ describe PgSearch do
 
           PgSearch::Multisearch.rebuild(SearchableSubclassModel)
 
-          PgSearch::Document.clear_searchable_cache
+          clear_searchable_cache
           expect(PgSearch::Document.count).to be 1
           expect(PgSearch::Document.first.searchable.class).to be SearchableSubclassModel
           expect(PgSearch::Document.first.searchable).to eq expected
         end
+        # rubocop:enable RSpec/MultipleExpectations
 
         it "reindexing searchable STI doesn't clobber other related STI models" do
           SearchableSubclassModel.create!(content: "baz")
@@ -175,7 +181,7 @@ describe PgSearch do
           PgSearch::Multisearch.rebuild(SearchableSubclassModel)
           expect(PgSearch::Document.count).to be 2
 
-          PgSearch::Document.clear_searchable_cache
+          clear_searchable_cache
           classes = PgSearch::Document.all.collect { |d| d.searchable.class }
           expect(classes).to include SearchableSubclassModel
           expect(classes).to include AnotherSearchableSubclassModel
@@ -218,7 +224,7 @@ describe PgSearch do
 
           expect(PgSearch::Document.count).to be 2
 
-          results = PgSearch.multisearch("foo bar")
+          results = described_class.multisearch("foo bar")
 
           expect(results).to eq [included.pg_search_document]
         end
@@ -227,57 +233,62 @@ describe PgSearch do
   end
 
   describe ".disable_multisearch" do
-    it "should temporarily disable multisearch" do
-      @multisearch_enabled_before = PgSearch.multisearch_enabled?
-      PgSearch.disable_multisearch do
-        @multisearch_enabled_inside = PgSearch.multisearch_enabled?
+    it "disables multisearch temporarily" do
+      multisearch_enabled_before = described_class.multisearch_enabled?
+      multisearch_enabled_inside = nil
+      described_class.disable_multisearch do
+        multisearch_enabled_inside = described_class.multisearch_enabled?
       end
-      @multisearch_enabled_after = PgSearch.multisearch_enabled?
+      multisearch_enabled_after = described_class.multisearch_enabled?
 
-      expect(@multisearch_enabled_before).to be(true)
-      expect(@multisearch_enabled_inside).to be(false)
-      expect(@multisearch_enabled_after).to be(true)
+      expect(multisearch_enabled_before).to be(true)
+      expect(multisearch_enabled_inside).to be(false)
+      expect(multisearch_enabled_after).to be(true)
     end
 
-    it "should reenable multisearch after an error" do
-      @multisearch_enabled_before = PgSearch.multisearch_enabled?
+    it "reenables multisearch after an error" do
+      multisearch_enabled_before = described_class.multisearch_enabled?
+      multisearch_enabled_inside = nil
       begin
-        PgSearch.disable_multisearch do
-          @multisearch_enabled_inside = PgSearch.multisearch_enabled?
+        described_class.disable_multisearch do
+          multisearch_enabled_inside = described_class.multisearch_enabled?
           raise
         end
       rescue StandardError
       end
+      multisearch_enabled_after = described_class.multisearch_enabled?
 
-      @multisearch_enabled_after = PgSearch.multisearch_enabled?
-
-      expect(@multisearch_enabled_before).to be(true)
-      expect(@multisearch_enabled_inside).to be(false)
-      expect(@multisearch_enabled_after).to be(true)
+      expect(multisearch_enabled_before).to be(true)
+      expect(multisearch_enabled_inside).to be(false)
+      expect(multisearch_enabled_after).to be(true)
     end
 
-    it "should not disable multisearch on other threads" do
+    # rubocop:disable RSpec/ExampleLength
+    it "does not disable multisearch on other threads" do
       values = Queue.new
       sync = Queue.new
       Thread.new do
-        values.push PgSearch.multisearch_enabled?
+        values.push described_class.multisearch_enabled?
         sync.pop # wait
-        values.push PgSearch.multisearch_enabled?
+        values.push described_class.multisearch_enabled?
         sync.pop # wait
-        values.push PgSearch.multisearch_enabled?
+        values.push described_class.multisearch_enabled?
       end
 
-      @multisearch_enabled_before = values.pop
-      PgSearch.disable_multisearch do
+      multisearch_enabled_before = values.pop
+      multisearch_enabled_inside = nil
+      described_class.disable_multisearch do
         sync.push :go
-        @multisearch_enabled_inside = values.pop
+        multisearch_enabled_inside = values.pop
       end
       sync.push :go
-      @multisearch_enabled_after = values.pop
+      multisearch_enabled_after = values.pop
 
-      expect(@multisearch_enabled_before).to be(true)
-      expect(@multisearch_enabled_inside).to be(true)
-      expect(@multisearch_enabled_after).to be(true)
+      expect(multisearch_enabled_before).to be(true)
+      expect(multisearch_enabled_inside).to be(true)
+      expect(multisearch_enabled_after).to be(true)
     end
+    # rubocop:enable RSpec/ExampleLength
   end
 end
+# rubocop:enable RSpec/NestedGroups

data/spec/spec_helper.rb

@@ -1,18 +1,32 @@
 # frozen_string_literal: true
 
+require 'warning'
+# Ignore Ruby 2.7 warnings from Active Record
+Warning.ignore :keyword_separation
+
+# https://github.com/grodowski/undercover#setting-up-required-lcov-reporting
 require 'simplecov'
-SimpleCov.start
+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"
 
 RSpec.configure do |config|
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
+  config.expect_with :rspec do |expects|
+    expects.syntax = :expect
   end
 
-  config.mock_with :rspec do |c|
-    c.syntax = :expect
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_doubled_constant_names = true
+    mocks.verify_partial_doubles = true
   end
 
   config.example_status_persistence_file_path = 'tmp/examples.txt'
@@ -25,4 +39,7 @@ DOCUMENTS_SCHEMA = lambda do |t|
   t.belongs_to :searchable, polymorphic: true, index: true
   t.text :content
   t.timestamps null: false
+
+  # Used to test additional_attributes setup
+  t.text :additional_attribute_column
 end

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
@@ -29,7 +31,7 @@ end
 
 if ENV["LOGGER"]
   require "logger"
-  ActiveRecord::Base.logger = Logger.new(STDOUT)
+  ActiveRecord::Base.logger = Logger.new($stdout)
 end
 
 def install_extension(name)

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: pg_search
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.6
 platform: ruby
 authors:
 - Grant Hutchins
 - Case Commons, LLC
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-13 00:00:00.000000000 Z
+date: 2022-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -73,28 +73,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.68.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.68.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +109,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -123,20 +165,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: undercover
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: warning
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: with_model
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
 description: PgSearch builds Active Record named scopes that take advantage of PostgreSQL's
   full text search
 email:
@@ -146,15 +230,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".autotest"
 - ".bundle/config"
 - ".codeclimate.yml"
 - ".editorconfig"
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".jrubyrc"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
@@ -187,6 +274,7 @@ files:
 - lib/pg_search/version.rb
 - pg_search.gemspec
 - spec/.rubocop.yml
+- spec/integration/.rubocop.yml
 - spec/integration/associations_spec.rb
 - spec/integration/deprecation_spec.rb
 - spec/integration/pagination_spec.rb
@@ -211,8 +299,9 @@ files:
 homepage: https://github.com/Casecommons/pg_search
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -220,19 +309,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: PgSearch builds Active Record named scopes that take advantage of PostgreSQL's
   full text search
 test_files:
+- spec/integration/.rubocop.yml
 - spec/integration/associations_spec.rb
 - spec/integration/deprecation_spec.rb
 - spec/integration/pagination_spec.rb

data/.autotest

@@ -1,5 +0,0 @@
-Autotest.add_hook :initialize do |at|
-  at.add_mapping(%r%^lib/.*\.rb$%, true) { |filename, _|
-    at.files_matching %r%^spec/.*_spec.rb$%
-  }
-end