pg_search 2.3.2 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c16f0c4421b4d6d6f4c247f556c4eb2fdb01242617a1e960fdd15785be84dbf
-  data.tar.gz: f580e760db34c55abf2401176681f8053500e3d249dd51edf8dce0dfb251f641
+  metadata.gz: 1c754738322b4dea0ecf3f70b8ddb03c5ff26bbe0f44578f6870c9f0e9fe6604
+  data.tar.gz: 4d8dc4be9b36a8a35cbaf6c759f9e973242e60c6b2eaf03b92d177297a7ad2b1
 SHA512:
-  metadata.gz: f649091265d7b174c6b826a38e1f80f5eb57851184d2af4720926982d42c41ee1a4bc9399ca0cb1031c31f9a40313215cced168cb99d0a1cf65000fd7c4c6be9
-  data.tar.gz: 42c651d0689300bd1328089814562fe575a43d3cf522365b51f2de828eb33cc55d7eab69d242d525228e62d46bc99f74391e0569c4ef4cd39f27bbaec5deb073
+  metadata.gz: '09b9d4b415a215bf24e38f1f3c80b309aaf7c4c52774e463f07db9f70496bf6bfde3bbd3fd0c69a4872ab531dc7a7fff098b6c11b1b7f5f0134b41e8feb73e4b'
+  data.tar.gz: a41a81af41368584b5cc4bbb6174c800e9d5dca906630db567cb908aa4280f921f2a1d579805d008dc77011b16d3b7ca5e025357cb0d51f777bd54cf848b8bc3

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"

data/.rubocop.yml

@@ -1,7 +1,13 @@
-require: rubocop-performance
+require:
+  - rubocop-performance
+  - rubocop-rails
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-thread_safety
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
+  NewCops: enable
   Exclude:
     - bin/**/*
     - vendor/**/*
@@ -13,7 +19,7 @@ Layout/LineLength:
   Max: 120
 
 Metrics/MethodLength:
-  Max: 21
+  Max: 15
 
 Metrics/BlockLength:
   Exclude:
@@ -44,7 +50,7 @@ Bundler/DuplicatedGem:
 
 Style/EmptyMethod:
   EnforcedStyle: expanded
-  
+
 Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
 
@@ -54,3 +60,79 @@ Style/Documentation:
 Style/WordArray:
   EnforcedStyle: percent
   MinSize: 3
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Rails/ApplicationRecord:
+  Enabled: false
+
+Rails/TimeZone:
+  Enabled: false
+
+RSpec/ContextWording:
+  Prefixes:
+    - using
+    - via
+    - when
+    - with
+    - without
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+RSpec/DescribedClass:
+  Enabled: true
+
+RSpec/ExpectInHook:
+  Enabled: false
+
+RSpec/FilePath:
+  CustomTransform:
+    TSearch: "tsearch"
+    DMetaphone: "dmetaphone"
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+RSpec/MultipleMemoizedHelpers:
+  AllowSubject: true
+
+RSpec/ExampleLength:
+  Max: 15

data/.travis.yml

@@ -3,11 +3,10 @@ bundler_args: --binstubs
 cache: bundler
 
 rvm:
-  - 2.7.0
-  - 2.6.5
-  - 2.5.7
-  - 2.4.9
-  - jruby-9.2.8.0
+  - 2.7.1
+  - 2.6.6
+  - 2.5.8
+  - jruby-9.2.11.1
 
 env:
   global:
@@ -23,13 +22,6 @@ matrix:
   allow_failures:
     - env: ACTIVE_RECORD_BRANCH="master"
     - env: ACTIVE_RECORD_BRANCH="6-0-stable"
-  exclude:
-    - rvm: 2.4.9
-      env: ACTIVE_RECORD_BRANCH="master"
-    - rvm: 2.4.9
-      env: ACTIVE_RECORD_VERSION="~> 6.0.0"
-    - rvm: 2.4.9
-    - env: ACTIVE_RECORD_BRANCH="6-0-stable"
 
 before_script:
   - psql --version

data/CHANGELOG.md

@@ -1,62 +1,67 @@
 # pg_search changelog
 
+## 2.3.3
+
+* Drop support for Ruby < 2.5.
+* Use keyword argument for `clean_up` setting in `PgSearch::Multisearch.rebuild`.
+
 ## 2.3.2
 
-* Autoload PgSearch::Document to prevent it from being loaded in projects that are not using multi-search.
-* Rebuilder should use update_pg_search_document if additional_attributes is set (David Ramalho)
+* Autoload `PgSearch::Document` to prevent it from being loaded in projects that are not using multi-search.
+* Rebuilder should use `update_pg_search_document` if `additional_attributes` is set. (David Ramalho)
 
 ## 2.3.1
 
-* Drop support for Active Record < 5.2
-* Do not load railtie unless Rails::Railtie is defined, to avoid problem when loading alongside Action Mailer (Adam Schwartz)
+* Drop support for Active Record < 5.2.
+* Do not load railtie unless Rails::Railtie is defined, to avoid problem when loading alongside Action Mailer. (Adam Schwartz)
 
 ## 2.3.0
 
-* Extract `PgSearch::Model` module
+* Extract `PgSearch::Model` module.
 * Deprecate `include PgSearch`. Use `include PgSearch::Model` instead.
 
 ## 2.2.0
 
-* Add word_similarity option to trigram search (Severin Räz)
+* Add `word_similarity` option to trigram search. (Severin Räz)
 
 ## 2.1.7
 
