pg_search 2.3.0 → 2.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8e6c02c032d2a7a39ebe47e50584410cebe923e868dc6be720af23cd3748e55
-  data.tar.gz: 24d70a673be8c9993c007b812af1d9af89cc565dfbbae9ed37c205d90ca893da
+  metadata.gz: c2c29f81bcee1e1547d17ae1eda7c5a71e1f43d4891cc1e66ec8e7f648473698
+  data.tar.gz: 68e7d896513f774004f9259fcc2aa88cb6fc687783be02bd9abbb21466e6c989
 SHA512:
-  metadata.gz: 06e43bdc63bd98ea57943068cde6723780000ca3765a016d9baecdac3eea7006a1deae35885654b88b4752e3ad6f136190ac8602ffad62b3aac356425fad66d0
-  data.tar.gz: 500d85f688710b48bf235eb1765c66e569dd7db98d95f03eaa81242f12c746d2ce8a57176185700c8d1b6ca903039d2c9b42fd5b71c84a8e4f8c46d7ef3464f7
+  metadata.gz: b1a224c8783e84a25aea02720ab06cb191c9a175c2416a9a1584e4a088845bc9b4d5e6a80eb73d06b7f4cabd933c770f386131b9cd52988626f200954770fa5b
+  data.tar.gz: 0744e0552c490b4e334334a23044d19aeae2cea28106fe09528add0a91c80bd9c7f507acb7a3c017df5d375cbf1a7bf590f6cb405ba066b8e4cc13b99f19904d

data/.codeclimate.yml

@@ -9,6 +9,7 @@ engines:
     enabled: true
   rubocop:
     enabled: true
+    channel: rubocop-0-78
 ratings:
   paths:
     - "**.rb"

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/.jrubyrc

@@ -0,0 +1 @@
+debug.fullTrace=true

data/.rubocop.yml

@@ -1,7 +1,12 @@
-require: rubocop-performance
+require:
+  - rubocop-performance
+  - rubocop-rails
+  - rubocop-rake
+  - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
+  NewCops: enable
   Exclude:
     - bin/**/*
     - vendor/**/*
@@ -9,17 +14,17 @@ AllCops:
 Style/StringLiterals:
   Enabled: false
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
 
 Metrics/MethodLength:
-  Max: 21
+  Max: 15
 
 Metrics/BlockLength:
   Exclude:
     - spec/**/*
 
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   EnforcedStyle: with_fixed_indentation
 
 Style/NumericPredicate:
@@ -44,8 +49,8 @@ Bundler/DuplicatedGem:
 
 Style/EmptyMethod:
   EnforcedStyle: expanded
-  
-Layout/IndentFirstArrayElement:
+
+Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
 
 Style/Documentation:
@@ -54,3 +59,76 @@ 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/ExampleLength:
+  Max: 15

data/.travis.yml

@@ -1,38 +1,33 @@
 language: ruby
-sudo: false
 bundler_args: --binstubs
 cache: bundler
 
 rvm:
-  - 2.6.3
-  - 2.5.5
-  - 2.4.6
-  - jruby-9.2.6.0
+  - 2.7.2
+  - 2.6.6
+  - 2.5.8
+  - jruby-9.2.13.0
+
+services:
+  - postgresql
 
 env:
   global:
     - CC_TEST_REPORTER_ID=0a0e3e45118bc447e677d52c21d056a5471c4921d54f96ed7b2550d9fc5043ea
   matrix:
     - ACTIVE_RECORD_BRANCH="master"
-    - ACTIVE_RECORD_BRANCH="5-2-stable"
-    - ACTIVE_RECORD_VERSION="~> 6.0.0.beta1"
+    - ACTIVE_RECORD_BRANCH="6-1-stable"
+    - ACTIVE_RECORD_BRANCH="6-0-stable"
+    - ACTIVE_RECORD_VERSION="~> 6.1.0.rc1"
+    - ACTIVE_RECORD_VERSION="~> 6.0.0"
     - ACTIVE_RECORD_VERSION="~> 5.2.0"
-    - ACTIVE_RECORD_VERSION="~> 5.1.0"
-    - ACTIVE_RECORD_VERSION="~> 5.0.0"
-    - ACTIVE_RECORD_VERSION="~> 4.2.9"
 
 matrix:
   allow_failures:
     - env: ACTIVE_RECORD_BRANCH="master"
