pg_search 2.3.5 → 2.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2c29f81bcee1e1547d17ae1eda7c5a71e1f43d4891cc1e66ec8e7f648473698
-  data.tar.gz: 68e7d896513f774004f9259fcc2aa88cb6fc687783be02bd9abbb21466e6c989
+  metadata.gz: 103352d5afaf431080a49411b6e7bce5c2d1edec6aa88da55913fb179ef02367
+  data.tar.gz: fea6642ba781bb1916f32d46fe25f829c34d27564c23674dde4c80f97a5a43db
 SHA512:
-  metadata.gz: b1a224c8783e84a25aea02720ab06cb191c9a175c2416a9a1584e4a088845bc9b4d5e6a80eb73d06b7f4cabd933c770f386131b9cd52988626f200954770fa5b
-  data.tar.gz: 0744e0552c490b4e334334a23044d19aeae2cea28106fe09528add0a91c80bd9c7f507acb7a3c017df5d375cbf1a7bf590f6cb405ba066b8e4cc13b99f19904d
+  metadata.gz: d550e544579fddb2ef4b2667a93624f9b293102db705e304b048bd0eaa328d908c3415028324a35e038353e7a47ac334e53e2a6f381abe2456de835c4d04c359
+  data.tar.gz: b896f972762290dda0d9e744680c707223188e6a5ceb05329cdc3479f302c1a18dd11b20bcd5ebffe66cc36143c182318b51e9e88e63463cfb55d7d0d8890d6b

data/.github/workflows/ci.yml

@@ -0,0 +1,80 @@
+name: build
+
+on:
+  push:
+    branches:
+      - master
+      - github-actions
+  pull_request:
+    branches:
+      - master
+  schedule:
+    - cron: "0 18 * * 6" # Saturdays at 12pm CST
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:latest
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+    env:
+      CI: true
+      PGHOST: 127.0.0.1
+      PGUSER: postgres
+      PGPASS: postgres
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['3.0', '3.1', '3.2', '3.3']
+        active-record-version-env:
+          - ACTIVE_RECORD_VERSION="~> 6.1.0"
+          - ACTIVE_RECORD_VERSION="~> 7.0.0"
+          - ACTIVE_RECORD_VERSION="~> 7.1.0"
+          - ACTIVE_RECORD_VERSION="~> 7.2.0"
+        allow-failure: [false]
+        exclude:
+          - ruby-version: '3.0'
+            active-record-version-env: ACTIVE_RECORD_VERSION="~> 7.2.0"
+        include:
+          - ruby-version: '3.3'
+            active-record-version-env: ACTIVE_RECORD_BRANCH="main"
+            allow-failure: true
+          - ruby-version: '3.3'
+            active-record-version-env: ACTIVE_RECORD_BRANCH="7-2-stable"
+            allow-failure: true
+          - ruby-version: '3.3'
+            active-record-version-env: ACTIVE_RECORD_BRANCH="7-1-stable"
+            allow-failure: true
+          - ruby-version: '3.3'
+            active-record-version-env: ACTIVE_RECORD_BRANCH="7-0-stable"
+            allow-failure: true
+          - ruby-version: '3.3'
+            active-record-version-env: ACTIVE_RECORD_BRANCH="6-1-stable"
+            allow-failure: true
+    continue-on-error: ${{ matrix.allow-failure }}
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Set up test database
+      env:
+        PGPASSWORD: postgres
+      run: createdb pg_search_test
+    - name: Update bundle
+      run: ${{ matrix.active-record-version-env }} bundle update
+    - name: Run tests
+      run: ${{ matrix.active-record-version-env }} bundle exec rake

data/.standard.yml

@@ -0,0 +1,6 @@
+ruby_version: 3.0
+
+plugins:
+  - standard-performance
+  - standard-rails:
+      target_rails_version: 6.1

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # pg_search changelog
 
