pg_search 2.3.4 → 2.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a217bfd36241c2a3b7e9d496fbcafcda084f0ab87c50baaee487ed3ad1349774
-  data.tar.gz: 2adb9c974d6b1d00fbf89be865c1901e759de8956daa8b5795407a51468abc6e
+  metadata.gz: c2c29f81bcee1e1547d17ae1eda7c5a71e1f43d4891cc1e66ec8e7f648473698
+  data.tar.gz: 68e7d896513f774004f9259fcc2aa88cb6fc687783be02bd9abbb21466e6c989
 SHA512:
-  metadata.gz: 16e3c8d3a801a3e2cee0a38b42de4ce5d74142c08be3908fbc733b591312047df33e4ec0101d7e2029646d4476d9875146d64bed90cb3492bd921967462eee01
-  data.tar.gz: 0d5507703452f0b8607d2bb3ea355375ab88dcbf99fdc8239fe0a255820ad782e3d7ecd9101f28bde9f2df2c092aa323cb1c7d23c6460bd967b070efde4a33a8
+  metadata.gz: b1a224c8783e84a25aea02720ab06cb191c9a175c2416a9a1584e4a088845bc9b4d5e6a80eb73d06b7f4cabd933c770f386131b9cd52988626f200954770fa5b
+  data.tar.gz: 0744e0552c490b4e334334a23044d19aeae2cea28106fe09528add0a91c80bd9c7f507acb7a3c017df5d375cbf1a7bf590f6cb405ba066b8e4cc13b99f19904d

data/.jrubyrc

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

data/.rubocop.yml

@@ -102,7 +102,7 @@ RSpec/ExpectInHook:
   Enabled: false
 
 RSpec/FilePath:
-  CustomTransform: 
+  CustomTransform:
     TSearch: "tsearch"
     DMetaphone: "dmetaphone"
 
@@ -130,8 +130,5 @@ Style/RedundantRegexpEscape:
 RSpec/MultipleExpectations:
   Max: 5
 
-RSpec/MultipleMemoizedHelpers:
-  AllowSubject: true
-
 RSpec/ExampleLength:
   Max: 15

data/.travis.yml

@@ -6,22 +6,28 @@ rvm:
   - 2.7.2
   - 2.6.6
   - 2.5.8
-  - jruby-9.2.11.1
+  - jruby-9.2.13.0
+
+services:
+  - postgresql
 
 env:
   global:
     - CC_TEST_REPORTER_ID=0a0e3e45118bc447e677d52c21d056a5471c4921d54f96ed7b2550d9fc5043ea
   matrix:
     - ACTIVE_RECORD_BRANCH="master"
+    - 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"
 
-
 matrix:
   allow_failures:
     - env: ACTIVE_RECORD_BRANCH="master"
     - 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
@@ -34,9 +40,3 @@ 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,5 +1,10 @@
 # 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

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/README.md

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

data/lib/pg_search/scope_options.rb

@@ -152,7 +152,7 @@ module PgSearch
       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/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PgSearch
-  VERSION = '2.3.4'
+  VERSION = '2.3.5'
 end

data/pg_search.gemspec

@@ -23,15 +23,15 @@ Gem::Specification.new do |s| # rubocop:disable Metrics/BlockLength
 
   s.add_development_dependency 'pry'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec', '>= 3.3'
-  s.add_development_dependency 'rubocop', '>= 0.90.0'
+  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 'warning'
-  s.add_development_dependency 'with_model', '>= 1.2'
+  s.add_development_dependency 'with_model'
 
   s.required_ruby_version = '>= 2.5'
 end

data/spec/lib/pg_search/multisearch/rebuilder_spec.rb

@@ -205,9 +205,6 @@ describe PgSearch::Multisearch::Rebuilder do
 
         context "when :against includes non-column dynamic methods" do
           with_model :Model do
-            table do
-            end
-
             model do
               include PgSearch::Model
               multisearchable against: [:foo]

data/spec/lib/pg_search/multisearchable_spec.rb

@@ -167,14 +167,13 @@ describe PgSearch::Multisearchable do
       end
 
       context "when searching against multiple columns" do