-    - env: ACTIVE_RECORD_BRANCH="5-2-stable"
-    - env: ACTIVE_RECORD_VERSION="~> 6.0.0.beta1"
-  exclude:
-    - rvm: 2.4.6
-      env: ACTIVE_RECORD_BRANCH="master"
-    - rvm: jruby-9.2.6.0
-      env: ACTIVE_RECORD_VERSION="~> 4.2.9"
-    - rvm: 2.4.5
-      env: ACTIVE_RECORD_VERSION="~> 6.0.0.beta1"
+    - env: ACTIVE_RECORD_BRANCH="6-0-stable"
+    - env: ACTIVE_RECORD_BRANCH="6-1-stable"
+    - env: ACTIVE_RECORD_VERSION="~> 6.1.0.rc1"
 
 before_script:
   - psql --version
@@ -45,6 +40,3 @@ script: bin/rake
 
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
-
-addons:
-  postgresql: "9.6"

data/CHANGELOG.md

@@ -1,52 +1,77 @@
 # pg_search changelog
 
+## 2.3.5
+
+* Add table of contents to README (Barry Woolgar)
+* Add support for Active Record 6.1
+
+## 2.3.4
+
+* Fix issue when setting various options directly on the `PgSearch` module while
+  running with a threaded web server, such as Puma. (Anton Rieder)
+
+## 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)
+
+## 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)
+
 ## 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/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at pg_search@nertzy.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile

@@ -4,7 +4,7 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'pg', '>= 0.21.0', '< 1.0.0', platform: :ruby
+gem 'pg', '>= 0.21.0', platform: :ruby
 gem "activerecord-jdbcpostgresql-adapter", ">= 1.3.1", platform: :jruby
 
 if ENV['ACTIVE_RECORD_BRANCH']

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,8 +16,8 @@ Read the blog post introducing PgSearch at https://content.pivotal.io/blog/pg-se
 
 ## REQUIREMENTS
 
