pg_search 2.3.0 → 2.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8e6c02c032d2a7a39ebe47e50584410cebe923e868dc6be720af23cd3748e55
-  data.tar.gz: 24d70a673be8c9993c007b812af1d9af89cc565dfbbae9ed37c205d90ca893da
+  metadata.gz: 43a62057153fd9e33ed21bc6ce1a420b5fbeaad46e9b047bd1e039c9c7ab6ad2
+  data.tar.gz: 15759abc9542c0b7ddc6060e156e7eff74d78cceef5bb06c4bdfa562e029722b
 SHA512:
-  metadata.gz: 06e43bdc63bd98ea57943068cde6723780000ca3765a016d9baecdac3eea7006a1deae35885654b88b4752e3ad6f136190ac8602ffad62b3aac356425fad66d0
-  data.tar.gz: 500d85f688710b48bf235eb1765c66e569dd7db98d95f03eaa81242f12c746d2ce8a57176185700c8d1b6ca903039d2c9b42fd5b71c84a8e4f8c46d7ef3464f7
+  metadata.gz: 6c1fc5c20a82e45a4fd6381fc56fd940dcd85cce2039e2e7f5159e0c939146d0176f1970481c29205bd7d7737022007d3d78cddc3fa93603a67221fa272d1a4e
+  data.tar.gz: 06a4f487a2cef2fd7b55bf5f650f6e13cec3528b6514f72e6dce69943c67d879f42c795d46c7aa442b2abfe789e4459f10437df94e955f9bfbe54968e9297e39

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/.github/workflows/ci.yml

@@ -0,0 +1,75 @@
+name: build
+
+on:
+  push:
+    branches:
+      - master
+      - github-actions
+  pull_request:
+    branches:
+      - master
+
+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: ['2.6', '2.7', '3.0', '3.1']
+        active-record-version-env:
+          - ACTIVE_RECORD_VERSION="~> 5.2.0"
+          - ACTIVE_RECORD_VERSION="~> 6.0.0"
+          - ACTIVE_RECORD_VERSION="~> 6.1.0"
+          - ACTIVE_RECORD_VERSION="~> 7.0.0"
+        allow-failure: [false]
+        include:
+          - ruby-version: '3.1'
+            active-record-version-env: ACTIVE_RECORD_BRANCH="7-0-stable"
+            allow-failure: true
+          - ruby-version: '3.1'
+            active-record-version-env: ACTIVE_RECORD_BRANCH="6-1-stable"
+            allow-failure: true
+        exclude:
+          - ruby-version: '3.0'
+            active-record-version-env: ACTIVE_RECORD_VERSION="~> 5.2.0"
+            allow-failure: false
+          - ruby-version: '3.1'
+            active-record-version-env: ACTIVE_RECORD_VERSION="~> 5.2.0"
+            allow-failure: false
+          - ruby-version: '2.6'
+            active-record-version-env: ACTIVE_RECORD_VERSION="~> 7.0.0"
+            allow-failure: false
+    continue-on-error: ${{ matrix.allow-failure }}
+    steps:
+    - uses: actions/checkout@v2
+    - 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/.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.6
+  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/ExampleLength:
+  Max: 15
+
+Rails/RakeEnvironment:
+  Enabled: false

data/.travis.yml

@@ -1,50 +1,37 @@
 language: ruby
-sudo: false
 bundler_args: --binstubs
 cache: bundler
 
 rvm:
-  - 2.6.3
-  - 2.5.5
-  - 2.4.6
-  - jruby-9.2.6.0
+  - 3.0.1
+  - 2.7.3
+  - 2.6.7
+
+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"
+  jobs:
+    - ACTIVE_RECORD_BRANCH="main"
+    - ACTIVE_RECORD_BRANCH="6-1-stable"
+    - ACTIVE_RECORD_BRANCH="6-0-stable"
+    - ACTIVE_RECORD_VERSION="~> 6.1.0"
+    - 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:
+jobs:
   allow_failures:
-    - env: ACTIVE_RECORD_BRANCH="master"
-    - env: ACTIVE_RECORD_BRANCH="5-2-stable"
-    - env: ACTIVE_RECORD_VERSION="~> 6.0.0.beta1"
+    - env: ACTIVE_RECORD_BRANCH="main"
+    - env: ACTIVE_RECORD_BRANCH="6-0-stable"
+    - env: ACTIVE_RECORD_BRANCH="6-1-stable"
   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"
+    - rvm: 3.0.1
+      env: ACTIVE_RECORD_VERSION="~> 5.2.0"
+    - rvm: 2.6.7
+      env: ACTIVE_RECORD_BRANCH="main"
 
 before_script:
   - psql --version
   - psql -c 'create database pg_search_test;' -U postgres >/dev/null
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
 
 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,86 @@
 # pg_search changelog
 
+## 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)
+* 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-2021 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