-        let(:multisearchable_options) { { against: %i[attr1 attr2] } }
+        let(:multisearchable_options) { { against: %i[attr_1 attr_2] } }
 
         before do
           without_partial_double_verification do
-            allow(record).to receive(:attr1).and_return('1')
-            allow(record).to receive(:attr2).and_return('2')
+            allow(record).to receive(:attr_1).and_return('1')
+            allow(record).to receive(:attr_2).and_return('2')
           end
-
           record.save
         end
 
@@ -214,12 +213,12 @@ describe PgSearch::Multisearchable do
       end
 
       context "when searching against multiple columns" do
-        let(:multisearchable_options) { { against: %i[attr1 attr2] } }
+        let(:multisearchable_options) { { against: %i[attr_1 attr_2] } }
 
         before do
           without_partial_double_verification do
-            allow(record).to receive(:attr1).and_return('1')
-            allow(record).to receive(:attr2).and_return('2')
+            allow(record).to receive(:attr_1).and_return('1')
+            allow(record).to receive(:attr_2).and_return('2')
           end
           record.save
         end

data/spec/lib/pg_search_spec.rb

@@ -2,16 +2,14 @@
 
 require "spec_helper"
 
-# For AR 5 and greater, the association reflection's cache needs be cleared
+# For Active Record 5.x and 6.0, the association reflection's cache needs be cleared
 # because we're stubbing the related constants.
-class << PgSearch::Document
-  if ActiveRecord::VERSION::MAJOR >= 5
-    def clear_searchable_cache
-      reflect_on_association(:searchable).clear_association_scope_cache
-    end
-  else
-    def clear_searchable_cache
-    end
+if ActiveRecord::VERSION::MAJOR == 5 || (ActiveRecord::VERSION::MAJOR == 6 && ActiveRecord::VERSION::MINOR == 0)
+  def clear_searchable_cache
+    PgSearch::Document.reflect_on_association(:searchable).clear_association_scope_cache
+  end
+else
+  def clear_searchable_cache
   end
 end
 
@@ -35,7 +33,7 @@ describe PgSearch do
 
     context "with PgSearch.multisearch_options set to a Hash" do
       subject do
-        PgSearch::Document.clear_searchable_cache
+        clear_searchable_cache
         described_class.multisearch(query).map(&:searchable)
       end
 
@@ -59,7 +57,7 @@ describe PgSearch do
 
     context "with PgSearch.multisearch_options set to a Proc" do
       subject do
-        PgSearch::Document.clear_searchable_cache
+        clear_searchable_cache
         described_class.multisearch(query, soundalike).map(&:searchable)
       end
 
@@ -168,7 +166,7 @@ describe PgSearch do
 
           PgSearch::Multisearch.rebuild(SearchableSubclassModel)
 
-          PgSearch::Document.clear_searchable_cache
+          clear_searchable_cache
           expect(PgSearch::Document.count).to be 1
           expect(PgSearch::Document.first.searchable.class).to be SearchableSubclassModel
           expect(PgSearch::Document.first.searchable).to eq expected
@@ -183,7 +181,7 @@ describe PgSearch do
           PgSearch::Multisearch.rebuild(SearchableSubclassModel)
           expect(PgSearch::Document.count).to be 2
 
-          PgSearch::Document.clear_searchable_cache
+          clear_searchable_cache
           classes = PgSearch::Document.all.collect { |d| d.searchable.class }
           expect(classes).to include SearchableSubclassModel
           expect(classes).to include AnotherSearchableSubclassModel

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pg_search
 version: !ruby/object:Gem::Version
-  version: 2.3.4
+  version: 2.3.5
 platform: ruby
 authors:
 - Grant Hutchins
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-10 00:00:00.000000000 Z
+date: 2020-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -73,28 +73,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.90.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -185,14 +185,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0'
 description: PgSearch builds Active Record named scopes that take advantage of PostgreSQL's
   full text search
 email:
@@ -208,10 +208,12 @@ files:
 - ".editorconfig"
 - ".github/dependabot.yml"
 - ".gitignore"
+- ".jrubyrc"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
@@ -285,7 +287,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: PgSearch builds Active Record named scopes that take advantage of PostgreSQL's