pg_search 2.1.2 → 2.2.0

data/spec/lib/pg_search/multisearchable_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe PgSearch::Multisearchable do
@@ -11,6 +13,33 @@ describe PgSearch::Multisearchable do
       end
     end
 
+    with_model :MultisearchableParent do
+      table do |t|
+        t.string :secret
+      end
+
+      model do
+        include PgSearch
+        multisearchable
+
+        has_many :multisearchable_children, dependent: :destroy
+      end
+    end
+
+    with_model :MultisearchableChild do
+      table do |t|
+        t.belongs_to :multisearchable_parent, index: false
+      end
+
+      model do
+        belongs_to :multisearchable_parent
+
+        after_destroy do
+          multisearchable_parent.update_attribute(:secret, rand(1000).to_s)
+        end
+      end
+    end
+
     describe "callbacks" do
       describe "after_create" do
         let(:record) { ModelThatIsMultisearchable.new }
@@ -92,6 +121,18 @@ describe PgSearch::Multisearchable do
           expect { record.destroy }.to change(PgSearch::Document, :count).by(-1)
           expect { PgSearch::Document.find(document.id) }.to raise_error(ActiveRecord::RecordNotFound)
         end
+
+        it "should remove its document in case of complex associations" do
+          parent = MultisearchableParent.create!
+
+          MultisearchableChild.create!(multisearchable_parent: parent)
+          MultisearchableChild.create!(multisearchable_parent: parent)
+
+          document = parent.pg_search_document
+
+          expect { parent.destroy }.to change(PgSearch::Document, :count).by(-1)
+          expect { PgSearch::Document.find(document.id) }.to raise_error(ActiveRecord::RecordNotFound)
+        end
       end
     end
 
@@ -104,7 +145,7 @@ 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
           allow(record).to receive(:some_content) { text }
@@ -118,7 +159,7 @@ describe PgSearch::Multisearchable do
       end
 
       context "when searching against multiple columns" do
-        let(:multisearchable_options) { {:against => %i[attr1 attr2]} }
+        let(:multisearchable_options) { { against: %i[attr1 attr2] } }
         before do
           allow(record).to receive(:attr1) { '1' }
           allow(record).to receive(:attr2) { '2' }
@@ -141,7 +182,7 @@ 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
           allow(record).to receive(:some_content) { text }
@@ -155,7 +196,7 @@ describe PgSearch::Multisearchable do
       end
 
       context "when searching against multiple columns" do
-        let(:multisearchable_options) { {:against => %i[attr1 attr2]} }
+        let(:multisearchable_options) { { against: %i[attr1 attr2] } }
         before do
           allow(record).to receive(:attr1) { '1' }
           allow(record).to receive(:attr2) { '2' }
@@ -171,7 +212,7 @@ describe PgSearch::Multisearchable do
       context "with additional_attributes" do
         let(:multisearchable_options) do
           {
-            :additional_attributes => lambda do |record|
+            additional_attributes: lambda do |record|
               { foo: record.bar }
             end
           }
@@ -190,7 +231,7 @@ describe PgSearch::Multisearchable do
       context "when selectively updating" do
         let(:multisearchable_options) do
           {
-            :update_if => lambda do |record|
+            update_if: lambda do |record|
               record.bar?
             end
           }
@@ -215,7 +256,7 @@ describe PgSearch::Multisearchable do
 
             it "does not update the document" do
               expect_any_instance_of(PgSearch::Document)
-                .to_not receive(:update_attributes)
+                .to_not receive(:update)
 
               record.save
             end
@@ -228,7 +269,7 @@ describe PgSearch::Multisearchable do
 
             it "updates the document" do
               expect_any_instance_of(PgSearch::Document)
-                .to receive(:update_attributes)
+                .to receive(:update)
 
               record.save
             end
@@ -247,7 +288,7 @@ describe PgSearch::Multisearchable do
 
         model do
           include PgSearch
-          multisearchable :if => ->(record) { record.multisearchable? }
+          multisearchable if: ->(record) { record.multisearchable? }
         end
       end
 
@@ -255,7 +296,7 @@ describe PgSearch::Multisearchable do
         describe "after_create" do
           describe "saving the record" do
             context "when the condition is true" do
-              let(:record) { ModelThatIsMultisearchable.new(:multisearchable => true) }
+              let(:record) { ModelThatIsMultisearchable.new(multisearchable: true) }
 
               it "should create a PgSearch::Document record" do
                 expect { record.save! }.to change(PgSearch::Document, :count).by(1)