-* Restore link to GitHub repository to original location
+* Restore link to GitHub repository to original location.
 
 ## 2.1.6
 
-* Update link to GitHub repository to new location
+* Update link to GitHub repository to new location.
 
 ## 2.1.5
 
-* Drop support for Ruby < 2.4
+* Drop support for Ruby < 2.4.
 
 ## 2.1.4
 
-* Drop support for Ruby < 2.3
-* Use update instead of deprecated update_attributes
-* Remove explicit arel dependency to better support Active Record 6 beta
+* Drop support for Ruby < 2.3.
+* Use `update` instead of deprecated `update_attributes`.
+* Remove explicit Arel dependency to better support Active Record 6 beta.
 
 ## 2.1.3
 
 * Drop support for Ruby < 2.2
-* Disallow left/right single quotation marks in tsquery (Fabian Schwahn) (#382)
-* Do not attempt to save an already-destroy PgSearch::Document (Oleg Dashevskii, Vokhmin Aleksei V) (#353)
-* Quote column name when rebuilding (Jed Levin) (#379)
+* Disallow left/right single quotation marks in tsquery. (Fabian Schwahn) (#382)
+* Do not attempt to save an already-destroyed `PgSearch::Document`. (Oleg Dashevskii, Vokhmin Aleksei V) (#353)
+* Quote column name when rebuilding. (Jed Levin) (#379)
 
 ## 2.1.2
 
-* Silence warnings in Rails 5.2.0.beta2 (Kevin Deisz)
+* Silence warnings in Rails 5.2.0.beta2. (Kevin Deisz)
 
 ## 2.1.1
 
-* Support snake_case ts_headline options again (with deprecation warning)
+* Support snake_case `ts_headline` options again. (with deprecation warning)
 
 ## 2.1.0
 
-* Allow ts_headline options to be passed to :highlight (Ian Heisters)
-* Wait to load PgSearch::Document until after Active Record has loaded (Logan Leger)
-* Add Rails version to generated migrations (Erik Eide)
+* Allow `ts_headline` options to be passed to `:highlight`. (Ian Heisters)
+* Wait to load `PgSearch::Document` until after Active Record has loaded. (Logan Leger)
+* Add Rails version to generated migrations. (Erik Eide)
 
 ## 2.0.1
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2019 Casebook, PBC <http://www.casebook.net>
+Copyright (c) 2010-2020 Casebook, PBC <http://www.casebook.net>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -16,7 +16,7 @@ Read the blog post introducing PgSearch at https://content.pivotal.io/blog/pg-se
 
 ## REQUIREMENTS
 
-*   Ruby 2.4+
+*   Ruby 2.5+
 *   ActiveRecord 5.2+
 *   PostgreSQL 9.2+
 *   [PostgreSQL extensions](https://github.com/Casecommons/pg_search/wiki/Installing-PostgreSQL-Extensions) for certain features
@@ -294,7 +294,7 @@ is your base class. You can prevent ```rebuild``` from deleting your records
 like so:
 
 ```ruby
-PgSearch::Multisearch.rebuild(Product, false)
+PgSearch::Multisearch.rebuild(Product, clean_up: false)
 ```
 
 Rebuild is also available as a Rake task, for convenience.
@@ -338,7 +338,7 @@ class Movie < ActiveRecord::Base
 
   # More sophisticated approach
   def self.rebuild_pg_search_documents
-    connection.execute <<-SQL
+    connection.execute <<~SQL.squish
      INSERT INTO pg_search_documents (searchable_type, searchable_id, content, created_at, updated_at)
        SELECT 'Movie' AS searchable_type,
               movies.id AS searchable_id,
@@ -895,7 +895,7 @@ class Sentence < ActiveRecord::Base
   include PgSearch::Model
 
   pg_search_scope :similarity_like,
-                  against: :words,
+                  against: :name,
                   using: {
                     trigram: {
                       word_similarity: true
@@ -903,7 +903,7 @@ class Sentence < ActiveRecord::Base
                   }
 
   pg_search_scope :word_similarity_like,
-                  against: :words,
+                  against: :name,
                   using: [:trigram]
 end
 

data/lib/pg_search.rb

@@ -2,7 +2,7 @@
 
 require "active_record"
 require "active_support/concern"
-require "active_support/core_ext/module/attribute_accessors"
+require "active_support/core_ext/module/attribute_accessors_per_thread"
 require "active_support/core_ext/string/strip"
 
 require "pg_search/configuration"
@@ -18,7 +18,7 @@ module PgSearch
   autoload :Document, "pg_search/document"
 
   def self.included(base)
-    ActiveSupport::Deprecation.warn <<-MESSAGE.strip_heredoc
+    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`.
@@ -27,10 +27,10 @@ module PgSearch
     base.include PgSearch::Model
   end
 
-  mattr_accessor :multisearch_options
+  thread_mattr_accessor :multisearch_options
   self.multisearch_options = {}
 
-  mattr_accessor :unaccent_function
+  thread_mattr_accessor :unaccent_function
   self.unaccent_function = "unaccent"
 
   class << self

data/lib/pg_search/document.rb

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

data/lib/pg_search/features/dmetaphone.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_support/core_ext/module/delegation"
+
 module PgSearch
   module Features
     class DMetaphone
@@ -9,13 +11,9 @@ module PgSearch
         @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/tsearch.rb

@@ -59,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[
@@ -97,7 +97,7 @@ module PgSearch
 
       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
@@ -107,25 +107,26 @@ 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

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