-*   Ruby 2.4+
-*   ActiveRecord 4.2+
+*   Ruby 2.5+
+*   ActiveRecord 5.2+
 *   PostgreSQL 9.2+
 *   [PostgreSQL extensions](https://github.com/Casecommons/pg_search/wiki/Installing-PostgreSQL-Extensions) for certain features
 
@@ -53,6 +53,47 @@ class Shape < ActiveRecord::Base
 end
 ```    
 
+### Contents
+* [Multi-search vs. search scopes](#multi-search-vs-search-scopes)
+* [Multi-search](#multi-search)
+  * [Setup](#setup)
+  * [`multisearchable`](#multisearchable)
+  * [More Options ](#more-options)
+  * [Multi-search associations](#multi-search-associations)
+  * [Searching in the global search index](#searching-in-the-global-search-index)
+  * [Chaining method calls onto the results](#chaining-method-calls-onto-the-results)
+  * [Configuring multi-search](#configuring-multi-search)
+  * [Rebuilding search documents for a given class](#rebuilding-search-documents-for-a-given-class)
+  * [Disabling multi-search indexing temporarily](#disabling-multi-search-indexing-temporarily)
+* [`pg_search_scope`](#pg_search_scope)
+  * [Searching against one column](#searching-against-one-column)
+  * [Searching against multiple columns](#searching-against-multiple-columns)
+  * [Dynamic search scopes](#dynamic-search-scopes)
+  * [Searching through associations](#searching-through-associations)
+* [Searching using different search features](#searching-using-different-search-features)
+  * [`:tsearch` (Full Text Search)](#tsearch-full-text-search)
+    * [Weighting](#weighting)
+    * [`:prefix` (PostgreSQL 8.4 and newer only)](#prefix-postgresql-84-and-newer-only)
+    * [`:negation`](#negation)
+    * [`:dictionary`](#dictionary)
+    * [`:normalization`](#normalization)
+    * [`:any_word`](#any_word)
+    * [`:sort_only`](#sort_only)
+    * [`:highlight`](#highlight)
+  * [`:dmetaphone` (Double Metaphone soundalike search)](#dmetaphone-double-metaphone-soundalike-search)
+  * [`:trigram` (Trigram search)](#trigram-trigram-search)
+    * [`:threshold`](#threshold)
+    * [`:word_similarity`](#word_similarity)
+* [Limiting Fields When Combining Features](#limiting-fields-when-combining-features)
+* [Ignoring accent marks](#ignoring-accent-marks)
+* [Using tsvector columns](#using-tsvector-columns)
+  * [Combining multiple tsvectors](#combining-multiple-tsvectors)
+* [Configuring ranking and ordering](#configuring-ranking-and-ordering)
+  * [`:ranked_by` (Choosing a ranking algorithm)](#ranked_by-choosing-a-ranking-algorithm)
+  * [`:order_within_rank` (Breaking ties)](#order_within_rank-breaking-ties)
+  * [`PgSearch#pg_search_rank` (Reading a record's rank as a Float)](#pgsearchpg_search_rank-reading-a-records-rank-as-a-float)
+  * [Search rank and chained scopes](#search-rank-and-chained-scopes)
+
 ### Multi-search vs. search scopes
 
 pg_search supports two different techniques for searching, multi-search and
@@ -175,15 +216,17 @@ multisearchable(
 
 **Specify additional attributes to be saved on the pg_search_documents table**
 
-You can specify `:additional_attributes` to be saved within the pg_search_documents table. For example, perhaps you are indexing a book model and an article model and wanted to include the author_id.
+You can specify `:additional_attributes` to be saved within the `pg_search_documents` table. For example, perhaps you are indexing a book model and an article model and wanted to include the author_id.
 
-First, we need to add `author_id` to the migration creating our pg_search_documents table.
+First, we need to add a reference to author to the migration creating our `pg_search_documents` table.
 
 ```ruby
   create_table :pg_search_documents do |t|
-        t.text :content
-        t.integer :author_id
-        t.belongs_to :searchable, polymorphic: true, index: true
+    t.text :content
+    t.references :author, index: true
+    t.belongs_to :searchable, polymorphic: true, index: true
+    t.timestamps null: false
+  end
 ```
 
 Then, we can send in this additional attribute in a lambda
@@ -196,7 +239,10 @@ Then, we can send in this additional attribute in a lambda
 ```
 
 This allows much faster searches without joins later on by doing something like:
-`PgSearch.multisearch(params['search']).where(author_id: 2)`
+
+```ruby
+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*
 
@@ -289,7 +335,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.
@@ -333,7 +379,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,
@@ -718,7 +764,7 @@ class Person < ActiveRecord::Base
   pg_search_scope :search,
                   against: :name,
                   using: {
-                    tsearch: {any_word: true}
+                    tsearch: {any_word: true},
                     dmetaphone: {any_word: true, sort_only: true}
                   }
 end
@@ -890,7 +936,7 @@ class Sentence < ActiveRecord::Base
   include PgSearch::Model
 
   pg_search_scope :similarity_like,
-                  against: :words,
+                  against: :name,
                   using: {
                     trigram: {
                       word_similarity: true
@@ -898,7 +944,7 @@ class Sentence < ActiveRecord::Base
                   }
 
   pg_search_scope :word_similarity_like,
-                  against: :words,
+                  against: :name,
                   using: [:trigram]
 end
 
@@ -1143,15 +1189,11 @@ Patterson](http://tenderlovemaking.com/) for the original version and to Caseboo
 
 ## CONTRIBUTIONS AND FEEDBACK
 
-Welcomed! Feel free to join and contribute to our [public Pivotal Tracker
-project](https://www.pivotaltracker.com/projects/228645) where we manage new
-feature ideas and bugs.
+Please read our [CONTRIBUTING guide](https://github.com/Casecommons/pg_search/blob/master/CONTRIBUTING.md).
 
 We also have a [Google Group](http://groups.google.com/group/casecommons-dev)
 for discussing pg_search and other Casebook PBC open source projects.
 
-Please read our [CONTRIBUTING guide](https://github.com/Casecommons/pg_search/blob/master/CONTRIBUTING.md).
-
 ## LICENSE
 
 Copyright © 2010–2019 [Casebook PBC](http://www.casebook.net).