@@ -271,7 +312,7 @@ describe PgSearch::Multisearchable do
             end
 
             context "when the condition is false" do
-              let(:record) { ModelThatIsMultisearchable.new(:multisearchable => false) }
+              let(:record) { ModelThatIsMultisearchable.new(multisearchable: false) }
 
               it "should not create a PgSearch::Document record" do
                 expect { record.save! }.not_to change(PgSearch::Document, :count)
@@ -281,7 +322,7 @@ describe PgSearch::Multisearchable do
         end
 
         describe "after_update" do
-          let(:record) { ModelThatIsMultisearchable.create!(:multisearchable => true) }
+          let(:record) { ModelThatIsMultisearchable.create!(multisearchable: true) }
 
           context "when the document is present" do
             before { expect(record.pg_search_document).to be_present }
@@ -356,7 +397,7 @@ describe PgSearch::Multisearchable do
         end
 
         describe "after_destroy" do
-          let(:record) { ModelThatIsMultisearchable.create!(:multisearchable => true) }
+          let(:record) { ModelThatIsMultisearchable.create!(multisearchable: true) }
 
           it "should remove its document" do
             document = record.pg_search_document
@@ -375,7 +416,7 @@ describe PgSearch::Multisearchable do
 
         model do
           include PgSearch
-          multisearchable :unless => ->(record) { record.not_multisearchable? }
+          multisearchable unless: ->(record) { record.not_multisearchable? }
         end
       end
 
@@ -383,7 +424,7 @@ describe PgSearch::Multisearchable do
         describe "after_create" do
           describe "saving the record" do
             context "when the condition is false" do
-              let(:record) { ModelThatIsMultisearchable.new(:not_multisearchable => false) }
+              let(:record) { ModelThatIsMultisearchable.new(not_multisearchable: false) }
 
               it "should create a PgSearch::Document record" do
                 expect { record.save! }.to change(PgSearch::Document, :count).by(1)
@@ -399,7 +440,7 @@ describe PgSearch::Multisearchable do
             end
 
             context "when the condition is true" do
-              let(:record) { ModelThatIsMultisearchable.new(:not_multisearchable => true) }
+              let(:record) { ModelThatIsMultisearchable.new(not_multisearchable: true) }
 
               it "should not create a PgSearch::Document record" do
                 expect { record.save! }.not_to change(PgSearch::Document, :count)
@@ -409,7 +450,7 @@ describe PgSearch::Multisearchable do
         end
 
         describe "after_update" do
-          let!(:record) { ModelThatIsMultisearchable.create!(:not_multisearchable => false) }
+          let!(:record) { ModelThatIsMultisearchable.create!(not_multisearchable: false) }
 
           context "when the document is present" do
             before { expect(record.pg_search_document).to be_present }
@@ -504,7 +545,7 @@ describe PgSearch::Multisearchable do
 
         model do
           include PgSearch
-          multisearchable :if => :multisearchable?
+          multisearchable if: :multisearchable?
         end
       end
 
@@ -512,7 +553,7 @@ describe PgSearch::Multisearchable do
         describe "after_create" do
           describe "saving the record" do
             context "when the condition is true" do
-              let(:record) { ModelThatIsMultisearchable.new(:multisearchable => true) }
+              let(:record) { ModelThatIsMultisearchable.new(multisearchable: true) }
 
               it "should create a PgSearch::Document record" do
                 expect { record.save! }.to change(PgSearch::Document, :count).by(1)
@@ -528,7 +569,7 @@ describe PgSearch::Multisearchable do
             end
 
             context "when the condition is false" do
-              let(:record) { ModelThatIsMultisearchable.new(:multisearchable => false) }
+              let(:record) { ModelThatIsMultisearchable.new(multisearchable: false) }
 
               it "should not create a PgSearch::Document record" do
                 expect { record.save! }.not_to change(PgSearch::Document, :count)
@@ -538,7 +579,7 @@ describe PgSearch::Multisearchable do
         end
 
         describe "after_update" do
-          let!(:record) { ModelThatIsMultisearchable.create!(:multisearchable => true) }
+          let!(:record) { ModelThatIsMultisearchable.create!(multisearchable: true) }
 
           context "when the document is present" do
             before { expect(record.pg_search_document).to be_present }
