pg_search 2.3.7 → 2.4.0

data/spec/lib/pg_search/multisearchable_spec.rb

@@ -8,8 +8,11 @@ describe PgSearch::Multisearchable do
 
   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
@@ -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

data/spec/lib/pg_search/normalizer_spec.rb

@@ -7,56 +7,109 @@ 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
+        it "returns an Arel node wrapping the expression in unaccent()" do
           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'))")
+          result = normalizer.add_normalization(node)
+          expect(result).to be_an(Arel::Nodes::Node)
+          expect(result.to_sql).to eq("regexp_replace(unaccent(foo('bar')), '[''?\\:]', '', 'g')")
         end
 
         context "when a custom unaccent function is specified" do
-          it "wraps the expression in that function" do
+          it "returns an Arel node using that function" 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])
 
             normalizer = described_class.new(config)
-            expect(normalizer.add_normalization(node)).to eq("my_unaccent(foo('bar'))")
+            result = normalizer.add_normalization(node)
+            expect(result).to be_an(Arel::Nodes::Node)
+            expect(result.to_sql).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
+      context "when passed a String (trusted SQL expression)" do
+        it "returns an Arel node wrapping the expression in unaccent()" do
           config = instance_double(PgSearch::Configuration, "config", ignore: [:accents])
 
           normalizer = described_class.new(config)
-          expect(normalizer.add_normalization("foo")).to eq("unaccent(foo)")
+          result = normalizer.add_normalization("foo")
+          expect(result).to be_an(Arel::Nodes::Node)
+          expect(result.to_sql).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
+          it "returns an Arel node using that function" do
             allow(PgSearch).to receive(:unaccent_function).and_return("my_unaccent")
 
             config = instance_double(PgSearch::Configuration, "config", ignore: [:accents])
 
             normalizer = described_class.new(config)
-            expect(normalizer.add_normalization("foo")).to eq("my_unaccent(foo)")
+            result = normalizer.add_normalization("foo")
+            expect(result).to be_an(Arel::Nodes::Node)
+            expect(result.to_sql).to eq("regexp_replace(my_unaccent(foo), '[''?\\:]', '', 'g')")
           end
         end
       end
     end
 
+    it "rejects unsupported inputs instead of turning them into SQL" do
+      config = instance_double(PgSearch::Configuration, ignore: [])
+      normalizer = described_class.new(config)
+
+      [nil, Object.new, 123].each do |input|
+        expect { normalizer.add_normalization(input) }.to raise_error(TypeError)
+      end
+    end
+
     context "when config[:ignore] does not include :accents" do
-      it "passes the expression through" do
+      it "passes the expression through as an Arel-compatible object" do
         config = instance_double(PgSearch::Configuration, "config", ignore: [])
 
         normalizer = described_class.new(config)
-        expect(normalizer.add_normalization("foo")).to eq("foo")
+        result = normalizer.add_normalization("foo")
+        expect(result).to eq("foo")  # SqlLiteral is a String subclass, usable in Arel contexts
       end
     end
   end
+
+  describe "executed against PostgreSQL" do
+    with_model :Book do
+      table { |t| t.string :title }
+    end
+
+    it "strips accents and disallowed punctuation but preserves backslashes" do
+      Book.create!(title: "café's? déjà: vu\\path")
+      config = instance_double(PgSearch::Configuration, ignore: [:accents])
+      normalizer = described_class.new(config)
+      expression = normalizer.add_normalization(Book.arel_table[:title])
+
+      expect(Book.pick(expression)).to eq("cafes deja vu\\path")
+    end
+
+    it "preserves attributes when accents are not ignored" do
+      book = Book.create!(title: "café's? déjà: vu\\path")
+      config = instance_double(PgSearch::Configuration, ignore: [])
+      normalizer = described_class.new(config)
+      expression = normalizer.add_normalization(Book.arel_table[:title])
+
+      expect(Book.pick(expression)).to eq(book.title)
+    end
+
+    it "preserves quoted data rather than interpreting it as SQL" do
+      Book.create!
+      value = Arel::Nodes.build_quoted("café's? déjà: vu\\path")
+      config = instance_double(PgSearch::Configuration, ignore: [])
+      normalizer = described_class.new(config)
+
+      expect(normalizer.add_normalization(value)).to equal(value)
+      expect(Book.pick(normalizer.add_normalization(value)))
+        .to eq("café's? déjà: vu\\path")
+    end
+  end
 end
 # standard:enable RSpec/NestedGroups

data/spec/lib/pg_search_spec.rb

@@ -2,17 +2,6 @@
 
 require "spec_helper"
 