+## 2.3.7
+
+* Drop support for Ruby 2.6 and 2.7
+* Drop support for Active Record 6.0 and earlier
+* Support Ruby 3.2 and 3.3
+* Support Active Record 7.1
+* Support Active Record 7.2 (fatkodima)
+* Add U+02BB/U+02BC to disallowed tsquery characters (Vital Ryabchinskiy)
+* add support for Arel::Nodes::SqlLiteral columns (Kyle Fazzari)
+* Improve documentation (Prima Aulia Gusta, Ross Baird, Andy Atkinson)
+
+## 2.3.6
+
+* Drop support for Ruby 2.5
+* Support Ruby 3.1
+* Support Active Record 7.0
+* Don't require `:against` if `:tsvector_column` is specified (Travis Hunter)
+* Optionally disable transaction when rebuilding documents (Travis Hunter)
+* Preserve columns when chaining ::with_pg_search_highlight (jcsanti)
+
 ## 2.3.5
 
 * Add table of contents to README (Barry Woolgar)

data/Gemfile

@@ -1,15 +1,28 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-gem 'pg', '>= 0.21.0', platform: :ruby
+gem "pg", ">= 0.21.0", platform: :ruby
 gem "activerecord-jdbcpostgresql-adapter", ">= 1.3.1", platform: :jruby
 
-if ENV['ACTIVE_RECORD_BRANCH']
-  gem 'activerecord', git: 'https://github.com/rails/rails.git', branch: ENV['ACTIVE_RECORD_BRANCH']
-  gem 'arel', git: 'https://github.com/rails/arel.git' if ENV['ACTIVE_RECORD_BRANCH'] == 'master'
+if ENV["ACTIVE_RECORD_BRANCH"]
+  gem "activerecord", git: "https://github.com/rails/rails.git", branch: ENV.fetch("ACTIVE_RECORD_BRANCH", nil)
+  gem "arel", git: "https://github.com/rails/arel.git" if ENV.fetch("ACTIVE_RECORD_BRANCH", nil) == "master"
 end
 
-gem 'activerecord', ENV['ACTIVE_RECORD_VERSION'] if ENV['ACTIVE_RECORD_VERSION']
+gem "activerecord", ENV.fetch("ACTIVE_RECORD_VERSION", nil) if ENV["ACTIVE_RECORD_VERSION"] # standard:disable Bundler/DuplicatedGem
+
+gem "debug"
+gem "irb"
+gem "rake"
+gem "rspec"
+gem "simplecov"
+gem "simplecov-lcov"
+gem "standard", require: false
+gem "standard-rails", require: false
+gem "standard-rspec", require: false
+gem "undercover"
+gem "warning"
+gem "with_model"

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2020 Casebook, PBC <http://www.casebook.net>
+Copyright (c) 2010–2022 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

