pg_search 2.3.5 → 2.3.7

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
 
@@ -59,7 +58,7 @@ module PgSearch
         end
       end
 
-      def deprecated_headline_options # rubocop:disable Metrics/MethodLength
+      def deprecated_headline_options
         indifferent_options = options.with_indifferent_access
 
         %w[
@@ -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)
         if options[:negation] && unsanitized_term.start_with?("!")
-          unsanitized_term[0] = ''
+          unsanitized_term[0] = ""
           negated = true
         end
 
@@ -117,7 +118,7 @@ module PgSearch
       # 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(" '"),
@@ -132,9 +133,9 @@ module PgSearch
       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
@@ -152,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/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.rb

@@ -5,20 +5,30 @@ require "pg_search/multisearch/rebuilder"
 module PgSearch
   module Multisearch
     class << self
-      def rebuild(model, deprecated_clean_up = nil, clean_up: true)
+      def rebuild(model, deprecated_clean_up = nil, clean_up: true, transactional: true)
         unless deprecated_clean_up.nil?
-          ActiveSupport::Deprecation.warn(
+          warn(
             "pg_search 3.0 will no longer accept a boolean second argument to PgSearchMultisearch.rebuild, " \
-            "use keyword argument `clean_up:` instead."
+            "use keyword argument `clean_up:` instead.",
+            category: :deprecated,
+            uplevel: 1
           )
           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
+        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

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

@@ -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
@@ -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
 

data/lib/pg_search/tasks.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rake'
-require 'pg_search'
+require "rake"
+require "pg_search"
 
 namespace :pg_search do
   namespace :multisearch do

data/lib/pg_search/version.rb

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

data/lib/pg_search.rb

@@ -18,7 +18,7 @@ module PgSearch
   autoload :Document, "pg_search/document"
 
   def self.included(base)
-    ActiveSupport::Deprecation.warn <<~MESSAGE
+    warn(<<~MESSAGE, category: :deprecated, uplevel: 1)
       Directly including `PgSearch` into an Active Record model is deprecated and will be removed in pg_search 3.0.
 
       Please replace `include PgSearch` with `include PgSearch::Model`.
@@ -34,8 +34,8 @@ module PgSearch
   self.unaccent_function = "unaccent"
 
   class << self
-    def multisearch(*args)
-      PgSearch::Document.search(*args)
+    def multisearch(...)
+      PgSearch::Document.search(...)
     end
 
     def disable_multisearch
@@ -57,14 +57,14 @@ module PgSearch
   class PgSearchRankNotSelected < StandardError
     def message
       "You must chain .with_pg_search_rank after the pg_search_scope " \
-      "to access the pg_search_rank attribute on returned records"
+        "to access the pg_search_rank attribute on returned records"
     end
   end
 
   class PgSearchHighlightNotSelected < StandardError
     def message
       "You must chain .with_pg_search_highlight after the pg_search_scope " \
-      "to access the pg_search_highlight attribute on returned records"
+        "to access the pg_search_highlight attribute on returned records"
     end
   end
 end

data/pg_search.gemspec

@@ -1,37 +1,25 @@
 # frozen_string_literal: true
 
-$LOAD_PATH.push File.expand_path('lib', __dir__)
-require 'pg_search/version'
+$LOAD_PATH.push File.expand_path("lib", __dir__)
+require "pg_search/version"
 
-Gem::Specification.new do |s| # rubocop:disable Metrics/BlockLength
-  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.homepage    = 'https://github.com/Casecommons/pg_search'
-  s.summary     = "PgSearch builds Active Record named scopes that take advantage of PostgreSQL's full text search"
+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.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"
-  s.licenses    = ['MIT']
+  s.licenses = ["MIT"]
+  s.metadata["rubygems_mfa_required"] = "true"
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- spec/*`.split("\n")
-  s.require_paths = ['lib']
+  s.files = `git ls-files -z`.split("\x0")
+  s.require_paths = ["lib"]
 
-  s.add_dependency 'activerecord', '>= 5.2'
-  s.add_dependency 'activesupport', '>= 5.2'
+  s.add_dependency "activerecord", ">= 6.1"
+  s.add_dependency "activesupport", ">= 6.1"
 
-  s.add_development_dependency 'pry'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rubocop'
-  s.add_development_dependency 'rubocop-performance'
-  s.add_development_dependency 'rubocop-rails'
-  s.add_development_dependency 'rubocop-rake'
-  s.add_development_dependency 'rubocop-rspec'
-  s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'warning'
-  s.add_development_dependency 'with_model'
-
-  s.required_ruby_version = '>= 2.5'
+  s.required_ruby_version = ">= 3.0"
 end

data/spec/.rubocop.yml

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

data/spec/integration/.rubocop.yml

@@ -4,8 +4,8 @@ inherit_from:
 RSpec/DescribeClass:
   Enabled: false
 
-RSpec/MultipleExpectations:
+RSpec/ExampleLength:
   Enabled: false
 
-RSpec/ExampleLength:
+RSpec/MultipleExpectations:
   Enabled: false