pg_search 2.1.7 → 2.3.3

data/lib/pg_search.rb

@@ -2,11 +2,12 @@
 
 require "active_record"
 require "active_support/concern"
-require "active_support/core_ext/module/attribute_accessors"
+require "active_support/core_ext/module/attribute_accessors_per_thread"
 require "active_support/core_ext/string/strip"
 
 require "pg_search/configuration"
 require "pg_search/features"
+require "pg_search/model"
 require "pg_search/multisearch"
 require "pg_search/multisearchable"
 require "pg_search/normalizer"
@@ -14,37 +15,23 @@ require "pg_search/scope_options"
 require "pg_search/version"
 
 module PgSearch
-  extend ActiveSupport::Concern
+  autoload :Document, "pg_search/document"
 
-  mattr_accessor :multisearch_options
-  self.multisearch_options = {}
+  def self.included(base)
+    ActiveSupport::Deprecation.warn <<~MESSAGE
+      Directly including `PgSearch` into an Active Record model is deprecated and will be removed in pg_search 3.0.
 
-  mattr_accessor :unaccent_function
-  self.unaccent_function = "unaccent"
+      Please replace `include PgSearch` with `include PgSearch::Model`.
+    MESSAGE
 
-  module ClassMethods
-    def pg_search_scope(name, options)
-      options_proc = if options.respond_to?(:call)
-                       options
-                     elsif options.respond_to?(:merge)
-                       ->(query) { { query: query }.merge(options) }
-                     else
-                       raise ArgumentError, 'pg_search_scope expects a Hash or Proc'
-                     end
+    base.include PgSearch::Model
+  end
 
-      define_singleton_method(name) do |*args|
-        config = Configuration.new(options_proc.call(*args), self)
-        scope_options = ScopeOptions.new(config)
-        scope_options.apply(self)
-      end
-    end
+  thread_mattr_accessor :multisearch_options
+  self.multisearch_options = {}
 
-    def multisearchable(options = {})
-      include PgSearch::Multisearchable
-      class_attribute :pg_search_multisearchable_options
-      self.pg_search_multisearchable_options = options
-    end
-  end
+  thread_mattr_accessor :unaccent_function
+  self.unaccent_function = "unaccent"
 
   class << self
     def multisearch(*args)
@@ -67,32 +54,6 @@ module PgSearch
     end
   end
 
-  def method_missing(symbol, *args)
-    case symbol
-    when :pg_search_rank
-      raise PgSearchRankNotSelected unless respond_to?(:pg_search_rank)
-
-      read_attribute(:pg_search_rank).to_f
-    when :pg_search_highlight
-      raise PgSearchHighlightNotSelected unless respond_to?(:pg_search_highlight)
-
-      read_attribute(:pg_search_highlight)
-    else
-      super
-    end
-  end
-
-  def respond_to_missing?(symbol, *args)
-    case symbol
-    when :pg_search_rank
-      attributes.key?(:pg_search_rank)
-    when :pg_search_highlight
-      attributes.key?(:pg_search_highlight)
-    else
-      super
-    end
-  end
-
   class PgSearchRankNotSelected < StandardError
     def message
       "You must chain .with_pg_search_rank after the pg_search_scope " \
@@ -108,8 +69,4 @@ module PgSearch
   end
 end
 
-ActiveSupport.on_load(:active_record) do
-  require "pg_search/document"
-end
-
-require "pg_search/railtie" if defined?(Rails)
+require "pg_search/railtie" if defined?(Rails::Railtie)

data/lib/pg_search/document.rb

@@ -4,7 +4,7 @@ require 'logger'
 
 module PgSearch
   class Document < ActiveRecord::Base
-    include PgSearch
+    include PgSearch::Model
 
     self.table_name = 'pg_search_documents'
     belongs_to :searchable, polymorphic: true
@@ -12,7 +12,7 @@ module PgSearch
     # The logger might not have loaded yet.
     # https://github.com/Casecommons/pg_search/issues/26
     def self.logger
-      super || Logger.new(STDERR)
+      super || Logger.new($stderr)
     end
 
     pg_search_scope :search, lambda { |*args|

data/lib/pg_search/features/dmetaphone.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_support/core_ext/module/delegation"
+
 module PgSearch
   module Features
     class DMetaphone
@@ -9,13 +11,9 @@ module PgSearch
         @tsearch = TSearch.new(query, options, columns, model, dmetaphone_normalizer)
       end
 
-      def conditions
-        tsearch.conditions
-      end
+      delegate :conditions, to: :tsearch
 
-      def rank
-        tsearch.rank
-      end
+      delegate :rank, to: :tsearch
 
       private
 

data/lib/pg_search/features/trigram.rb

@@ -4,7 +4,7 @@ module PgSearch
   module Features
     class Trigram < Feature
       def self.valid_options
-        super + [:threshold]
+        super + %i[threshold word_similarity]
       end
 
       def conditions
@@ -14,7 +14,11 @@ module PgSearch
           )
         else
           Arel::Nodes::Grouping.new(
-            Arel::Nodes::InfixOperation.new("%", normalized_document, normalized_query)
+            Arel::Nodes::InfixOperation.new(
+              infix_operator,
+              normalized_query,
+              normalized_document
+            )
           )
         end
       end