@@ -617,7 +658,7 @@ describe PgSearch::Multisearchable do
         end
 
         describe "after_destroy" do
-          let(:record) { ModelThatIsMultisearchable.create!(:multisearchable => true) }
+          let(:record) { ModelThatIsMultisearchable.create!(multisearchable: true) }
 
           it "should remove its document" do
             document = record.pg_search_document
@@ -636,7 +677,7 @@ describe PgSearch::Multisearchable do
 
         model do
           include PgSearch
-          multisearchable :unless => :not_multisearchable?
+          multisearchable unless: :not_multisearchable?
         end
       end
 
@@ -644,7 +685,7 @@ describe PgSearch::Multisearchable do
         describe "after_create" do
           describe "saving the record" do
             context "when the condition is true" do
-              let(:record) { ModelThatIsMultisearchable.new(:not_multisearchable => true) }
+              let(:record) { ModelThatIsMultisearchable.new(not_multisearchable: true) }
 
               it "should not create a PgSearch::Document record" do
                 expect { record.save! }.not_to change(PgSearch::Document, :count)
@@ -652,7 +693,7 @@ describe PgSearch::Multisearchable do
             end
 
             context "when the condition is false" do
-              let(:record) { ModelThatIsMultisearchable.new(:not_multisearchable => false) }
+              let(:record) { ModelThatIsMultisearchable.new(not_multisearchable: false) }
 
               it "should create a PgSearch::Document record" do
                 expect { record.save! }.to change(PgSearch::Document, :count).by(1)
@@ -670,7 +711,7 @@ describe PgSearch::Multisearchable do
         end
 
         describe "after_update" do
-          let!(:record) { ModelThatIsMultisearchable.create!(:not_multisearchable => false) }
+          let!(:record) { ModelThatIsMultisearchable.create!(not_multisearchable: false) }
 
           context "when the document is present" do
             before { expect(record.pg_search_document).to be_present }
@@ -749,7 +790,7 @@ describe PgSearch::Multisearchable do
         end
 
         describe "after_destroy" do
-          let(:record) { ModelThatIsMultisearchable.create!(:not_multisearchable => false) }
+          let(:record) { ModelThatIsMultisearchable.create!(not_multisearchable: false) }
 
           it "should remove its document" do
             document = record.pg_search_document

data/spec/lib/pg_search/normalizer_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe PgSearch::Normalizer do
@@ -5,7 +7,7 @@ describe PgSearch::Normalizer 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 = double("config", ignore: [:accents])
           node = Arel::Nodes::NamedFunction.new("foo", [Arel::Nodes.build_quoted("bar")])
 
           normalizer = PgSearch::Normalizer.new(config)
@@ -17,7 +19,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 = double("config", :ignore => [:accents])
+            config = double("config", ignore: [:accents])
 
             normalizer = PgSearch::Normalizer.new(config)
             expect(normalizer.add_normalization(node)).to eq("my_unaccent(foo('bar'))")
@@ -27,7 +29,7 @@ describe PgSearch::Normalizer do
 
       context "when passed a String" do
         it "wraps the expression in unaccent()" do
-          config = double("config", :ignore => [:accents])
+          config = double("config", ignore: [:accents])
 
           normalizer = PgSearch::Normalizer.new(config)
           expect(normalizer.add_normalization("foo")).to eq("unaccent(foo)")
@@ -37,7 +39,7 @@ 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 = double("config", ignore: [:accents])
 
             normalizer = PgSearch::Normalizer.new(config)
             expect(normalizer.add_normalization("foo")).to eq("my_unaccent(foo)")
@@ -48,7 +50,7 @@ describe PgSearch::Normalizer do
 
     context "when config[:ignore] does not include :accents" do
       it "passes the expression through" do
-        config = double("config", :ignore => [])
+        config = double("config", ignore: [])
 
         normalizer = PgSearch::Normalizer.new(config)
         expect(normalizer.add_normalization("foo")).to eq("foo")

data/spec/lib/pg_search_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 # For AR 5 and greater, the association reflection's cache needs be cleared
@@ -30,7 +32,7 @@ describe PgSearch do
     end
 
     context "with PgSearch.multisearch_options set to a Hash" do
