pg_search 2.3.7 → 2.4.0

data/lib/pg_search/scope_options.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "active_support/core_ext/module/delegation"
-
 module PgSearch
   class ScopeOptions
     attr_reader :config, :feature_options, :model
@@ -15,10 +13,12 @@ module PgSearch
     def apply(scope)
       scope = include_table_aliasing_for_rank(scope)
       rank_table_alias = scope.pg_search_rank_table_alias(include_counter: true)
+      rank_subquery = subquery.arel.as(rank_table_alias)
 
       scope
-        .joins(rank_join(rank_table_alias))
-        .order(Arel.sql("#{rank_table_alias}.rank DESC, #{order_within_rank}"))
+        .joins(rank_join(rank_subquery))
+        .order(rank_subquery[:rank].desc)
+        .order(order_within_rank)
         .extend(WithPgSearchRank)
         .extend(WithPgSearchHighlight[feature_for(:tsearch)])
     end
@@ -27,6 +27,7 @@ module PgSearch
       def self.[](tsearch)
         Module.new do
           include WithPgSearchHighlight
+
           define_method(:tsearch) { tsearch }
         end
       end
@@ -37,20 +38,18 @@ module PgSearch
 
       def with_pg_search_highlight
         scope = self
-        scope = scope.select("#{table_name}.*") unless scope.select_values.any?
-        scope.select("(#{highlight}) AS pg_search_highlight")
-      end
-
-      def highlight
-        tsearch.highlight.to_sql
+        scope = scope.select(arel_table[Arel.star]) if scope.select_values.empty?
+        scope.select(tsearch.highlight.as("pg_search_highlight"))
       end
     end
 
     module WithPgSearchRank
       def with_pg_search_rank
         scope = self
-        scope = scope.select("#{table_name}.*") unless scope.select_values.any?
-        scope.select("#{pg_search_rank_table_alias}.rank AS pg_search_rank")
+        scope = scope.select(arel_table[Arel.star]) if scope.select_values.empty?
+        rank_table = arel_table.alias(pg_search_rank_table_alias)
+        rank_column = Arel::Attributes::Attribute.new(rank_table, "rank")
+        scope.select(rank_column.as("pg_search_rank"))
       end
     end
 
@@ -76,13 +75,11 @@ module PgSearch
 
     private
 
-    delegate :connection, :quoted_table_name, to: :model
-
     def subquery
       model
         .unscoped
-        .select("#{primary_key} AS pg_search_id")
-        .select("#{rank} AS rank")
+        .select(model.arel_table[model.primary_key].as("pg_search_id"))
+        .select(rank.as("rank"))
         .joins(subquery_join)
         .where(conditions)
         .limit(nil)
@@ -95,45 +92,26 @@ module PgSearch
           .reject { |_feature_name, feature_options| feature_options && feature_options[:sort_only] }
           .map { |feature_name, _feature_options| feature_for(feature_name).conditions }
 
-      or_node(expressions)
+      Arel::Nodes::Or.new(expressions)
     end
 
-    # https://github.com/rails/rails/pull/51492
-    # :nocov:
-    # standard:disable Lint/DuplicateMethods
-    or_arity = Arel::Nodes::Or.instance_method(:initialize).arity
-    case or_arity
-    when 1
-      def or_node(expressions)
-        Arel::Nodes::Or.new(expressions)
-      end
-    when 2
-      def or_node(expressions)
-        expressions.inject { |accumulator, expression| Arel::Nodes::Or.new(accumulator, expression) }
-      end
-    else
-      raise "Unsupported arity #{or_arity} for Arel::Nodes::Or#initialize"
-    end
-    # :nocov:
-    # standard:enable Lint/DuplicateMethods
-
     def order_within_rank
-      config.order_within_rank || "#{primary_key} ASC"
+      if config.order_within_rank
+        Arel.sql(config.order_within_rank)
+      else
+        model.arel_table[model.primary_key].asc
+      end
     end
 
     def primary_key
-      "#{quoted_table_name}.#{connection.quote_column_name(model.primary_key)}"
+      Arel::Attributes::Attribute.new(model.arel_table, model.primary_key)
     end
 
     def subquery_join
-      if config.associations.any?
-        config.associations.map do |association|
-          association.join(primary_key)
-        end.join(" ")
-      end
+      config.associations.map { |association| association.to_arel(primary_key) }
     end
 
