pg_search 2.3.2 → 2.3.7

data/Rakefile

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
 
-require 'bundler'
+require "bundler"
 Bundler::GemHelper.install_tasks
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
-RuboCop::RakeTask.new do |t|
-  t.options = %w[--display-cop-names]
+require "standard/rake"
+
+desc "Check test coverage"
+task :undercover do
+  system("git fetch --unshallow") if ENV["CI"]
+  exit(1) unless system("bin/undercover --compare origin/master")
 end
 
-task default: %w[spec rubocop]
+task default: %w[spec standard undercover]

data/lib/pg_search/configuration/column.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'digest'
+require "digest"
 
 module PgSearch
   class Configuration
@@ -9,18 +9,20 @@ module PgSearch
 
       def initialize(column_name, weight, model)
         @name = column_name.to_s
-        @column_name = column_name.to_s
+        @column_name = column_name
         @weight = weight
         @model = model
         @connection = model.connection
       end
 
       def full_name
+        return @column_name if @column_name.is_a?(Arel::Nodes::SqlLiteral)
+
         "#{table_name}.#{column_name}"
       end
 
       def to_sql
-        "coalesce(#{expression}::text, '')"
+        "coalesce((#{expression})::text, '')"
       end
 
       private
@@ -30,7 +32,7 @@ module PgSearch
       end
 
       def column_name
-        @connection.quote_column_name(@column_name)
+        @connection.quote_column_name(@name)
       end
 
       def expression

data/lib/pg_search/configuration/foreign_column.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'digest'
+require "digest"
 
 module PgSearch
   class Configuration

data/lib/pg_search/configuration.rb

@@ -80,7 +80,7 @@ module PgSearch
     attr_reader :options
 
     def default_options
-      { using: :tsearch }
+      {using: :tsearch}
     end
 
     VALID_KEYS = %w[
@@ -92,8 +92,11 @@ module PgSearch
     }.freeze
 
     def assert_valid_options(options)
-      unless options[:against] || options[:associated_against]
-        raise ArgumentError, "the search scope #{@name} must have :against or :associated_against in its options"
+      unless options[:against] || options[:associated_against] || using_tsvector_column?(options[:using])
+        raise(
+          ArgumentError,
+          "the search scope #{@name} must have :against, :associated_against, or :tsvector_column in its options"
+        )
       end
 
       options.assert_valid_keys(VALID_KEYS)
@@ -104,5 +107,12 @@ module PgSearch
         end
       end
     end
+
+    def using_tsvector_column?(options)
+      return unless options.is_a?(Hash)
+
+      options.dig(:dmetaphone, :tsvector_column).present? ||
+        options.dig(:tsearch, :tsvector_column).present?
+    end
   end
 end

data/lib/pg_search/document.rb

@@ -1,28 +1,28 @@
 # frozen_string_literal: true
 
-require 'logger'
+require "logger"
 
 module PgSearch
-  class Document < ActiveRecord::Base
+  class Document < ActiveRecord::Base # standard:disable Rails/ApplicationRecord
     include PgSearch::Model
 
-    self.table_name = 'pg_search_documents'
+    self.table_name = "pg_search_documents"
     belongs_to :searchable, polymorphic: true
 
     # 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|
       options = if PgSearch.multisearch_options.respond_to?(:call)
-                  PgSearch.multisearch_options.call(*args)
-                else
-                  { query: args.first }.merge(PgSearch.multisearch_options)
-                end
+        PgSearch.multisearch_options.call(*args)
+      else
+        {query: args.first}.merge(PgSearch.multisearch_options)
+      end
 
-      { against: :content }.merge(options)
+      {against: :content}.merge(options)
     }
   end
 end

data/lib/pg_search/features/dmetaphone.rb

@@ -1,21 +1,19 @@
 # frozen_string_literal: true
 
+require "active_support/core_ext/module/delegation"
+
 module PgSearch
   module Features
     class DMetaphone
       def initialize(query, options, columns, model, normalizer)
         dmetaphone_normalizer = Normalizer.new(normalizer)
-        options = (options || {}).merge(dictionary: 'simple')
+        options = (options || {}).merge(dictionary: "simple")
         @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/feature.rb

@@ -10,7 +10,7 @@ module PgSearch
         %i[only sort_only]
       end
 
-      delegate :connection, :quoted_table_name, to: :'@model'
+      delegate :connection, :quoted_table_name, to: :@model
 
       def initialize(query, options, all_columns, model, normalizer)
         @query = query

data/lib/pg_search/features/trigram.rb

@@ -35,17 +35,17 @@ module PgSearch
 
       def similarity_function
         if word_similarity?
