pg_search 2.1.2 → 2.3.6

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
@@ -9,8 +11,10 @@ RuboCop::RakeTask.new do |t|
   t.options = %w[--display-cop-names]
 end
 
-task :codeclimate do
-  sh 'bin/codeclimate-test-reporter' if ENV['CODECLIMATE_REPO_TOKEN']
+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 codeclimate rubocop]
+task default: %w[spec rubocop undercover]

data/lib/pg_search/configuration/association.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "digest"
 
 module PgSearch

data/lib/pg_search/configuration/column.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'digest'
 
 module PgSearch

data/lib/pg_search/configuration/foreign_column.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'digest'
 
 module PgSearch

data/lib/pg_search/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pg_search/configuration/association"
 require "pg_search/configuration/column"
 require "pg_search/configuration/foreign_column"
@@ -17,7 +19,7 @@ module PgSearch
       def alias(*strings)
         name = Array(strings).compact.join("_")
         # By default, PostgreSQL limits names to 32 characters, so we hash and limit to 32 characters.
-        "pg_search_#{Digest::SHA2.hexdigest(name)}"[0,32]
+        "pg_search_#{Digest::SHA2.hexdigest(name)}".first(32)
       end
     end
 
@@ -27,6 +29,7 @@ module PgSearch
 
     def regular_columns
       return [] unless options[:against]
+
       Array(options[:against]).map do |column_name, weight|
         Column.new(column_name, weight, model)
       end
@@ -34,6 +37,7 @@ module PgSearch
 
     def associations
       return [] unless options[:associated_against]
+
       options[:associated_against].map do |association, column_names|
         Association.new(model, association, column_names)
       end.flatten
@@ -76,7 +80,7 @@ module PgSearch
     attr_reader :options
 
     def default_options
-      {:using => :tsearch}
+      { using: :tsearch }
     end
 
     VALID_KEYS = %w[
@@ -84,12 +88,15 @@ module PgSearch
     ].map(&:to_sym)
 
     VALID_VALUES = {
-      :ignoring => [:accents]
-    }
+      ignoring: [:accents]
+    }.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)
@@ -100,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,26 +1,28 @@
+# frozen_string_literal: true
+
 require 'logger'
 
 module PgSearch
   class Document < ActiveRecord::Base
-    include PgSearch
+    include PgSearch::Model
 
     self.table_name = 'pg_search_documents'
-    belongs_to :searchable, :polymorphic => true
+    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)
+                  { 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,19 +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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/core_ext/module/delegation"
 require "active_support/core_ext/hash/keys"
 
@@ -8,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
@@ -23,7 +25,7 @@ module PgSearch
       attr_reader :query, :options, :all_columns, :model, :normalizer
 
       def document
-        columns.map { |column| column.to_sql }.join(" || ' ' || ")
+        columns.map(&:to_sql).join(" || ' ' || ")
       end
 
       def columns

data/lib/pg_search/features/trigram.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module PgSearch
   module Features
     class Trigram < Feature
       def self.valid_options
-        super + [:threshold]
+        super + %i[threshold word_similarity]
       end
 
       def conditions
@@ -12,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
@@ -23,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/core_ext/module/delegation"
 require 'active_support/deprecation'
 
@@ -57,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[
@@ -93,9 +95,9 @@ module PgSearch
         end
       end
 
-      DISALLOWED_TSQUERY_CHARACTERS = /['?\\:]/
+      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
@@ -105,30 +107,32 @@ 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
         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] ? ' || ' : ' && ')
       end

data/lib/pg_search/features.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "pg_search/features/feature"
 
 require "pg_search/features/dmetaphone"

data/lib/pg_search/migration/dmetaphone_generator.rb

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

data/lib/pg_search/migration/generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_record'
 require 'rails/generators/base'
 
@@ -8,7 +10,7 @@ module PgSearch
 
       def self.inherited(subclass)
         super
-        subclass.source_root File.expand_path('../templates', __FILE__)
+        subclass.source_root File.expand_path('templates', __dir__)
       end
 
       def create_migration
@@ -20,7 +22,7 @@ module PgSearch
       private
 
       def read_sql_file(filename)
-        sql_directory = File.expand_path('../../../../sql', __FILE__)
+        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,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pg_search/migration/generator'
 
 module PgSearch
@@ -9,4 +11,3 @@ module PgSearch
     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,15 +1,15 @@
 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
-        t.belongs_to :searchable, :polymorphic => true, :index => true
+        t.belongs_to :searchable, polymorphic: true, index: true
         t.timestamps null: false
       end
     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,57 @@
+# 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
+
+      def multisearchable(options = {})
+        include PgSearch::Multisearchable
+        class_attribute :pg_search_multisearchable_options
+        self.pg_search_multisearchable_options = options
+      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
+  end
+end

data/lib/pg_search/multisearch/rebuilder.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module PgSearch
   module Multisearch
     class Rebuilder
       def initialize(model, time_source = Time.method(:now))
-        raise ModelNotMultisearchable.new(model) unless model.respond_to?(:pg_search_multisearchable_options)
+        raise ModelNotMultisearchable, model unless model.respond_to?(:pg_search_multisearchable_options)
 
         @model = model
         @time_source = time_source
@@ -11,8 +13,8 @@ module PgSearch
       def rebuild
         if model.respond_to?(:rebuild_pg_search_documents)
           model.rebuild_pg_search_documents
-        elsif conditional? || dynamic?
-          model.find_each { |record| record.update_pg_search_document }
+        elsif conditional? || dynamic? || additional_attributes?
+          model.find_each(&:update_pg_search_document)
         else
           model.connection.execute(rebuild_sql)
         end
@@ -28,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
@@ -40,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,
@@ -74,7 +80,9 @@ module PgSearch
       end
 
       def content_expressions
-        columns.map { |column| %{coalesce(:model_table.#{column}::text, '')} }.join(" || ' ' || ")
+        columns.map do |column|
+          %{coalesce(:model_table.#{connection.quote_column_name(column)}::text, '')}
+        end.join(" || ' ' || ")
       end
 
       def columns

data/lib/pg_search/multisearch.rb

@@ -1,18 +1,37 @@
+# frozen_string_literal: true
+
 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?
+          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
+
+        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
 
@@ -22,5 +41,3 @@ module PgSearch
     end
   end
 end
-
-

data/lib/pg_search/multisearchable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/core_ext/class/attribute"
 
 module PgSearch
@@ -5,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
 
@@ -31,6 +33,8 @@ module PgSearch
     end
 
     def should_update_pg_search_document?
+      return false if pg_search_document.destroyed?
+
       conditions = Array(pg_search_multisearchable_options[:update_if])
       conditions.all? { |condition| condition.to_proc.call(self) }
     end
@@ -46,7 +50,7 @@ module PgSearch
       if should_have_document
         create_or_update_pg_search_document
       else
-        pg_search_document.destroy if pg_search_document
+        pg_search_document&.destroy
       end
     end
 
@@ -54,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_attributes(pg_search_document_attrs)
+        pg_search_document.update(pg_search_document_attrs)
       end
     end
   end

data/lib/pg_search/normalizer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PgSearch
   class Normalizer
     def initialize(config)

data/lib/pg_search/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PgSearch
   class Railtie < Rails::Railtie
     rake_tasks do