@@ -25,12 +29,32 @@ module PgSearch
 
       private
 
+      def word_similarity?
+        options[:word_similarity]
+      end
+
+      def similarity_function
+        if word_similarity?
+          'word_similarity'
+        else
+          'similarity'
+        end
+      end
+
+      def infix_operator
+        if word_similarity?
+          '<%'
+        else
+          '%'
+        end
+      end
+
       def similarity
         Arel::Nodes::NamedFunction.new(
-          "similarity",
+          similarity_function,
           [
-            normalized_document,
-            normalized_query
+            normalized_query,
+            normalized_document
           ]
         )
       end

data/lib/pg_search/features/tsearch.rb

@@ -59,7 +59,7 @@ module PgSearch
         end
       end
 
-      def deprecated_headline_options
+      def deprecated_headline_options # rubocop:disable Metrics/MethodLength
         indifferent_options = options.with_indifferent_access
 
         %w[
@@ -97,7 +97,7 @@ module PgSearch
 
       DISALLOWED_TSQUERY_CHARACTERS = /['?\\:‘’]/.freeze
 
-      def tsquery_for_term(unsanitized_term) # rubocop:disable Metrics/AbcSize
+      def tsquery_for_term(unsanitized_term)
         if options[:negation] && unsanitized_term.start_with?("!")
           unsanitized_term[0] = ''
           negated = true
@@ -107,25 +107,26 @@ module PgSearch
 
         term_sql = Arel.sql(normalize(connection.quote(sanitized_term)))
 
-        # After this, the SQL expression evaluates to a string containing the term surrounded by single-quotes.
-        # If :prefix is true, then the term will have :* appended to the end.
-        # If :negated is true, then the term will have ! prepended to the front.
+        tsquery = tsquery_expression(term_sql, negated: negated, prefix: options[:prefix])
+
+        Arel::Nodes::NamedFunction.new("to_tsquery", [dictionary, tsquery]).to_sql
+      end
+
+      # After this, the SQL expression evaluates to a string containing the term surrounded by single-quotes.
+      # If :prefix is true, then the term will have :* appended to the end.
+      # If :negated is true, then the term will have ! prepended to the front.
+      def tsquery_expression(term_sql, negated:, prefix:)
         terms = [
           (Arel::Nodes.build_quoted('!') if negated),
           Arel::Nodes.build_quoted("' "),
           term_sql,
           Arel::Nodes.build_quoted(" '"),
-          (Arel::Nodes.build_quoted(":*") if options[:prefix])
+          (Arel::Nodes.build_quoted(":*") if prefix)
         ].compact
 
-        tsquery_sql = terms.inject do |memo, term|
+        terms.inject do |memo, term|
           Arel::Nodes::InfixOperation.new("||", memo, Arel::Nodes.build_quoted(term))
         end
-
-        Arel::Nodes::NamedFunction.new(
-          "to_tsquery",
-          [dictionary, tsquery_sql]
-        ).to_sql
       end
 
       def tsquery

data/lib/pg_search/migration/templates/add_pg_search_dmetaphone_support_functions.rb.erb

@@ -1,16 +1,16 @@
 class AddPgSearchDmetaphoneSupportFunctions < ActiveRecord::Migration<%= migration_version %>
-  def self.up
+  def up
     say_with_time("Adding support functions for pg_search :dmetaphone") do
-      execute <<-'SQL'
-<%= read_sql_file "dmetaphone" %>
+      execute <<~'SQL'.squish
+<%= indent(read_sql_file("dmetaphone"), 8) %>
       SQL
     end
   end
 
-  def self.down
+  def down
     say_with_time("Dropping support functions for pg_search :dmetaphone") do
-      execute <<-'SQL'
-<%= read_sql_file "uninstall_dmetaphone" %>
+      execute <<~'SQL'.squish
+<%= indent(read_sql_file("uninstall_dmetaphone"), 8) %>
       SQL
     end
   end

data/lib/pg_search/migration/templates/create_pg_search_documents.rb.erb

@@ -1,5 +1,5 @@
 class CreatePgSearchDocuments < ActiveRecord::Migration<%= migration_version %>
-  def self.up
+  def up
     say_with_time("Creating table for pg_search multisearch") do
       create_table :pg_search_documents do |t|
         t.text :content
@@ -9,7 +9,7 @@ class CreatePgSearchDocuments < ActiveRecord::Migration<%= migration_version %>
     end
   end
 
-  def self.down
+  def down
     say_with_time("Dropping table for pg_search multisearch") do
       drop_table :pg_search_documents
     end

data/lib/pg_search/model.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module PgSearch
+  module Model
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def pg_search_scope(name, options)
+        options_proc = if options.respond_to?(:call)
+                         options
+                       elsif options.respond_to?(:merge)
+                         ->(query) { { query: query }.merge(options) }
+                       else
+                         raise ArgumentError, 'pg_search_scope expects a Hash or Proc'
+                       end
+
+        define_singleton_method(name) do |*args|
+          config = Configuration.new(options_proc.call(*args), self)
+          scope_options = ScopeOptions.new(config)
+          scope_options.apply(self)
+        end
+      end
+
+      # rubocop:disable ThreadSafety/ClassAndModuleAttributes
+      def multisearchable(options = {})
+        include PgSearch::Multisearchable
+        class_attribute :pg_search_multisearchable_options
+        self.pg_search_multisearchable_options = options
+      end
+      # rubocop:enable ThreadSafety/ClassAndModuleAttributes
+    end
+
+    def method_missing(symbol, *args)
+      case symbol
+      when :pg_search_rank
+        raise PgSearchRankNotSelected unless respond_to?(:pg_search_rank)
+
+        read_attribute(:pg_search_rank).to_f
+      when :pg_search_highlight
+        raise PgSearchHighlightNotSelected unless respond_to?(:pg_search_highlight)
+
+        read_attribute(:pg_search_highlight)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(symbol, *args)
+      case symbol
+      when :pg_search_rank
+        attributes.key?(:pg_search_rank)
+      when :pg_search_highlight
+        attributes.key?(:pg_search_highlight)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/pg_search/multisearch.rb

@@ -5,7 +5,15 @@ require "pg_search/multisearch/rebuilder"
 module PgSearch
   module Multisearch
     class << self
-      def rebuild(model, clean_up = true)
+      def rebuild(model, deprecated_clean_up = nil, clean_up: true)
+        unless deprecated_clean_up.nil?
+          ActiveSupport::Deprecation.warn(
+            "pg_search 3.0 will no longer accept a boolean second argument to PgSearchMultisearch.rebuild, " \
+            "use keyword argument `clean_up:` instead."
+          )
+          clean_up = deprecated_clean_up
+        end
+
         model.transaction do
           PgSearch::Document.where(searchable_type: model.base_class.name).delete_all if clean_up
           Rebuilder.new(model).rebuild
@@ -15,6 +23,7 @@ module PgSearch
 
     class ModelNotMultisearchable < StandardError
       def initialize(model_class)
+        super
         @model_class = model_class
       end
 

data/lib/pg_search/multisearch/rebuilder.rb

@@ -13,7 +13,7 @@ module PgSearch
       def rebuild
         if model.respond_to?(:rebuild_pg_search_documents)
           model.rebuild_pg_search_documents
-        elsif conditional? || dynamic?
+        elsif conditional? || dynamic? || additional_attributes?
           model.find_each(&:update_pg_search_document)
         else
           model.connection.execute(rebuild_sql)
@@ -30,7 +30,11 @@ module PgSearch
 
       def dynamic?
         column_names = model.columns.map(&:name)
-        columns.any? { |column| !column_names.include?(column.to_s) }
+        columns.any? { |column| column_names.exclude?(column.to_s) }
+      end
+
+      def additional_attributes?
+        model.pg_search_multisearchable_options.key?(:additional_attributes)
       end
 
       def connection
@@ -42,7 +46,7 @@ module PgSearch
       end
 
       def rebuild_sql_template
-        <<-SQL.strip_heredoc
+        <<~SQL.squish
           INSERT INTO :documents_table (searchable_type, searchable_id, content, created_at, updated_at)
             SELECT :base_model_name AS searchable_type,
                    :model_table.#{primary_key} AS searchable_id,

data/lib/pg_search/multisearchable.rb

@@ -7,12 +7,12 @@ module PgSearch
     def self.included(mod)
       mod.class_eval do
         has_one :pg_search_document,
-          as: :searchable,
-          class_name: "PgSearch::Document",
-          dependent: :delete
+                as: :searchable,
+                class_name: "PgSearch::Document",
+                dependent: :delete
 
         after_save :update_pg_search_document,
-          if: -> { PgSearch.multisearch_enabled? }
+                   if: -> { PgSearch.multisearch_enabled? }
       end
     end
 

data/lib/pg_search/scope_options.rb

@@ -14,23 +14,15 @@ module PgSearch
 
     def apply(scope)
       scope = include_table_aliasing_for_rank(scope)
-      rank_table_alias = scope.pg_search_rank_table_alias(:include_counter)
+      rank_table_alias = scope.pg_search_rank_table_alias(include_counter: true)
 
       scope
         .joins(rank_join(rank_table_alias))
         .order(Arel.sql("#{rank_table_alias}.rank DESC, #{order_within_rank}"))
-        .extend(DisableEagerLoading)
         .extend(WithPgSearchRank)
         .extend(WithPgSearchHighlight[feature_for(:tsearch)])
     end
 
-    # workaround for https://github.com/Casecommons/pg_search/issues/14
-    module DisableEagerLoading
-      def eager_loading?
-        false
-      end
-    end
-
     module WithPgSearchHighlight
       def self.[](tsearch)
         Module.new do
@@ -66,7 +58,7 @@ module PgSearch
     end
 
     module PgSearchRankTableAliasing
-      def pg_search_rank_table_alias(include_counter = false)
+      def pg_search_rank_table_alias(include_counter: false)
         components = [arel_table.name]
         if include_counter
           count = increment_counter