-          'word_similarity'
+          "word_similarity"
         else
-          'similarity'
+          "similarity"
         end
       end
 
       def infix_operator
         if word_similarity?
-          '<%'
+          "<%"
         else
-          '%'
+          "%"
         end
       end
 

data/lib/pg_search/features/tsearch.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 require "active_support/core_ext/module/delegation"
-require 'active_support/deprecation'
+require "active_support/deprecation"
 
 module PgSearch
   module Features
-    class TSearch < Feature # rubocop:disable Metrics/ClassLength
+    class TSearch < Feature
       def self.valid_options
         super + %i[dictionary prefix negation any_word normalization tsvector_column highlight]
       end
@@ -36,12 +36,11 @@ module PgSearch
       end
 
       def ts_headline_options
-        return '' unless options[:highlight].is_a?(Hash)
+        return "" unless options[:highlight].is_a?(Hash)
 
         headline_options
           .merge(deprecated_headline_options)
-          .map { |key, value| "#{key} = #{value}" unless value.nil? }
-          .compact
+          .filter_map { |key, value| "#{key} = #{value}" unless value.nil? }
           .join(", ")
       end
 
@@ -71,9 +70,11 @@ module PgSearch
             unless value.nil?
               key = deprecated_key.camelize
 
-              ActiveSupport::Deprecation.warn(
+              warn(
                 "pg_search 3.0 will no longer accept :#{deprecated_key} as an argument to :ts_headline, " \
-                "use :#{key} instead."
+                "use :#{key} instead.",
+                category: :deprecated,
+                uplevel: 1
               )
 
               hash[key] = ts_headline_option_value(value)
@@ -95,11 +96,11 @@ module PgSearch
         end
       end
 
-      DISALLOWED_TSQUERY_CHARACTERS = /['?\\:‘’]/.freeze
+      DISALLOWED_TSQUERY_CHARACTERS = /['?\\:‘’ʻʼ]/
 
-      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] = ''
+          unsanitized_term[0] = ""
           negated = true
         end
 
@@ -107,33 +108,34 @@ 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("!") 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
         return "''" if query.blank?
 
-        query_terms = query.split(" ").compact
+        query_terms = query.split.compact
         tsquery_terms = query_terms.map { |term| tsquery_for_term(term) }
-        tsquery_terms.join(options[:any_word] ? ' || ' : ' && ')
+        tsquery_terms.join(options[:any_word] ? " || " : " && ")
       end
 
       def tsdocument
@@ -151,7 +153,7 @@ module PgSearch
           end
         end
 
-        tsdocument_terms.join(' || ')
+        tsdocument_terms.join(" || ")
       end
 
       # From http://www.postgresql.org/docs/8.3/static/textsearch-controls.html

data/lib/pg_search/migration/dmetaphone_generator.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'pg_search/migration/generator'
+require "pg_search/migration/generator"
 
 module PgSearch
   module Migration
     class DmetaphoneGenerator < Generator
       def migration_name
-        'add_pg_search_dmetaphone_support_functions'
+        "add_pg_search_dmetaphone_support_functions"
       end
     end
   end

data/lib/pg_search/migration/generator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'active_record'
-require 'rails/generators/base'
+require "active_record"
+require "rails/generators/base"
 
 module PgSearch
   module Migration
@@ -10,19 +10,19 @@ module PgSearch
 
       def self.inherited(subclass)
         super
-        subclass.source_root File.expand_path('templates', __dir__)
+        subclass.source_root File.expand_path("templates", __dir__)
       end
 
       def create_migration
         now = Time.now.utc
-        filename = "#{now.strftime('%Y%m%d%H%M%S')}_#{migration_name}.rb"
+        filename = "#{now.strftime("%Y%m%d%H%M%S")}_#{migration_name}.rb"
         template "#{migration_name}.rb.erb", "db/migrate/#{filename}", migration_version
       end
 
       private
 
       def read_sql_file(filename)
-        sql_directory = File.expand_path('../../../sql', __dir__)
+        sql_directory = File.expand_path("../../../sql", __dir__)
         source_path = File.join(sql_directory, "#{filename}.sql")
         File.read(source_path).strip
       end

data/lib/pg_search/migration/multisearch_generator.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'pg_search/migration/generator'
+require "pg_search/migration/generator"
 
 module PgSearch
   module Migration
     class MultisearchGenerator < Generator
       def migration_name
-        'create_pg_search_documents'
+        "create_pg_search_documents"
       end
     end
   end

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

@@ -7,12 +7,12 @@ module PgSearch
     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
+          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)

data/lib/pg_search/multisearch/rebuilder.rb

@@ -30,7 +30,7 @@ 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?
@@ -46,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/multisearch.rb

@@ -5,16 +5,35 @@ require "pg_search/multisearch/rebuilder"
 module PgSearch
   module Multisearch
     class << self
-      def rebuild(model, clean_up = true)
-        model.transaction do
-          PgSearch::Document.where(searchable_type: model.base_class.name).delete_all if clean_up
-          Rebuilder.new(model).rebuild
+      def rebuild(model, deprecated_clean_up = nil, clean_up: true, transactional: true)
+        unless deprecated_clean_up.nil?
+          warn(
+            "pg_search 3.0 will no longer accept a boolean second argument to PgSearchMultisearch.rebuild, " \
+            "use keyword argument `clean_up:` instead.",
+            category: :deprecated,
+            uplevel: 1
+          )
+          clean_up = deprecated_clean_up
         end
+
+        if transactional
+          model.transaction { execute(model, clean_up) }
+        else
+          execute(model, clean_up)
+        end
+      end
+
+      private
+
+      def execute(model, clean_up)
+        PgSearch::Document.where(searchable_type: model.base_class.name).delete_all if clean_up
+        Rebuilder.new(model).rebuild
       end
     end
 
     class ModelNotMultisearchable < StandardError
       def initialize(model_class)
+        super
         @model_class = model_class
       end
 

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
 
@@ -39,7 +39,7 @@ module PgSearch
       conditions.all? { |condition| condition.to_proc.call(self) }
     end
 
-    def update_pg_search_document # rubocop:disable Metrics/AbcSize
+    def update_pg_search_document
       if_conditions = Array(pg_search_multisearchable_options[:if])
       unless_conditions = Array(pg_search_multisearchable_options[:unless])
 
@@ -50,7 +50,7 @@ module PgSearch
       if should_have_document
         create_or_update_pg_search_document
       else
-        pg_search_document&.destroy
+        pg_search_document&.destroy # standard:disable Rails/SaveBang
       end
     end
 
@@ -58,7 +58,7 @@ module PgSearch
       if !pg_search_document
         create_pg_search_document(pg_search_document_attrs)
       elsif should_update_pg_search_document?
-        pg_search_document.update(pg_search_document_attrs)
+        pg_search_document.update(pg_search_document_attrs) # standard:disable Rails/SaveBang
       end
     end
   end

data/lib/pg_search/normalizer.rb

@@ -10,11 +10,11 @@ module PgSearch
       return sql_expression unless config.ignore.include?(:accents)
 
       sql_node = case sql_expression
-                 when Arel::Nodes::Node
-                   sql_expression
-                 else
-                   Arel.sql(sql_expression)
-                 end
+      when Arel::Nodes::Node
+        sql_expression
+      else
+        Arel.sql(sql_expression)
+      end
 
       Arel::Nodes::NamedFunction.new(
         PgSearch.unaccent_function,

data/lib/pg_search/scope_options.rb

@@ -14,7 +14,7 @@ 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))
@@ -37,11 +37,8 @@ module PgSearch
 
       def with_pg_search_highlight
         scope = self
