pg_search 2.3.6 → 2.3.8

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

@@ -2,14 +2,16 @@
 
 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
-    with_model :not_multisearchable
+  describe "when initialized with a model that is not multisearchable" do
+    with_model :not_multisearchable do
+      table
+    end
 
-    it 'raises an exception' do
+    it "raises an exception" do
       expect {
         described_class.new(NotMultisearchable)
       }.to raise_exception(
@@ -23,8 +25,11 @@ describe PgSearch::Multisearch::Rebuilder do
     context "when the model defines .rebuild_pg_search_documents" do
       context "when multisearchable is not conditional" do
         with_model :Model do
+          table
+
           model do
             include PgSearch::Model
+
             multisearchable
 
             def rebuild_pg_search_documents
@@ -53,6 +58,7 @@ describe PgSearch::Multisearch::Rebuilder do
 
               model do
                 include PgSearch::Model
+
                 multisearchable conditional_key => :active?
 
                 def rebuild_pg_search_documents
@@ -84,6 +90,7 @@ describe PgSearch::Multisearch::Rebuilder do
 
             model do
               include PgSearch::Model
+
               multisearchable against: :name
             end
           end
@@ -108,7 +115,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 })
@@ -116,7 +123,7 @@ describe PgSearch::Multisearch::Rebuilder do
             expected_sql = <<~SQL.squish
               INSERT INTO "pg_search_documents" (searchable_type, searchable_id, content, created_at, updated_at)
                 SELECT 'Model' AS searchable_type,
-                       #{Model.quoted_table_name}.#{Model.primary_key} AS searchable_id,
+                       #{Model.quoted_table_name}.#{Model.connection.quote_column_name(Model.primary_key)} AS searchable_id,
                        (
                          coalesce(#{Model.quoted_table_name}."name"::text, '')
                        ) AS content,
@@ -137,7 +144,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
@@ -147,14 +154,15 @@ describe PgSearch::Multisearch::Rebuilder do
 
               model do
                 include PgSearch::Model
+
                 multisearchable against: :name
               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
 
@@ -166,11 +174,12 @@ describe PgSearch::Multisearch::Rebuilder do
 
               model do
                 include PgSearch::Model
+
                 multisearchable against: :name
               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 })
@@ -178,7 +187,7 @@ describe PgSearch::Multisearch::Rebuilder do
               expected_sql = <<~SQL.squish
                 INSERT INTO "pg_search_documents" (searchable_type, searchable_id, content, created_at, updated_at)
                   SELECT 'ModelWithNonStandardPrimaryKey' AS searchable_type,
