pg_search 2.2.0 → 2.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 292701a98892eef31e95d8b5d723e94ce71fd47e4956e8bed595b8f87797f49c
-  data.tar.gz: cc08372ce5c032e288c28b2f6409c218d361b271fc271de08acbe8e5430c8dcb
+  metadata.gz: a217bfd36241c2a3b7e9d496fbcafcda084f0ab87c50baaee487ed3ad1349774
+  data.tar.gz: 2adb9c974d6b1d00fbf89be865c1901e759de8956daa8b5795407a51468abc6e
 SHA512:
-  metadata.gz: e95e7240968269703ae6d010639f2b4380e7616962c7a07f4932ad5e21c77affae6ea3c90e9a8171641a506988fa076ecdb30224f2b081d1468fb13618713d2e
-  data.tar.gz: 4910a636f53e444c3995e0ca728bd21475d11347d8a4d8223a1e881f3360bf8dc7e4f5689bd05cc559dad106a08b077abda1b3f50c6108221e4dbf75c4d73ffa
+  metadata.gz: 16e3c8d3a801a3e2cee0a38b42de4ce5d74142c08be3908fbc733b591312047df33e4ec0101d7e2029646d4476d9875146d64bed90cb3492bd921967462eee01
+  data.tar.gz: 0d5507703452f0b8607d2bb3ea355375ab88dcbf99fdc8239fe0a255820ad782e3d7ecd9101f28bde9f2df2c092aa323cb1c7d23c6460bd967b070efde4a33a8

data/.codeclimate.yml

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

data/.editorconfig

@@ -0,0 +1,10 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 2

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

@@ -1,38 +1,27 @@
 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.11.1
 
 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-0-stable"
+    - 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"
 
 before_script:
   - psql --version
@@ -46,5 +35,8 @@ script: bin/rake
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
 
+jdk:
+  - openjdk8
+
 addons:
   postgresql: "9.6"

data/CHANGELOG.md

@@ -1,47 +1,72 @@
 # pg_search changelog
 
+## 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.
+* 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/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
 
@@ -49,7 +49,7 @@ To add PgSearch to an Active Record model, simply include the PgSearch module.
 
 ```ruby
 class Shape < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
 end
 ```    
 
@@ -87,12 +87,12 @@ multisearchable in its class definition.
 
 ```ruby
 class EpicPoem < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   multisearchable against: [:title, :author]
 end
 
 class Flower < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   multisearchable against: :color
 end
 ```
@@ -112,13 +112,13 @@ particular record should be included.
 
 ```ruby
 class Convertible < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   multisearchable against: [:make, :model],
                   if: :available_in_red?
 end
 
 class Jalopy < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   multisearchable against: [:make, :model],
                   if: lambda { |record| record.model_year > 1970 }
 end
@@ -132,7 +132,7 @@ timestamp.
 
 ```ruby
 class AntipatternExample
-  include PgSearch
+  include PgSearch::Model
   multisearchable against: [:contents],
                   if: :published?
 
@@ -175,15 +175,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 +198,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 +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.
@@ -333,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,
@@ -374,7 +379,7 @@ To search against a column, pass a symbol as the :against option.
 
 ```ruby
 class BlogPost < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search_by_title, against: :title
 end
 ```
@@ -394,7 +399,7 @@ Just pass an Array if you'd like to search more than one column.
 
 ```ruby
 class Person < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search_by_full_name, against: [:first_name, :last_name]
 end
 ```
@@ -421,7 +426,7 @@ value if you wanted.
 
 ```ruby
 class Person < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search_by_name, lambda { |name_part, query|
     raise ArgumentError unless [:first, :last].include?(name_part)
     {
@@ -459,7 +464,7 @@ class Cheese < ActiveRecord::Base
 end
 
 class Salami < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
 
   belongs_to :cracker
   has_many :cheeses, through: :cracker
@@ -494,7 +499,7 @@ search techniques.
 
 ```ruby
 class Beer < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search_name, against: :name, using: [:tsearch, :trigram, :dmetaphone]
 end
 ```
@@ -520,7 +525,7 @@ subtitle, and finally the content.
 
 ```ruby
 class NewsArticle < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search_full_text, against: {
     title: 'A',
     subtitle: 'B',
@@ -535,7 +540,7 @@ weight. If you omit the weight, a default will be used.
 
 ```ruby
 class NewsArticle < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search_full_text, against: [
     [:title, 'A'],
     [:subtitle, 'B'],
@@ -544,7 +549,7 @@ class NewsArticle < ActiveRecord::Base
 end
 
 class NewsArticle < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search_full_text, against: [
     [:title, 'A'],
     {subtitle: 'B'},
@@ -562,7 +567,7 @@ shown in the following example.
 
 ```ruby
 class Superhero < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :whose_name_starts_with,
                   against: :name,
                   using: {
@@ -591,7 +596,7 @@ term that you were trying to exclude.
 
 ```ruby
 class Animal < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :with_name_matching,
                   against: :name,
                   using: {
@@ -620,7 +625,7 @@ dictionary will be used.
 
 ```ruby
 class BoringTweet < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :kinda_matching,
                   against: :text,
                   using: {
@@ -664,7 +669,7 @@ their numbers together.
 
 ```ruby
 class BigLongDocument < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :regular_search,
                   against: :text
 
@@ -688,7 +693,7 @@ models containing any word in the search terms.
 
 ```ruby
 class Number < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search_any_word,
                   against: :text,
                   using: {
@@ -714,11 +719,11 @@ but will not include it in the query's WHERE condition.
 
 ```ruby
 class Person < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search,
                   against: :name,
                   using: {
-                    tsearch: {any_word: true}
+                    tsearch: {any_word: true},
                     dmetaphone: {any_word: true, sort_only: true}
                   }
 end
@@ -739,7 +744,7 @@ Adding .with_pg_search_highlight after the pg_search_scope you can access to
 
 ```ruby
 class Person < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :search,
                   against: :bio,
                   using: {
@@ -793,7 +798,7 @@ The following example shows how to use :dmetaphone.
 
 ```ruby
 class Word < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :that_sounds_like,
                   against: :spelling,
                   using: :dmetaphone
@@ -824,7 +829,7 @@ feature can be used.
 
 ```ruby
 class Website < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :kinda_spelled_like,
                   against: :name,
                   using: :trigram
@@ -849,7 +854,7 @@ threshold will force a table scan as the derived query uses the
 
 ```ruby
 class Vegetable < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
 
   pg_search_scope :strictly_spelled_like,
                   against: :name,
@@ -887,10 +892,10 @@ and the word with greatest similarity.
 
 ```ruby
 class Sentence < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
 
   pg_search_scope :similarity_like,
-                  against: :words,
+                  against: :name,
                   using: {
                     trigram: {
                       word_similarity: true
@@ -898,7 +903,7 @@ class Sentence < ActiveRecord::Base
                   }
 
   pg_search_scope :word_similarity_like,
-                  against: :words,
+                  against: :name,
                   using: [:trigram]
 end
 
@@ -918,7 +923,7 @@ which fields using the 'only' option:
 
 ```ruby
 class Image < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
 
   pg_search_scope :combined_search,
                   against: [:file_name, :short_description, :long_description]
@@ -953,7 +958,7 @@ must be installed before this feature can be used.
 
 ```ruby
 class SpanishQuestion < ActiveRecord::Base
-  include PgSearch
+  include PgSearch::Model
   pg_search_scope :gringo_search,
                   against: :word,
                   ignoring: :accents
@@ -1143,15 +1148,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).