@@ -1,10 +1,7 @@
 # [pg_search](http://github.com/Casecommons/pg_search/)
 
 [![Gem Version](https://img.shields.io/gem/v/pg_search.svg?style=flat)](https://rubygems.org/gems/pg_search)
-[![Build Status](https://secure.travis-ci.org/Casecommons/pg_search.svg?branch=master)](https://travis-ci.org/Casecommons/pg_search)
-[![Maintainability](https://api.codeclimate.com/v1/badges/ae1a7c021e473e9b2486/maintainability)](https://codeclimate.com/github/Casecommons/pg_search/maintainability)
-[![Test Coverage](https://codeclimate.com/github/Casecommons/pg_search/badges/coverage.svg)](https://codeclimate.com/github/Casecommons/pg_search/coverage)
-[![Inline docs](http://inch-ci.org/github/Casecommons/pg_search.svg?branch=master&style=flat)](http://inch-ci.org/github/Casecommons/pg_search)
+[![Build Status](https://github.com/Casecommons/pg_search/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/Casecommons/pg_search/actions/workflows/ci.yml)
 [![Join the chat at https://gitter.im/Casecommons/pg_search](https://img.shields.io/badge/gitter-join%20chat-blue.svg)](https://gitter.im/Casecommons/pg_search?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 ## DESCRIPTION
@@ -12,12 +9,12 @@
 PgSearch builds named scopes that take advantage of PostgreSQL's full text
 search.
 
-Read the blog post introducing PgSearch at https://content.pivotal.io/blog/pg-search-how-i-learned-to-stop-worrying-and-love-postgresql-full-text-search
+Read the blog post introducing PgSearch at https://tanzu.vmware.com/content/blog/pg-search-how-i-learned-to-stop-worrying-and-love-postgresql-full-text-search
 
 ## REQUIREMENTS
 
-*   Ruby 2.5+
-*   ActiveRecord 5.2+
+*   Ruby 3.0+
+*   Active Record 6.1+
 *   PostgreSQL 9.2+
 *   [PostgreSQL extensions](https://github.com/Casecommons/pg_search/wiki/Installing-PostgreSQL-Extensions) for certain features
 
@@ -51,7 +48,7 @@ To add PgSearch to an Active Record model, simply include the PgSearch module.
 class Shape < ActiveRecord::Base
   include PgSearch::Model
 end
-```    
+```
 
 ### Contents
 * [Multi-search vs. search scopes](#multi-search-vs-search-scopes)
@@ -201,17 +198,22 @@ problematic_record.published?     # => true
 PgSearch.multisearch("timestamp") # => Includes problematic_record
 ```
 
-#### More Options 
+#### More Options
 
 **Conditionally update pg_search_documents**
 
-You can specify an `:update_if` parameter to conditionally update pg_search documents. For example:
+You can also use the `:update_if` option to pass a Proc or method name to call
+to determine whether or not a particular record should be updated.
+
+Note that the Proc or method name is called in an `after_save` hook, so if you
+are relying on ActiveRecord dirty flags use `*_previously_changed?`.
 
 ```ruby
-multisearchable(
-    against: [:body],
-    update_if: :body_changed?
-  )
+class Message < ActiveRecord::Base
+  include PgSearch::Model
+  multisearchable against: [:body],
+                  update_if: :body_previously_changed?
+end
 ```
 
 **Specify additional attributes to be saved on the pg_search_documents table**
@@ -244,7 +246,8 @@ This allows much faster searches without joins later on by doing something like:
 PgSearch.multisearch(params['search']).where(author_id: 2)
 ```
 
-*NOTE: You must currently manually call `record.update_pg_search_document` for the additional attribute to be included in the pg_search_documents table*
+*NOTE: You must currently manually call `record.update_pg_search_document` for
+the additional attribute to be included in the pg_search_documents table*
 
 #### Multi-search associations
 
@@ -319,7 +322,7 @@ To remove all of the documents for a given class, you can simply delete all of
 the PgSearch::Document records.
 
 ```ruby
-PgSearch::Document.delete_all(searchable_type: "Animal")
+PgSearch::Document.delete_by(searchable_type: "Animal")
 ```
 
 To regenerate the documents for a given class, run:
@@ -338,6 +341,13 @@ like so:
 PgSearch::Multisearch.rebuild(Product, clean_up: false)
 ```
 
+```rebuild``` runs inside a single transaction. To run outside of a transaction,
+you can pass ```transactional: false``` like so:
+
+```ruby
+PgSearch::Multisearch.rebuild(Product, transactional: false)
+```
+
 Rebuild is also available as a Rake task, for convenience.
 
     $ rake pg_search:multisearch:rebuild[BlogPost]
@@ -349,15 +359,11 @@ pg_search_documents tables. The following will set the schema search path to
 
     $ rake pg_search:multisearch:rebuild[BlogPost,my_schema]
 
-For models that are multisearchable :against methods that directly map to
+For models that are multisearchable `:against` methods that directly map to
 Active Record attributes, an efficient single SQL statement is run to update
-the pg_search_documents table all at once. However, if you call any dynamic
-methods in :against, the following strategy will be used:
-
-```ruby
-PgSearch::Document.delete_all(searchable_type: "Ingredient")
-Ingredient.find_each { |record| record.update_pg_search_document }
-```
+the `pg_search_documents` table all at once. However, if you call any dynamic
+methods in `:against` then `update_pg_search_document` will be called on the
+individual records being indexed in batches.
 
 You can also provide a custom implementation for rebuilding the documents by
 adding a class method called `rebuild_pg_search_documents` to your model.
@@ -383,7 +389,7 @@ class Movie < ActiveRecord::Base
      INSERT INTO pg_search_documents (searchable_type, searchable_id, content, created_at, updated_at)
        SELECT 'Movie' AS searchable_type,
               movies.id AS searchable_id,
-              (movies.name || ' ' || directors.name) AS content,
+              CONCAT_WS(' ', movies.name, directors.name) AS content,
               now() AS created_at,
               now() AS updated_at
        FROM movies
@@ -393,6 +399,7 @@ class Movie < ActiveRecord::Base
   end
 end
 ```
+**Note:** If using PostgreSQL before 9.1, replace the `CONCAT_WS()` function call with double-pipe concatenation, eg. `(movies.name || ' ' || directors.name)`. However, now be aware that if *any* of the joined values is NULL then the final `content` value will also be NULL, whereas `CONCAT_WS()` will selectively ignore NULL values.
 
 #### Disabling multi-search indexing temporarily
 
@@ -545,6 +552,21 @@ class Beer < ActiveRecord::Base
 end
 ```
 
+Here's an example if you pass multiple :using options with additional configurations.
+
+```ruby
+class Beer < ActiveRecord::Base
+  include PgSearch::Model
+  pg_search_scope :search_name,
+  against: :name,
+  using: {
+      :trigram => {},
+      :dmetaphone => {},
+      :tsearch => { :prefix => true }
+  }
+end
+```
+
 The currently implemented features are
 
 *   :tsearch - [Full text search](http://www.postgresql.org/docs/current/static/textsearch-intro.html), which is built-in to PostgreSQL
@@ -657,7 +679,7 @@ Animal.with_name_matching("fish !red !blue") # => [one_fish, two_fish]
 
 PostgreSQL full text search also support multiple dictionaries for stemming.
 You can learn more about how dictionaries work by reading the [PostgreSQL
-documention](http://www.postgresql.org/docs/current/static/textsearch-dictionaries.html). 
+documention](http://www.postgresql.org/docs/current/static/textsearch-dictionaries.html).
 If you use one of the language dictionaries, such as "english",
 then variants of words (e.g. "jumping" and "jumped") will match each other. If
 you don't want stemming, you should pick the "simple" dictionary which does
@@ -679,12 +701,12 @@ class BoringTweet < ActiveRecord::Base
                   }
 end
 
-sleepy = BoringTweet.create! text: "I snoozed my alarm for fourteen hours today. I bet I can beat that tomorrow! #sleepy"
+sleep = BoringTweet.create! text: "I snoozed my alarm for fourteen hours today. I bet I can beat that tomorrow! #sleep"
 sleeping = BoringTweet.create! text: "You know what I like? Sleeping. That's what. #enjoyment"
-sleeper = BoringTweet.create! text: "Have you seen Woody Allen's movie entitled Sleeper? Me neither. #boycott"
+sleeps = BoringTweet.create! text: "In the jungle, the mighty jungle, the lion sleeps #tonight"
 
-BoringTweet.kinda_matching("sleeping") # => [sleepy, sleeping, sleeper]
-BoringTweet.literally_matching("sleeping") # => [sleeping]
+BoringTweet.kinda_matching("sleeping") # => [sleep, sleeping, sleeps]
+BoringTweet.literally_matching("sleeps") # => [sleeps]
 ```
 
 ##### :normalization
@@ -829,7 +851,7 @@ used for searching.
 Double Metaphone support is currently available as part of the [fuzzystrmatch
 extension](http://www.postgresql.org/docs/current/static/fuzzystrmatch.html)
 that must be installed before this feature can be used. In addition to the
-extension, you must install a utility function into your database. To generate 
+extension, you must install a utility function into your database. To generate
 and run a migration for this, run:
 
     $ rails g pg_search:migration:dmetaphone
@@ -864,7 +886,7 @@ Trigram search works by counting how many three-letter substrings (or
 Trigram search has some ability to work even with typos and misspellings in
 the query or text.
 
-Trigram support is currently available as part of the 
+Trigram support is currently available as part of the
 [pg_trgm extension](http://www.postgresql.org/docs/current/static/pgtrgm.html) that must be installed before this
 feature can be used.
 
@@ -928,7 +950,7 @@ Vegetable.strictly_spelled_like("collyflower") # => []
 Allows you to match words in longer strings.
 By default, trigram searches use `%` or `similarity()` as a similarity value.
 Set `word_similarity` to `true` to opt for `<%` and `word_similarity` instead.
-This causes the trigram search to use the similarity of the query term 
+This causes the trigram search to use the similarity of the query term
 and the word with greatest similarity.
 
 ```ruby
@@ -954,12 +976,12 @@ Sentence.similarity_like("word") # => []
 Sentence.word_similarity_like("word") # => [sentence]
 ```
 
-### Limiting Fields When Combining Features 
+### Limiting Fields When Combining Features
 
-Sometimes when doing queries combining different features you 
-might want to searching against only some of the fields with certain features.
+Sometimes when doing queries combining different features you
+might want to search against only some of the fields with certain features.
 For example perhaps you want to only do a trigram search against the shorter fields
-so that you don't need to reduce the threshold excessively. You can specify 
+so that you don't need to reduce the threshold excessively. You can specify
 which fields using the 'only' option:
 
 ```ruby
@@ -978,7 +1000,7 @@ class Image < ActiveRecord::Base
 end
 ```
 
-Now you can succesfully retrieve an Image with a file_name: 'image_foo.jpg' 
+Now you can succesfully retrieve an Image with a file_name: 'image_foo.jpg'
 and long_description: 'This description is so long that it would make a trigram search
 fail any reasonable threshold limit' with:
 
@@ -1196,5 +1218,5 @@ for discussing pg_search and other Casebook PBC open source projects.
 
 ## LICENSE
 
-Copyright © 2010–2019 [Casebook PBC](http://www.casebook.net).
+Copyright © 2010–2022 [Casebook PBC](http://www.casebook.net).
 Licensed under the MIT license, see [LICENSE](/LICENSE) file.

data/Rakefile

@@ -1,14 +1,17 @@
 # frozen_string_literal: true
 
-require 'bundler'
+require "bundler"
 Bundler::GemHelper.install_tasks
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
-RuboCop::RakeTask.new do |t|
-  t.options = %w[--display-cop-names]
+require "standard/rake"
+
+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 rubocop]
+task default: %w[spec standard undercover]

data/lib/pg_search/configuration/column.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'digest'
+require "digest"
 
 module PgSearch
   class Configuration
@@ -9,18 +9,20 @@ module PgSearch
 
       def initialize(column_name, weight, model)
         @name = column_name.to_s
-        @column_name = column_name.to_s
+        @column_name = column_name
         @weight = weight
         @model = model
         @connection = model.connection
       end
 
       def full_name
+        return @column_name if @column_name.is_a?(Arel::Nodes::SqlLiteral)
+
         "#{table_name}.#{column_name}"
       end
 
       def to_sql
-        "coalesce(#{expression}::text, '')"
+        "coalesce((#{expression})::text, '')"
       end
 
       private
@@ -30,7 +32,7 @@ module PgSearch
       end
 
       def column_name
-        @connection.quote_column_name(@column_name)
+        @connection.quote_column_name(@name)
       end
 
       def expression

data/lib/pg_search/configuration/foreign_column.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'digest'
+require "digest"
 
 module PgSearch
   class Configuration

data/lib/pg_search/configuration.rb

@@ -80,7 +80,7 @@ module PgSearch
     attr_reader :options
 
     def default_options
-      { using: :tsearch }
+      {using: :tsearch}
     end
 
     VALID_KEYS = %w[
@@ -92,8 +92,11 @@ module PgSearch
     }.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)
@@ -104,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,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'logger'
+require "logger"
 
 module PgSearch
-  class Document < ActiveRecord::Base
+  class Document < ActiveRecord::Base # standard:disable Rails/ApplicationRecord
     include PgSearch::Model
 
-    self.table_name = 'pg_search_documents'
+    self.table_name = "pg_search_documents"
     belongs_to :searchable, polymorphic: true
 
     # The logger might not have loaded yet.
@@ -17,12 +17,12 @@ module PgSearch
 
     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)
-                end
+        PgSearch.multisearch_options.call(*args)
+      else
+        {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

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

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

data/lib/pg_search/features/trigram.rb

@@ -35,17 +35,17 @@ module PgSearch
 
       def similarity_function
         if word_similarity?
-          'word_similarity'
+          "word_similarity"
         else
-          'similarity'
+          "similarity"
         end
       end
 
       def infix_operator
         if word_similarity?
-          '<%'
+          "<%"
         else
-          '%'
+          "%"
         end
       end