-                         #{ModelWithNonStandardPrimaryKey.quoted_table_name}.non_standard_primary_key AS searchable_id,
+                         #{ModelWithNonStandardPrimaryKey.quoted_table_name}."non_standard_primary_key" AS searchable_id,
                          (
                            coalesce(#{ModelWithNonStandardPrimaryKey.quoted_table_name}."name"::text, '')
                          ) AS content,
@@ -199,14 +208,17 @@ 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
 
         context "when :against includes non-column dynamic methods" do
           with_model :Model do
+            table
+
             model do
               include PgSearch::Model
+
               multisearchable against: [:foo]
 
               def foo
@@ -215,7 +227,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 +253,42 @@ describe PgSearch::Multisearch::Rebuilder do
 
             expect(record.pg_search_document).to be_present
           end
-          # rubocop:enable RSpec/ExampleLength
+          # standard:enable RSpec/ExampleLength
+        end
+
+        context "with an identifier that requires quoting" do
+          with_model :Model do
+            table do |t|
+              t.string :name
+            end
+
+            model do
+              include PgSearch::Model
+
+              multisearchable against: :name
+            end
+          end
+
+          it "quotes the primary key in the generated SQL" do
+            malicious_pk = %(id"; DROP TABLE pg_search_documents; --)
+            allow(Model).to receive(:primary_key).and_return(malicious_pk)
+
+            rebuilder = described_class.new(Model)
+            sql = rebuilder.send(:rebuild_sql)
+
+            expect(sql).to include(Model.connection.quote_column_name(malicious_pk))
+          end
+
+          it "quotes the inheritance column in the STI clause" do
+            malicious_column = %(type"; DROP TABLE pg_search_documents; --)
+            allow(Model).to receive(:inheritance_column).and_return(malicious_column)
+            allow(Model).to receive(:column_names).and_return(Model.column_names + [malicious_column])
+
+            rebuilder = described_class.new(Model)
+            sql = rebuilder.send(:rebuild_sql)
+
+            expect(sql).to include(Model.connection.quote_column_name(malicious_column))
+          end
         end
 
         context "when only additional_attributes is set" do
@@ -252,8 +299,9 @@ 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
 
@@ -281,11 +329,12 @@ describe PgSearch::Multisearch::Rebuilder do
 
             model do
               include PgSearch::Model
+
               multisearchable if: :active?
             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 +360,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
@@ -322,11 +371,12 @@ describe PgSearch::Multisearch::Rebuilder do
 
             model do
               include PgSearch::Model
+
               multisearchable unless: :inactive?
             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 +402,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
 
@@ -82,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
@@ -90,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
@@ -135,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) }
 
@@ -148,7 +148,7 @@ describe PgSearch::Multisearch do
           expected_sql = <<~SQL.squish
             INSERT INTO #{PgSearch::Document.quoted_table_name} (searchable_type, searchable_id, content, created_at, updated_at)
               SELECT #{connection.quote(model.name)} AS searchable_type,
-                     #{model.quoted_table_name}.id AS searchable_id,
+                     #{model.quoted_table_name}.#{connection.quote_column_name(model.primary_key)} AS searchable_id,
                      (
                        coalesce(#{model.quoted_table_name}."title"::text, '')
                      ) AS content,
@@ -175,7 +175,7 @@ describe PgSearch::Multisearch do
           expected_sql = <<~SQL.squish
             INSERT INTO #{PgSearch::Document.quoted_table_name} (searchable_type, searchable_id, content, created_at, updated_at)
               SELECT #{connection.quote(model.name)} AS searchable_type,
-                     #{model.quoted_table_name}.id AS searchable_id,
+                     #{model.quoted_table_name}.#{connection.quote_column_name(model.primary_key)} AS searchable_id,
                      (
                        coalesce(#{model.quoted_table_name}."title"::text, '') || ' ' || coalesce(#{model.quoted_table_name}."content"::text, '')
                      ) AS content,
@@ -195,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,14 +2,17 @@
 
 require "spec_helper"
 
-# rubocop:disable RSpec/NestedGroups
+# standard:disable RSpec/NestedGroups
 describe PgSearch::Multisearchable do
   with_table "pg_search_documents", &DOCUMENTS_SCHEMA
 
   describe "a model that is multisearchable" do
     with_model :ModelThatIsMultisearchable do
+      table
+
       model do
         include PgSearch::Model
+
         multisearchable
       end
     end
@@ -21,6 +24,7 @@ describe PgSearch::Multisearchable do
 
       model do
         include PgSearch::Model
+
         multisearchable
 
         has_many :multisearchable_children, dependent: :destroy
@@ -36,7 +40,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 +153,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 +171,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 +199,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 +217,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 +238,7 @@ describe PgSearch::Multisearchable do
         let(:multisearchable_options) do
           {
             additional_attributes: lambda do |record|
-              { foo: record.bar }
+              {foo: record.bar}
             end
           }
         end
@@ -244,10 +248,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 +270,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 +290,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 +305,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
@@ -319,6 +323,7 @@ describe PgSearch::Multisearchable do
 
         model do
           include PgSearch::Model
+
           multisearchable if: ->(record) { record.multisearchable? }
         end
       end
@@ -450,6 +455,7 @@ describe PgSearch::Multisearchable do
 
         model do
           include PgSearch::Model
+
           multisearchable unless: ->(record) { record.not_multisearchable? }
         end
       end
@@ -585,6 +591,7 @@ describe PgSearch::Multisearchable do
 
         model do
           include PgSearch::Model
+
           multisearchable if: :multisearchable?
         end
       end
@@ -723,6 +730,7 @@ describe PgSearch::Multisearchable do
 
         model do
           include PgSearch::Model
+
           multisearchable unless: :not_multisearchable?
         end
       end
@@ -854,4 +862,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,17 +2,17 @@
 
 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)
-          expect(normalizer.add_normalization(node)).to eq("unaccent(foo('bar'))")
+          expect(normalizer.add_normalization(node)).to eq("regexp_replace(unaccent(foo('bar')), '[''?\\:]', '', 'g')")
         end
 
         context "when a custom unaccent function is specified" do
@@ -20,30 +20,30 @@ 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'))")
+            expect(normalizer.add_normalization(node)).to eq("regexp_replace(my_unaccent(foo('bar')), '[''?\\:]', '', 'g')")
           end
         end
       end
 
       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)")
+          expect(normalizer.add_normalization("foo")).to eq("regexp_replace(unaccent(foo), '[''?\\:]', '', 'g')")
         end
 
         context "when a custom unaccent function is specified" 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)")
+            expect(normalizer.add_normalization("foo")).to eq("regexp_replace(my_unaccent(foo), '[''?\\:]', '', 'g')")
           end
         end
       end
@@ -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