-# 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
-  def clear_searchable_cache
-    PgSearch::Document.reflect_on_association(:searchable).clear_association_scope_cache
-  end
-else
-  def clear_searchable_cache
-  end
-end
-
 # standard:disable RSpec/NestedGroups
 describe PgSearch do
   describe ".multisearch" do
@@ -32,10 +21,7 @@ describe PgSearch do
     end
 
     context "with PgSearch.multisearch_options set to a Hash" do
-      subject do
-        clear_searchable_cache
-        described_class.multisearch(query).map(&:searchable)
-      end
+      subject { described_class.multisearch(query).map(&:searchable) }
 
       before { allow(described_class).to receive(:multisearch_options).and_return(using: :dmetaphone) }
 
@@ -45,6 +31,7 @@ describe PgSearch do
         end
         model do
           include PgSearch::Model
+
           multisearchable against: :title
         end
       end
@@ -56,10 +43,7 @@ describe PgSearch do
     end
 
     context "with PgSearch.multisearch_options set to a Proc" do
-      subject do
-        clear_searchable_cache
-        described_class.multisearch(query, soundalike).map(&:searchable)
-      end
+      subject { described_class.multisearch(query, soundalike).map(&:searchable) }
 
       before do
         allow(described_class).to receive(:multisearch_options) do
@@ -79,6 +63,7 @@ describe PgSearch do
         end
         model do
           include PgSearch::Model
+
           multisearchable against: :title
         end
       end
@@ -111,6 +96,7 @@ describe PgSearch do
         before do
           searchable_subclass_model = Class.new(SuperclassModel) do
             include PgSearch::Model
+
             multisearchable against: :content
           end
           stub_const("SearchableSubclassModel", searchable_subclass_model)
@@ -166,7 +152,6 @@ describe PgSearch do
 
           PgSearch::Multisearch.rebuild(SearchableSubclassModel)
 
-          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
@@ -181,7 +166,6 @@ describe PgSearch do
           PgSearch::Multisearch.rebuild(SearchableSubclassModel)
           expect(PgSearch::Document.count).to be 2
 
-          clear_searchable_cache
           classes = PgSearch::Document.all.collect { |d| d.searchable.class }
           expect(classes).to include SearchableSubclassModel
           expect(classes).to include AnotherSearchableSubclassModel
@@ -203,6 +187,7 @@ describe PgSearch do
         before do
           searchable_subclass_model = Class.new(SuperclassModel) do
             include PgSearch::Model
+
             multisearchable against: :content
           end
           stub_const("SearchableSubclassModel", searchable_subclass_model)

data/spec/spec_helper.rb

@@ -1,18 +1,5 @@
 # frozen_string_literal: true
 
-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"
 

metadata

@@ -1,15 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pg_search
 version: !ruby/object:Gem::Version
-  version: 2.3.7
+  version: 2.4.0
 platform: ruby
 authors:
 - Grant Hutchins
-- Case Commons, LLC
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,33 +15,32 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '8.0'
 description: PgSearch builds Active Record named scopes that take advantage of PostgreSQL's
   full text search
 email:
 - gems@nertzy.com
-- casecommons-dev@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -52,6 +49,7 @@ files:
 - ".editorconfig"
 - ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
+- ".github/workflows/codeql.yml"
 - ".gitignore"
 - ".jrubyrc"
 - ".rspec"
@@ -63,6 +61,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- doc/plans/2026-09-05-arel-stack.md
+- doc/plans/2026-09-06-arel-remaining-expressions.md
 - lib/pg_search.rb
 - lib/pg_search/configuration.rb
 - lib/pg_search/configuration/association.rb
@@ -89,8 +89,6 @@ files:
 - lib/pg_search/tasks.rb
 - 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
@@ -117,7 +115,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -125,15 +122,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 4.0.20
 specification_version: 4
 summary: PgSearch builds Active Record named scopes that take advantage of PostgreSQL's
   full text search

data/spec/.rubocop.yml

@@ -1,27 +0,0 @@
-inherit_from:
-  - ../.rubocop.yml
-
-RSpec/ContextWording:
-  Prefixes:
-    - using
-    - via
-    - when
-    - with
-    - without
-
-RSpec/DescribedClass:
-  Enabled: true
-
-RSpec/ExampleLength:
-  Max: 15
-
-RSpec/ExpectInHook:
-  Enabled: false
-
-RSpec/FilePath:
-  CustomTransform:
-    TSearch: "tsearch"
-    DMetaphone: "dmetaphone"
-
-RSpec/MultipleExpectations:
-  Max: 5

data/spec/integration/.rubocop.yml

@@ -1,11 +0,0 @@
-inherit_from:
-  - ../.rubocop.yml
-
-RSpec/DescribeClass:
-  Enabled: false
-
-RSpec/ExampleLength:
-  Enabled: false
-
-RSpec/MultipleExpectations:
-  Enabled: false