-    FEATURE_CLASSES = {
+    FEATURE_CLASSES = { # standard:disable Lint/UselessConstantScoping
       dmetaphone: Features::DMetaphone,
       tsearch: Features::TSearch,
       trigram: Features::Trigram
@@ -157,17 +135,22 @@ module PgSearch
     end
 
     def rank
-      (config.ranking_sql || ":tsearch").gsub(/:(\w*)/) do
+      return feature_for(:tsearch).rank unless config.ranking_sql
+
+      Arel.sql(config.ranking_sql.gsub(/:(\w*)/) do
         feature_for(Regexp.last_match(1)).rank.to_sql
-      end
+      end)
     end
 
-    def rank_join(rank_table_alias)
-      "INNER JOIN (#{subquery.to_sql}) AS #{rank_table_alias} ON #{primary_key} = #{rank_table_alias}.pg_search_id"
+    def rank_join(rank_subquery)
+      model.arel_table
+        .join(rank_subquery)
+        .on(model.arel_table[model.primary_key].eq(rank_subquery[:pg_search_id]))
+        .join_sources
     end
 
     def include_table_aliasing_for_rank(scope)
-      return scope if scope.included_modules.include?(PgSearchRankTableAliasing)
+      return scope if scope.include?(PgSearchRankTableAliasing)
 
       scope.all.spawn.tap do |new_scope|
         new_scope.instance_eval { extend PgSearchRankTableAliasing }

data/lib/pg_search/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgSearch
-  VERSION = "2.3.7"
+  VERSION = "2.4.0"
 end

data/pg_search.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |s|
   s.name = "pg_search"
   s.version = PgSearch::VERSION
   s.platform = Gem::Platform::RUBY
-  s.authors = ["Grant Hutchins", "Case Commons, LLC"]
-  s.email = %w[gems@nertzy.com casecommons-dev@googlegroups.com]
+  s.authors = ["Grant Hutchins"]
+  s.email = ["gems@nertzy.com"]
   s.homepage = "https://github.com/Casecommons/pg_search"
   s.summary = "PgSearch builds Active Record named scopes that take advantage of PostgreSQL's full text search"
   s.description = "PgSearch builds Active Record named scopes that take advantage of PostgreSQL's full text search"
@@ -18,8 +18,8 @@ Gem::Specification.new do |s|
   s.files = `git ls-files -z`.split("\x0")
   s.require_paths = ["lib"]
 
-  s.add_dependency "activerecord", ">= 6.1"
-  s.add_dependency "activesupport", ">= 6.1"
+  s.add_dependency "activerecord", ">= 8.0"
+  s.add_dependency "activesupport", ">= 8.0"
 
-  s.required_ruby_version = ">= 3.0"
+  s.required_ruby_version = ">= 3.3"
 end

data/spec/integration/associations_spec.rb

@@ -20,6 +20,7 @@ describe "a pg_search_scope" do
 
         model do
           include PgSearch::Model
+
           belongs_to :another_model, class_name: "AssociatedModel"
 
           pg_search_scope :with_another, associated_against: {another_model: :title}
@@ -57,6 +58,7 @@ describe "a pg_search_scope" do
 
         model do
           include PgSearch::Model
+
           belongs_to :another_model, class_name: "AssociatedModel"
 
           pg_search_scope :with_associated, against: :title, associated_against: {another_model: :title}
@@ -93,6 +95,7 @@ describe "a pg_search_scope" do
 
         model do
           include PgSearch::Model
+
           has_many :other_models, class_name: "AssociatedModelWithHasMany", foreign_key: "ModelWithHasMany_id"
 
           pg_search_scope :with_associated, against: [:title], associated_against: {other_models: :title}
@@ -142,6 +145,127 @@ describe "a pg_search_scope" do
       end
     end
 
+    context "via a scoped has_many association with a quoted literal condition" do
+      with_model :Book do
+        table do |t|
+          t.string "title"
+          t.string "author"
+          t.belongs_to :shelf
+        end
+
+        model do
+          belongs_to :shelf
+        end
+      end
+
+      with_model :Shelf do
+        table do |t|
+          t.string "title"
+        end
+
+        model do
+          include PgSearch::Model
+
+          has_many :obrien_books,
+            -> { where(author: "O'Brien") },
+            class_name: "Book"
+
+          pg_search_scope :with_obrien_books,
+            associated_against: {obrien_books: :title}
+        end
+      end
+
+      it "preserves scoped values through searches" do
+        shelf_with_obrien = Shelf.create!(title: "Main Shelf")
+        shelf_without_obrien = Shelf.create!(title: "Other Shelf")
+
+        Book.create!(
+          title: "The Third Policeman",
+          author: "O'Brien",
+          shelf: shelf_with_obrien
+        )
+        Book.create!(
+          title: "The Third Policeman",
+          author: "Someone Else",
+          shelf: shelf_without_obrien
+        )
+
+        results = Shelf.with_obrien_books("Third Policeman")
+        expect(results).to include(shelf_with_obrien)
+        expect(results).not_to include(shelf_without_obrien)
+      end
+    end
+
+    context "with a physical source column shadowed by a model alias" do
+      with_model :Book do
+        table do |t|
+          t.string :title
+          t.string :name
+          t.belongs_to :shelf
+        end
+
+        model do
+          belongs_to :shelf
+        end
+      end
+
+      with_model :Shelf do
+        table
+
+        model do
+          include PgSearch::Model
+
+          has_many :books
+
+          pg_search_scope :search, associated_against: {books: :title}
+        end
+      end
+
+      it "searches the physical association source through the derived alias" do
+        shelf = Shelf.create!
+        shelf.books.create!(title: "physical", name: "alias")
+        Book.alias_attribute :title, :name
+
+        expect(Shelf.search("physical")).to eq [shelf]
+        expect(Shelf.search("alias")).to be_empty
+      end
+    end
+
+    context "with a trusted SQL expression as the association source" do
+      with_model :Book do
+        table do |t|
+          t.json :metadata
+          t.belongs_to :shelf
+        end
+
+        model do
+          belongs_to :shelf
+        end
+      end
+
+      with_model :Shelf do
+        table
+
+        model do
+          include PgSearch::Model
+
+          has_many :books
+
+          pg_search_scope :search,
+            associated_against: {books: Arel.sql("metadata->>'title'")}
+        end
+      end
+
+      it "evaluates the expression before aggregating the associated rows" do
+        shelf = Shelf.create!
+        shelf.books.create!(metadata: {title: "Hello"})
+        shelf.books.create!(metadata: {title: "world"})
+
+        expect(Shelf.search("Hello world")).to eq [shelf]
+        expect(Shelf.search("title")).to be_empty
+      end
+    end
+
     context "when across multiple associations" do
       context "when on different tables" do
         with_model :FirstAssociatedModel do
@@ -284,6 +408,7 @@ describe "a pg_search_scope" do
 
         model do
           include PgSearch::Model
+
           belongs_to :another_model, class_name: "AssociatedModel"
 
           pg_search_scope :with_associated, associated_against: {another_model: %i[title author]}
@@ -337,6 +462,7 @@ describe "a pg_search_scope" do
 
         model do
           include PgSearch::Model
+
           belongs_to :another_model, class_name: "AssociatedModel"
 
           pg_search_scope :with_associated, associated_against: {another_model: :number}
@@ -368,6 +494,7 @@ describe "a pg_search_scope" do
         model do
           has_many :children
           include PgSearch::Model
+
           pg_search_scope :search_name, against: :name
         end
       end
@@ -398,6 +525,8 @@ describe "a pg_search_scope" do
 
   context "when merging a pg_search_scope into another model's scope" do
     with_model :ModelWithAssociation do
+      table
+
       model do
         has_many :associated_models
       end
@@ -411,6 +540,7 @@ describe "a pg_search_scope" do
 
       model do
         include PgSearch::Model
+
         belongs_to :model_with_association
 
         pg_search_scope :search_content, against: :content
@@ -444,6 +574,8 @@ describe "a pg_search_scope" do
 
   context "when chained onto a has_many association" do
     with_model :Company do
+      table
+
       model do
         has_many :positions
       end
@@ -457,6 +589,7 @@ describe "a pg_search_scope" do
 
       model do
         include PgSearch::Model
+
         pg_search_scope :search, against: :title, using: %i[tsearch trigram]
       end
     end

data/spec/integration/deprecation_spec.rb

@@ -5,6 +5,8 @@ require "active_support/core_ext/kernel/reporting"
 
 describe "Including the deprecated PgSearch module" do
   with_model :SomeModel do
+    table
+
     model do
       silence_warnings do
         include PgSearch
@@ -12,7 +14,9 @@ describe "Including the deprecated PgSearch module" do
     end
   end
 
-  with_model :AnotherModel
+  with_model :AnotherModel do
+    table
+  end
 
   it "includes PgSearch::Model" do
     expect(SomeModel.ancestors).to include PgSearch::Model

data/spec/integration/pagination_spec.rb

@@ -11,6 +11,7 @@ describe "pagination" do
 
       model do
         include PgSearch::Model
+
         pg_search_scope :search_name, against: :name
 
         def self.page(page_number)

data/spec/integration/pg_search_spec.rb

@@ -14,6 +14,7 @@ describe "an Active Record model which includes PgSearch" do
 
     model do
       include PgSearch::Model
+
       belongs_to :parent_model
     end
   end
@@ -24,6 +25,7 @@ describe "an Active Record model which includes PgSearch" do
 
     model do
       include PgSearch::Model
+
       has_many :models_with_pg_search
       scope :active, -> { where(active: true) }
     end
@@ -238,6 +240,7 @@ describe "an Active Record model which includes PgSearch" do
 
           model do
             include PgSearch::Model
+
             belongs_to :person
             pg_search_scope :search_city, against: [:city]
           end
@@ -250,6 +253,7 @@ describe "an Active Record model which includes PgSearch" do
 
           model do
             include PgSearch::Model
+
             has_many :houses
             pg_search_scope :named, against: [:name]
             scope :with_house_in_city, lambda { |city|
@@ -1046,6 +1050,7 @@ describe "an Active Record model which includes PgSearch" do
 
         model do
           include PgSearch::Model
+
           has_many :comments
         end
       end
@@ -1083,10 +1088,65 @@ describe "an Active Record model which includes PgSearch" do
       it "finds by a combination of the two" do
         expect(Post.search_by_content_with_tsvector("phooey commentone").map(&:id)).to eq([expected.id])
       end
+
+      it "finds by the tsvector column when ordering by an associated table" do
+        # Reference the physical table name that Active Record would normally
+        # leave unaliased. The old string rank join made AliasTracker think the
+        # name was already used and alias this outer join, breaking the order.
+        # https://github.com/Casecommons/pg_search/issues/206
+        results = Post
+          .joins(:comments)
+          .search_by_content_with_tsvector("phooey")
+          .order(Comment.table_name => {id: :asc})
+
+        expect(results).to eq([expected])
+      end
+
+      it "finds by the tsvector column when ordering by an association alias" do
+        results = Post
+          .joins(:comments)
+          .search_by_content_with_tsvector("phooey")
+          .order(comments: {id: :asc})
+
+        expect(results).to eq([expected])
+      end
+    end
+
+    context "with quoted identifiers and a rank attribute alias" do
+      with_model :Article do
+        table primary_key: "ArticleID" do |t|
+          t.text :content
+          t.tsvector "SearchVector"
+          t.integer :importance
+        end
+
+        model do
+          include PgSearch::Model
+
+          alias_attribute :rank, :importance
+          pg_search_scope :search_content,
+            using: {tsearch: {tsvector_column: "SearchVector"}}
+        end
+      end
+
+      it "searches the physical vector and selects the synthetic rank" do
+        article = Article.create!(content: "phooey", importance: 10)
+        Article.update_all(
+          %("SearchVector" = to_tsvector('simple', "content"))
+        )
+
+        result = Article.search_content("phooey").with_pg_search_rank.first
+
+        expect(result).to eq(article)
+        expect(result.pg_search_rank).to be_a(Float)
+        expect(result.pg_search_rank).not_to eq(result.importance)
+      end
     end
 
     context "when using multiple tsvector columns" do
       with_model :ModelWithTsvector do
+        table
+
         model do
           include PgSearch::Model
 
@@ -1185,7 +1245,7 @@ describe "an Active Record model which includes PgSearch" do
       end
 
       context "when the query includes accents" do
-        let(:term) { "L#{%w[‘ ’ ʻ ʼ].sample}Content" }
+        let(:term) { "L#{%w[‘ ’ ʻ ʼ ʹ ʽ ˈ ＇ ʼn].sample}Content" }
         let(:included) { ModelWithPgSearch.create!(title: "Weird #{term}") }
         let(:results) { ModelWithPgSearch.search_title_without_accents(term) }
 
@@ -1199,6 +1259,23 @@ describe "an Active Record model which includes PgSearch" do
       end
     end
 
+    context "when passed an :order_within_rank expression" do
+      before do
+        ModelWithPgSearch.pg_search_scope :search_content_ordered_by_importance,
+          against: :content,
+          order_within_rank: "importance DESC"
+      end
+
+      it "breaks ties in rank by the custom expression" do
+        # Both records match equally; importance determines order
+        low = ModelWithPgSearch.create!(content: "foo", importance: 1)
+        high = ModelWithPgSearch.create!(content: "foo", importance: 5)
+
+        results = ModelWithPgSearch.search_content_ordered_by_importance("foo")
+        expect(results).to eq([high, low])
+      end
+    end
+
     context "when passed a :ranked_by expression" do
       before do
         ModelWithPgSearch.pg_search_scope :search_content_with_default_rank,

data/spec/integration/single_table_inheritance_spec.rb

@@ -12,6 +12,7 @@ describe "a pg_search_scope on an STI subclass" do
 
       model do
         include PgSearch::Model
+
         pg_search_scope :search_content, against: :content
       end
     end
@@ -52,6 +53,7 @@ describe "a pg_search_scope on an STI subclass" do
 
       model do
         include PgSearch::Model
+
         self.inheritance_column = "custom_type"
         pg_search_scope :search_content, against: :content
       end