-      before { allow(PgSearch).to receive(:multisearch_options).and_return(:using => :dmetaphone) }
+      before { allow(PgSearch).to receive(:multisearch_options).and_return(using: :dmetaphone) }
       subject do
         PgSearch::Document.clear_searchable_cache
         PgSearch.multisearch(query).map(&:searchable)
@@ -42,11 +44,11 @@ describe PgSearch do
         end
         model do
           include PgSearch
-          multisearchable :against => :title
+          multisearchable against: :title
         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) }
     end
@@ -61,9 +63,9 @@ describe PgSearch do
         allow(PgSearch).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
@@ -75,11 +77,11 @@ describe PgSearch do
         end
         model do
           include PgSearch
-          multisearchable :against => :title
+          multisearchable against: :title
         end
       end
 
-      let!(:soundalike_record) { MultisearchableModel.create!(:title => 'foning') }
+      let!(:soundalike_record) { MultisearchableModel.create!(title: 'foning') }
       let(:query) { "Phoning" }
 
       context "with soundalike true" do
@@ -105,7 +107,7 @@ describe PgSearch do
         before do
           searchable_subclass_model = Class.new(SuperclassModel) do
             include PgSearch
-            multisearchable :against => :content
+            multisearchable against: :content
           end
           stub_const("SearchableSubclassModel", searchable_subclass_model)
           stub_const("AnotherSearchableSubclassModel", searchable_subclass_model)
@@ -113,13 +115,13 @@ describe PgSearch do
         end
 
         it "returns only results for that subclass" do
-          included = SearchableSubclassModel.create!(:content => "foo bar")
+          included = SearchableSubclassModel.create!(content: "foo bar")
 
-          SearchableSubclassModel.create!(:content => "baz")
-          SuperclassModel.create!(:content => "foo bar")
-          SuperclassModel.create!(:content => "baz")
-          NonSearchableSubclassModel.create!(:content => "foo bar")
-          NonSearchableSubclassModel.create!(:content => "baz")
+          SearchableSubclassModel.create!(content: "baz")
+          SuperclassModel.create!(content: "foo bar")
+          SuperclassModel.create!(content: "baz")
+          NonSearchableSubclassModel.create!(content: "foo bar")
+          NonSearchableSubclassModel.create!(content: "baz")
 
           expect(SuperclassModel.count).to be 6
           expect(SearchableSubclassModel.count).to be 2
@@ -132,7 +134,7 @@ describe PgSearch do
         end
 
         it "updates an existing STI model does not create a new pg_search document" do
-          model = SearchableSubclassModel.create!(:content => "foo bar")
+          model = SearchableSubclassModel.create!(content: "foo bar")
           expect(SearchableSubclassModel.count).to eq(1)
           # We fetch the model from the database again otherwise
           # the pg_search_document from the cache is used.
@@ -144,12 +146,12 @@ describe PgSearch do
         end
 
         it "reindexing works" do
-          NonSearchableSubclassModel.create!(:content => "foo bar")
-          NonSearchableSubclassModel.create!(:content => "baz")
-          expected = SearchableSubclassModel.create!(:content => "baz")
-          SuperclassModel.create!(:content => "foo bar")
-          SuperclassModel.create!(:content => "baz")
-          SuperclassModel.create!(:content => "baz2")
+          NonSearchableSubclassModel.create!(content: "foo bar")
+          NonSearchableSubclassModel.create!(content: "baz")
+          expected = SearchableSubclassModel.create!(content: "baz")
+          SuperclassModel.create!(content: "foo bar")
+          SuperclassModel.create!(content: "baz")
+          SuperclassModel.create!(content: "baz2")
 
           expect(SuperclassModel.count).to be 6
           expect(NonSearchableSubclassModel.count).to be 2
@@ -166,15 +168,15 @@ describe PgSearch do
         end
 
         it "reindexing searchable STI doesn't clobber other related STI models" do
-          SearchableSubclassModel.create!(:content => "baz")
-          AnotherSearchableSubclassModel.create!(:content => "baz")
+          SearchableSubclassModel.create!(content: "baz")
+          AnotherSearchableSubclassModel.create!(content: "baz")
 
           expect(PgSearch::Document.count).to be 2
           PgSearch::Multisearch.rebuild(SearchableSubclassModel)
           expect(PgSearch::Document.count).to be 2
 
           PgSearch::Document.clear_searchable_cache
-          classes = PgSearch::Document.all.collect {|d| d.searchable.class }
+          classes = PgSearch::Document.all.collect { |d| d.searchable.class }
           expect(classes).to include SearchableSubclassModel
           expect(classes).to include AnotherSearchableSubclassModel
         end
