pg_search 2.1.2 → 2.2.0

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
@@ -9,8 +11,4 @@ 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']
-end
-
-task :default => %w[spec codeclimate rubocop]
+task default: %w[spec rubocop]

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,8 +88,8 @@ module PgSearch
     ].map(&:to_sym)
 
     VALID_VALUES = {
-      :ignoring => [:accents]
-    }
+      ignoring: [:accents]
+    }.freeze
 
     def assert_valid_options(options)
       unless options[:against] || options[:associated_against]

data/lib/pg_search/document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 
 module PgSearch
@@ -5,7 +7,7 @@ module PgSearch
     include PgSearch
 
     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
@@ -17,10 +19,10 @@ module PgSearch
       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,9 +1,11 @@
+# frozen_string_literal: true
+
 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
 

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'
 
@@ -93,7 +95,7 @@ module PgSearch
         end
       end
 
-      DISALLOWED_TSQUERY_CHARACTERS = /['?\\:]/
+      DISALLOWED_TSQUERY_CHARACTERS = /['?\\:‘’]/.freeze
 
       def tsquery_for_term(unsanitized_term) # rubocop:disable Metrics/AbcSize
         if options[:negation] && unsanitized_term.start_with?("!")
@@ -128,6 +130,7 @@ module PgSearch
 
       def tsquery
         return "''" if query.blank?
+
         query_terms = query.split(" ").compact
         tsquery_terms = query_terms.map { |term| tsquery_for_term(term) }
         tsquery_terms.join(options[:any_word] ? ' || ' : ' && ')

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/create_pg_search_documents.rb.erb

@@ -3,7 +3,7 @@ class CreatePgSearchDocuments < ActiveRecord::Migration<%= migration_version %>
     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

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
@@ -12,7 +14,7 @@ module PgSearch
         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 }
+          model.find_each(&:update_pg_search_document)
         else
           model.connection.execute(rebuild_sql)
         end
@@ -74,7 +76,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,11 +1,13 @@
+# frozen_string_literal: true
+
 require "pg_search/multisearch/rebuilder"
 
 module PgSearch
   module Multisearch
     class << self
-      def rebuild(model, clean_up=true)
+      def rebuild(model, clean_up = true)
         model.transaction do
-          PgSearch::Document.where(:searchable_type => model.base_class.name).delete_all if clean_up
+          PgSearch::Document.where(searchable_type: model.base_class.name).delete_all if clean_up
           Rebuilder.new(model).rebuild
         end
       end
@@ -22,5 +24,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

data/lib/pg_search/scope_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/core_ext/module/delegation"
 
 module PgSearch
@@ -17,18 +19,10 @@ module PgSearch
       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?
-        return false
-      end
-    end
-
     module WithPgSearchHighlight
       def self.[](tsearch)
         Module.new do
@@ -38,7 +32,7 @@ module PgSearch
       end
 
       def tsearch
-        raise TypeError.new("You need to instantiate this module with []")
+        raise TypeError, "You need to instantiate this module with []"
       end
 
       def with_pg_search_highlight
@@ -67,7 +61,7 @@ module PgSearch
       def pg_search_rank_table_alias(include_counter = false)
         components = [arel_table.name]
         if include_counter
-          count = pg_search_scope_application_count_plus_plus
+          count = increment_counter
           components << count if count > 0
         end
 
@@ -76,22 +70,16 @@ module PgSearch
 
       private
 
-      attr_writer :pg_search_scope_application_count
-
-      def pg_search_scope_application_count
-        @pg_search_scope_application_count ||= 0
-      end
-
-      def pg_search_scope_application_count_plus_plus
-        count = pg_search_scope_application_count
-        self.pg_search_scope_application_count = pg_search_scope_application_count + 1
-        count
+      def increment_counter
+        @counter ||= 0
+      ensure
+        @counter += 1
       end
     end
 
     private
 
-    delegate :connection, :quoted_table_name, :to => :model
+    delegate :connection, :quoted_table_name, to: :model
 
     def subquery
       model
@@ -105,19 +93,10 @@ module PgSearch
     end
 
     def conditions
-      conditions = config.features.reject do |_feature_name, feature_options|
-        feature_options && feature_options[:sort_only]
-      end
-
-      conditions.map! do |feature_name, _feature_options|
-        feature_for(feature_name).conditions
-      end
-
-      conditions = conditions.inject do |accumulator, expression|
-        Arel::Nodes::Or.new(accumulator, expression)
-      end
-
-      conditions.to_sql
+      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) }
     end
 
     def order_within_rank
