pg_search 2.1.2 → 2.3.6

data/lib/pg_search/scope_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_support/core_ext/module/delegation"
 
 module PgSearch
@@ -12,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?
-        return false
-      end
-    end
-
     module WithPgSearchHighlight
       def self.[](tsearch)
         Module.new do
@@ -38,16 +32,13 @@ 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
         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
@@ -64,10 +55,10 @@ 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 = pg_search_scope_application_count_plus_plus
+          count = increment_counter
           components << count if count > 0
         end
 
@@ -76,22 +67,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 +90,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 +113,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 +137,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,8 +147,9 @@ 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 }
+        new_scope.instance_eval { extend PgSearchRankTableAliasing }
       end
     end
   end

data/lib/pg_search/tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake'
 require 'pg_search'
 
@@ -5,10 +7,12 @@ namespace :pg_search do
   namespace :multisearch 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
+      raise ArgumentError, <<~MESSAGE unless args.model
+
         You must pass a model as an argument.
         Example: rake pg_search:multisearch:rebuild[BlogPost]
       MESSAGE
+
       model_class = args.model.classify.constantize
       connection = PgSearch::Document.connection
       original_schema_search_path = connection.schema_search_path

data/lib/pg_search/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PgSearch
-  VERSION = "2.1.2".freeze
+  VERSION = '2.3.6'
 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"
@@ -5,6 +7,7 @@ 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"
@@ -12,7 +15,17 @@ require "pg_search/scope_options"
 require "pg_search/version"
 
 module PgSearch
-  extend ActiveSupport::Concern
+  autoload :Document, "pg_search/document"
+
+  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.
+
+      Please replace `include PgSearch` with `include PgSearch::Model`.
+    MESSAGE
+
+    base.include PgSearch::Model
+  end
 
   mattr_accessor :multisearch_options
   self.multisearch_options = {}
@@ -20,29 +33,6 @@ module PgSearch
   mattr_accessor :unaccent_function
   self.unaccent_function = "unaccent"
 
-  module ClassMethods
-    def pg_search_scope(name, options)
-      options_proc = if options.respond_to?(:call)
-                       options
-                     else
-                       raise ArgumentError, "pg_search_scope expects a Hash or Proc" unless options.respond_to?(:merge)
-                       ->(query) { {:query => query}.merge(options) }
-                     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 # rubocop:disable Style/MixinUsage
-      class_attribute :pg_search_multisearchable_options
-      self.pg_search_multisearchable_options = options
-    end
-  end
-
   class << self
     def multisearch(*args)
       PgSearch::Document.search(*args)
@@ -64,47 +54,19 @@ module PgSearch
     end
   end
 
-  def method_missing(symbol, *args)
-    case symbol
-    when :pg_search_rank
-      raise PgSearchRankNotSelected.new 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)
-      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 " \
-      "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
 
-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/pg_search.gemspec

@@ -1,32 +1,40 @@
-$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|
+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     = %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.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.add_dependency 'activerecord', '>= 4.2'
-  s.add_dependency 'activesupport', '>= 4.2'
-  s.add_dependency 'arel', '>= 6'
+  s.add_dependency 'activerecord', '>= 5.2'
+  s.add_dependency 'activesupport', '>= 5.2'
 
-  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 '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 'with_model', '>= 1.2'
+  s.add_development_dependency 'simplecov-lcov'
+  s.add_development_dependency 'undercover'
+  s.add_development_dependency 'warning'
+  s.add_development_dependency 'with_model'
 
-  s.required_ruby_version = '>= 2.1'
+  s.required_ruby_version = '>= 2.6'
 end

data/spec/.rubocop.yml

@@ -1,10 +1,10 @@
 inherit_from:
   - ../.rubocop.yml
 
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: false
 
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Enabled: false
 
 Lint/UselessAssignment:

data/spec/integration/.rubocop.yml

@@ -0,0 +1,11 @@
+inherit_from:
+  - ../.rubocop.yml
+
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false