@@ -195,7 +197,7 @@ describe PgSearch do
         before do
           searchable_subclass_model = Class.new(SuperclassModel) do
             include PgSearch
-            multisearchable :against => :content
+            multisearchable against: :content
           end
           stub_const("SearchableSubclassModel", searchable_subclass_model)
           stub_const("AnotherSearchableSubclassModel", searchable_subclass_model)
@@ -203,13 +205,13 @@ describe PgSearch do
         end
 
         it "returns only results for that subclass" do
-          included = SearchableSubclassModel.create!(:content => "foo bar")
+          included = SearchableSubclassModel.create!(content: "foo bar")
 
-          SearchableSubclassModel.create!(:content => "baz")
-          SuperclassModel.create!(:content => "foo bar")
-          SuperclassModel.create!(:content => "baz")
-          NonSearchableSubclassModel.create!(:content => "foo bar")
-          NonSearchableSubclassModel.create!(:content => "baz")
+          SearchableSubclassModel.create!(content: "baz")
+          SuperclassModel.create!(content: "foo bar")
+          SuperclassModel.create!(content: "baz")
+          NonSearchableSubclassModel.create!(content: "foo bar")
+          NonSearchableSubclassModel.create!(content: "baz")
 
           expect(SuperclassModel.count).to be 6
           expect(SearchableSubclassModel.count).to be 2

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'simplecov'
 SimpleCov.start
 
@@ -20,7 +22,7 @@ require 'support/database'
 require 'support/with_model'
 
 DOCUMENTS_SCHEMA = lambda do |t|
-  t.belongs_to :searchable, :polymorphic => true, :index => true
+  t.belongs_to :searchable, polymorphic: true, index: true
   t.text :content
   t.timestamps null: false
 end

data/spec/support/database.rb

@@ -1,27 +1,22 @@
-if defined? JRUBY_VERSION
+# frozen_string_literal: true
+
+case RUBY_PLATFORM
+when "java"
   require "activerecord-jdbc-adapter"
-  error_classes = [ActiveRecord::JDBCError]
+  ERROR_CLASS = ActiveRecord::JDBCError
 else
   require "pg"
-  error_classes = [PG::Error]
+  ERROR_CLASS = PG::Error
 end
 
-error_classes << ActiveRecord::NoDatabaseError if defined? ActiveRecord::NoDatabaseError
-
 begin
-  database_user = if ENV["TRAVIS"]
-                    "postgres"
-                  else
-                    ENV["USER"]
-                  end
-
-  ActiveRecord::Base.establish_connection(:adapter => 'postgresql',
-                                          :database => 'pg_search_test',
-                                          :username => database_user,
-                                          :min_messages => 'warning')
+  ActiveRecord::Base.establish_connection(adapter: 'postgresql',
+                                          database: 'pg_search_test',
+                                          username: (ENV["TRAVIS"] ? "postgres" : ENV["USER"]),
+                                          min_messages: 'warning')
   connection = ActiveRecord::Base.connection
   connection.execute("SELECT 1")
-rescue *error_classes => exception
+rescue ERROR_CLASS, ActiveRecord::NoDatabaseError => e
   at_exit do
     puts "-" * 80
     puts "Unable to connect to database.  Please run:"
@@ -29,7 +24,7 @@ rescue *error_classes => exception
     puts "    createdb pg_search_test"
     puts "-" * 80
   end
-  raise exception
+  raise e
 end
 
 if ENV["LOGGER"]
@@ -41,19 +36,20 @@ def install_extension(name)
   connection = ActiveRecord::Base.connection
   extension = connection.execute "SELECT * FROM pg_catalog.pg_extension WHERE extname = '#{name}';"
   return unless extension.none?
+
   connection.execute "CREATE EXTENSION #{name};"
-rescue StandardError => exception
+rescue StandardError => e
   at_exit do
     puts "-" * 80
     puts "Please install the #{name} extension"
     puts "-" * 80
   end
-  raise exception
+  raise e
 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.downcase == expected_result.downcase
+  raise "Unexpected output for #{query}: #{result.inspect}" unless result.casecmp(expected_result).zero?
 rescue StandardError
   install_extension(name)
 end

data/spec/support/with_model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "with_model"
 
 RSpec.configure do |config|