-        scope.select(pg_search_highlight_field)
-      end
-
-      def pg_search_highlight_field
-        "(#{highlight}) AS pg_search_highlight, #{table_name}.*"
+        scope = scope.select("#{table_name}.*") unless scope.select_values.any?
+        scope.select("(#{highlight}) AS pg_search_highlight")
       end
 
       def highlight
@@ -58,7 +55,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
@@ -93,11 +90,32 @@ module PgSearch
     end
 
     def conditions
-      config.features
-            .reject { |_feature_name, feature_options| feature_options && feature_options[:sort_only] }
-            .map { |feature_name, _feature_options| feature_for(feature_name).conditions }
-            .inject { |accumulator, expression| Arel::Nodes::Or.new(accumulator, expression) }
+      expressions =
+        config.features
+          .reject { |_feature_name, feature_options| feature_options && feature_options[:sort_only] }
+          .map { |feature_name, _feature_options| feature_for(feature_name).conditions }
+
+      or_node(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"
@@ -111,7 +129,7 @@ module PgSearch
       if config.associations.any?
         config.associations.map do |association|
           association.join(primary_key)
-        end.join(' ')
+        end.join(" ")
       end
     end
 
@@ -152,7 +170,7 @@ module PgSearch
       return scope if scope.included_modules.include?(PgSearchRankTableAliasing)
 
       scope.all.spawn.tap do |new_scope|
-        new_scope.class_eval { include PgSearchRankTableAliasing }
+        new_scope.instance_eval { extend PgSearchRankTableAliasing }
       end
     end
   end