@@ -137,16 +116,16 @@ module PgSearch
     end
 
     FEATURE_CLASSES = {
-      :dmetaphone => Features::DMetaphone,
-      :tsearch => Features::TSearch,
-      :trigram => Features::Trigram
-    }
+      dmetaphone: Features::DMetaphone,
+      tsearch: Features::TSearch,
+      trigram: Features::Trigram
+    }.freeze
 
-    def feature_for(feature_name) # rubocop:disable Metrics/AbcSize
+    def feature_for(feature_name)
       feature_name = feature_name.to_sym
       feature_class = FEATURE_CLASSES[feature_name]
 
-      raise ArgumentError.new("Unknown feature: #{feature_name}") unless feature_class
+      raise ArgumentError, "Unknown feature: #{feature_name}" unless feature_class
 
       normalizer = Normalizer.new(config)
 
@@ -161,7 +140,7 @@ module PgSearch
 
     def rank
       (config.ranking_sql || ":tsearch").gsub(/:(\w*)/) do
-        feature_for($1).rank.to_sql
+        feature_for(Regexp.last_match(1)).rank.to_sql
       end
     end
 
@@ -171,6 +150,7 @@ module PgSearch
 
     def include_table_aliasing_for_rank(scope)
       return scope if scope.included_modules.include?(PgSearchRankTableAliasing)
+
       scope.all.spawn.tap do |new_scope|
         new_scope.class_eval { include PgSearchRankTableAliasing }
       end

data/lib/pg_search/tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake'
 require 'pg_search'
 
@@ -6,6 +8,7 @@ namespace :pg_search do
     desc "Rebuild PgSearch multisearch records for a given model"
     task :rebuild, %i[model schema] => :environment do |_task, args|
       raise ArgumentError, <<-MESSAGE.strip_heredoc unless args.model
+
         You must pass a model as an argument.
         Example: rake pg_search:multisearch:rebuild[BlogPost]
       MESSAGE

data/lib/pg_search/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PgSearch
-  VERSION = "2.1.2".freeze
+  VERSION = '2.2.0'
 end

data/lib/pg_search.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_record"
 require "active_support/concern"
 require "active_support/core_ext/module/attribute_accessors"
@@ -24,9 +26,10 @@ module PgSearch
     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" unless options.respond_to?(:merge)
-                       ->(query) { {:query => query}.merge(options) }
+                       raise ArgumentError, 'pg_search_scope expects a Hash or Proc'
                      end
 
       define_singleton_method(name) do |*args|
@@ -37,7 +40,7 @@ module PgSearch
     end
 
     def multisearchable(options = {})
-      include PgSearch::Multisearchable # rubocop:disable Style/MixinUsage
+      include PgSearch::Multisearchable
       class_attribute :pg_search_multisearchable_options
       self.pg_search_multisearchable_options = options
     end
@@ -67,10 +70,12 @@ module PgSearch
   def method_missing(symbol, *args)
     case symbol
     when :pg_search_rank
-      raise PgSearchRankNotSelected.new unless respond_to?(:pg_search_rank)
+      raise PgSearchRankNotSelected unless respond_to?(:pg_search_rank)
+
       read_attribute(:pg_search_rank).to_f
     when :pg_search_highlight
-      raise PgSearchHighlightNotSelected.new unless respond_to?(:pg_search_highlight)
+      raise PgSearchHighlightNotSelected unless respond_to?(:pg_search_highlight)
+
       read_attribute(:pg_search_highlight)
     else
       super

data/pg_search.gemspec

@@ -1,4 +1,6 @@
-$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'pg_search/version'
 
 Gem::Specification.new do |s|
@@ -8,8 +10,8 @@ Gem::Specification.new do |s|
   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     = %q(PgSearch builds Active Record named scopes that take advantage of PostgreSQL's full text search)
-  s.description = %q(PgSearch builds Active Record named scopes that take advantage of PostgreSQL's full text 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.files         = `git ls-files`.split("\n")
@@ -18,15 +20,14 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'activerecord', '>= 4.2'
   s.add_dependency 'activesupport', '>= 4.2'
-  s.add_dependency 'arel', '>= 6'
 
-  s.add_development_dependency 'codeclimate-test-reporter'
   s.add_development_dependency 'pry'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '>= 3.3'
-  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'rubocop', '>= 0.68.1'
+  s.add_development_dependency 'rubocop-performance'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'with_model', '>= 1.2'
 
-  s.required_ruby_version = '>= 2.1'
+  s.required_ruby_version = '>= 2.4'
 end