chewy 7.1.0 → 7.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58a5011ecef1ca511a28d4d3299d61f852c4c11ffe6fd124db3e0a5b370a0f9e
-  data.tar.gz: fa0ce61841d579210c2de4a84624b265cca533f887e6125d8e07cee59315c4a6
+  metadata.gz: a027fc99d931ad37a70f2cdf906363917af16afc6dd82bbc1da8066e63dad9ee
+  data.tar.gz: 602bbb699c4971f8653207bb52d8bb7c40899128b1c6034c89f0f4481207f569
 SHA512:
-  metadata.gz: '0925c5bb8f3adfc79b5914d975c71f2677d6232ccbac074d65ee63d99d23cfbc16c85adf88c953e003fbebfcff2fc9b0bb5a11d735ce6432cdcd57d76e7f81e4'
-  data.tar.gz: fefd812c6daea408e90b6f235efd169b195b5d1003fe4d3042c2e502b375d0b7cdf6d4d41133d012bf05a0f0e417ce95e43fbd1eb8e99b9ba3d72f6a4b50e548
+  metadata.gz: 444a1e44ad27a6d066daf31ceee258ee51e4ef1398fe6af4bf7294090b2391d2f136aa1726d5eb9f1c22f1c87abfd16f4a05c1198a0496e2062a13f8f31340db
+  data.tar.gz: 5f484506393af6b6959593850c9c7cb73307628076eb9676bd72e53b7fa02a987986d79443c35c2c7a0efd652615fb7ccf6ed418ab7bdf85eb69fbe6b2b02c24

data/.github/workflows/ruby.yml

@@ -0,0 +1,58 @@
+name: CI
+
+on: [push]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.6, 2.7]
+        gemfile: [rails.5.2.activerecord, rails.6.0.activerecord, rails.6.1.activerecord]
+    name: ${{ matrix.ruby }}-${{ matrix.gemfile }}
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run Elasticsearch
+        uses: elastic/elastic-github-actions/elasticsearch@9de0f78f306e4ebc0838f057e6b754364685e759
+        with:
+          stack-version: 7.10.1
+          port: 9250
+      - name: Tests
+        run: bundle exec rspec
+
+  ruby-3-0-activerecord-6-1:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: gemfiles/rails.6.1.activerecord.gemfile
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.0'
+          bundler-cache: true
+      - name: Run Elasticsearch
+        uses: elastic/elastic-github-actions/elasticsearch@9de0f78f306e4ebc0838f057e6b754364685e759
+        with:
+          stack-version: 7.10.1
+          port: 9250
+      - name: Tests
+        run: bundle exec rspec
+
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - run: bundle exec rubocop --format simple

data/.rubocop.yml

@@ -1,24 +1,31 @@
 inherit_from: .rubocop_todo.yml
 
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
 Layout/AccessModifierIndentation:
   EnforcedStyle: outdent
 
-Layout/AlignHash:
+Layout/HashAlignment:
   EnforcedLastArgumentHashStyle: always_ignore
 
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   EnforcedStyle: with_fixed_indentation
 
 Layout/CaseIndentation:
   EnforcedStyle: end
 
-Layout/IndentArray:
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: variable
+
+Layout/FirstArrayElementIndentation:
   EnforcedStyle: consistent
 
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
-Layout/IndentHeredoc:
+Layout/HeredocIndentation:
   Enabled: false
 
 Layout/MultilineMethodCallIndentation:
@@ -33,9 +40,6 @@ Layout/SpaceInsideHashLiteralBraces:
 Lint/AmbiguousBlockAssociation:
   Enabled: false
 
-Lint/EndAlignment:
-  EnforcedStyleAlignWith: variable
-
 Style/Alias:
   EnforcedStyle: prefer_alias_method
 
@@ -53,4 +57,5 @@ Metrics/BlockLength:
 
 Metrics/ModuleLength:
   Exclude:
+    - 'lib/chewy/rake_helper.rb'
     - '**/*_spec.rb'

data/.rubocop_todo.yml

@@ -1,44 +1,132 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-09-09 17:05:47 +0700 using RuboCop version 0.42.0.
+# on 2021-04-02 12:44:05 UTC using RuboCop version 1.11.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 42
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'chewy.gemspec'
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'lib/chewy/rspec/update_index.rb'
+    - 'spec/chewy/config_spec.rb'
+
+# Offense count: 10
+# Configuration parameters: AllowComments, AllowEmptyLambdas.
+Lint/EmptyBlock:
+  Exclude:
+    - 'spec/chewy/minitest/helpers_spec.rb'
+    - 'spec/chewy/rspec/update_index_spec.rb'
+    - 'spec/chewy/search/scrolling_spec.rb'
+    - 'spec/chewy/strategy/atomic_spec.rb'
+    - 'spec/chewy/strategy_spec.rb'
+    - 'spec/chewy/index/import/bulk_request_spec.rb'
+    - 'spec/chewy/index/witchcraft_spec.rb'
+    - 'spec/chewy_spec.rb'
+
+# Offense count: 3
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/chewy/strategy/atomic.rb'
+    - 'lib/chewy/index/adapter/object.rb'
+    - 'lib/chewy/index/adapter/orm.rb'
+
+# Offense count: 35
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 48
+  Max: 41
 
 # Offense count: 4
-# Configuration parameters: CountComments.
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 300
+  Max: 267
 
-# Offense count: 14
+# Offense count: 13
+# Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 13
-
-# Offense count: 1450
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 198
+  Max: 12
 
-# Offense count: 38
-# Configuration parameters: CountComments.
+# Offense count: 43
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 33
+  Max: 29
 
-# Offense count: 1
-# Configuration parameters: CountComments.
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 180
+  Max: 158
 
-# Offense count: 14
+# Offense count: 18
+# Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 15
+  Max: 13
 
-# Offense count: 93
+# Offense count: 11
+# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers.
+# SupportedStyles: snake_case, normalcase, non_integer
+# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339
+Naming/VariableNumber:
+  Exclude:
+    - 'spec/chewy/fields/root_spec.rb'
+
+# Offense count: 5
+Style/DocumentDynamicEvalDefinition:
+  Exclude:
+    - 'lib/chewy/index/actions.rb'
+    - 'lib/chewy/repository.rb'
+    - 'lib/chewy/search/pagination/kaminari.rb'
+    - 'lib/chewy/index/crutch.rb'
+    - 'lib/chewy/index/witchcraft.rb'
+
+# Offense count: 58
 Style/Documentation:
   Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/EvalWithLocation:
+  Exclude:
+    - 'spec/chewy/index_spec.rb'
+
+# Offense count: 191
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/chewy.rb'
+    - 'spec/support/active_record.rb'
+
+# Offense count: 10
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/chewy.rb'
+    - 'lib/chewy/railtie.rb'
+    - 'lib/chewy/rspec/update_index.rb'
+    - 'lib/chewy/search/query_proxy.rb'
+    - 'lib/chewy/index/import.rb'
+    - 'lib/chewy/index/witchcraft.rb'
+    - 'spec/support/active_record.rb'
+
+# Offense count: 53
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 191

data/CHANGELOG.md

@@ -8,6 +8,112 @@
 
 ### Bugs Fixed
 
+## 7.2.3 (2021-10-29)
+
+### New Features
+
+  * [#801](https://github.com/toptal/chewy/pull/801): Add the [`track_total_hits`](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-your-data.html#track-total-hits) option to the query. ([@milk1000cc][])
+  * [#810](https://github.com/toptal/chewy/pull/810): Use `unsafe_load` when loading config to support Psych 4.
+  * [#819](https://github.com/toptal/chewy/pull/819): Add the [`ignore_unavailable`](https://www.elastic.co/guide/en/elasticsearch/reference/current/multi-index.html#multi-index) option to the request. ([@kolauren][])
+
+### Changes
+
+  * [#817](https://github.com/toptal/chewy/pull/817): Show warning message during rake chewy:reset or chewy:upgrade if journaling is disabled. ([@konalegi][])
+
+### Bugs Fixed
+
+  * [#816](https://github.com/toptal/chewy/pull/816): Move query [`preference`](https://www.elastic.co/guide/en/elasticsearch/reference/7.x/search-search.html#search-preference) from body to query parameters. ([@afg419][])
+
+## 7.2.2 (2021-05-24)
+
+### Changes
+
+  * [#800](https://github.com/toptal/chewy/pull/800): Revert [#787](https://github.com/toptal/chewy/pull/787) progressbar feature to avoid performance degradation in parallel import ([@rabotyaga][])
+
+  * [#795](https://github.com/toptal/chewy/issues/795): **(Breaking)** Change the Chewy::Search::Parameters::Order implementation to use Array ([@jiajiawang][]):
+    * To allow multiple sorting options that may have the same key name. For example script based sorting whose key will always be `_script`.
+    * Behaviour change of chained `order` calls.
+      * e.g. `.order(_script: {a: 1}).order(_script: {b: 2})`
+        * Before `{:sort=>[{"_script"=>{:b=>2}}]}`
+        * After  `{:sort=>[{"_script"=>{:a=>1}},{"_script"=>{:b=>2}}]}`
+
+  * [#654](https://github.com/toptal/chewy/issues/654): Add helpers and matchers for testing ([@Vitalina-Vakulchyk][]):
+    * `mock_elasticsearch_response` helpers both Rspec and Minitest - to mock elasticsearch response
+    * `mock_elasticsearch_response_sources` helpers both Rspec and Minitest - to mock elasticsearch response sources
+    * `assert_elasticsearch_query` helper for Minitest - to compare request and expected query (returns `true`/`false`)
+    * `build_query` matcher for Rspec - to compare request and expected query (returns `true`/`false`)
+
+## 7.2.1 (2021-05-11)
+
+### New Features
+
+  * [#469](https://github.com/toptal/chewy/issues/469): Add ability to output the progressbar with `ENV['PROGRESS']` during `reset` rake tasks ([@Vitalina-Vakulchyk][]):
+    * for `rake chewy:reset` and `rake chewy:parallel:reset`
+    * progressbar is hidden by default, set `ENV['PROGRESS']` to `true` to display it
+
+### Bugs Fixed
+
+  * [#796](https://github.com/toptal/chewy/pull/796): Fix clear scroll: pass `scroll_id` in body, as passing in path parameters is deprecated and can overflow `http.max_initial_line_length` ([@rabotyaga][])
+
+## 7.0.1 (2021-05-03)
+
+### Changes
+
+  * [#792](https://github.com/toptal/chewy/pull/792): Skip ES version memoization for search requests ([@rabotyaga][])
+    * See the Migration Guide for details
+
+## 7.2.0 (2021-04-19)
+
+### New Features
+
+  * [#778](https://github.com/toptal/chewy/pull/778): Add `ignore_blank` option to `field` method ([@Vitalina-Vakulchyk][]):
+    * `true` by default for the `geo_point` type
+    * `false` by default for other types
+
+### Changes
+
+  * [#783](https://github.com/toptal/chewy/pull/783): **(Breaking)** Remove `Chewy::Type`, simplify DSL ([@rabotyaga][])
+    * Remove the `Chewy::Type` class
+        * e.g. remove `CitiesIndex::City` / `CitiesIndex.city`
+            * `CitiesIndex::City.import! ...` becomes `CitiesIndex.import! ...`
+    * Simplify index DSL:
+        * `define_type` block -> `index_scope` clause
+            * it can be omitted completely, if you don't need to specify the scope or options, e.g. `name`
+    * Remove type names from string representations:
+        * in `update_index` ActiveRecord helper and RSpec matcher, e.g.
+            * `update_index('cities#city')` -> `update_index('cities')`
+            * `update_index(UsersIndex::User)` -> `update_index(UsersIndex)`
+        * in rake tasks (e.g. `rake chewy:update[cities#city]` -> `rake chewy:update[cities]`)
+        * in rake tasks output (e.g. `Imported CitiesIndex::City in 1s, stats: index 3` -> `Imported CitiesIndex in 1s, stats: index 3`)
+    * Use index name instead of type name in loader additional scope
+        * e.g. `CitiesIndex.filter(...).load(city: {scope: City.where(...)})` -> `CitiesIndex.filter(...).load(cities: {scope: City.where(...)})`
+  * [#692](https://github.com/toptal/chewy/issues/692): Add `.update_mapping` to Index class ([@Vitalina-Vakulchyk][]):
+    * Wrapped Elasticsearch gem `.put_mapping` with `.update_mapping` in Index class
+    * Add `rake chewy:update_mapping` task
+  * [#594](https://github.com/toptal/chewy/issues/594): Add `.reindex` to Index class ([@Vitalina-Vakulchyk][]):
+    * Wrapped Elasticsearch gem `.reindex` with `.reindex` in Index class
+    * Add `rake chewy:reindex` task
+  * [#679](https://github.com/toptal/chewy/issues/679): Wrapped `Elasticsearch::API::Indices::Actions#clear_cache` with `.clear_cache` in Index class ([@Vitalina-Vakulchyk][])
+  * [#495](https://github.com/toptal/chewy/issues/495): Ability to change Rails console strategy with `Chewy.console_strategy` ([@Vitalina-Vakulchyk][])
+  * [#778](https://github.com/toptal/chewy/pull/778): **(Breaking)** Drop support for Ruby 2.5 ([@Vitalina-Vakulchyk][])
+  * [#776](https://github.com/toptal/chewy/pull/776): **(Breaking)** Removal of unnecessary features and integrations ([@Vitalina-Vakulchyk][]):
+    * `aws-sdk-sqs` / `shoryuken`
+    * `mongoid`
+    * `sequel`
+    * `will_paginate`
+    * `resque`
+  * [#769](https://github.com/toptal/chewy/pull/769): **(Breaking)** Removal of deprecated methods and rake tasks ([@Vitalina-Vakulchyk][]):
+    * `Chewy::Index.index_params` is removed, use `Chewy::Index.specification_hash` instead
+    * `Chewy::Index.derivable_index_name` is removed, use `Chewy::Index.derivable_name` instead
+    * `Chewy::Index.default_prefix` is removed, use `Chewy::Index.prefix` instead
+    * `Chewy::Index.build_index_name` is removed, use `Chewy::Index.index_name` instead
+    * `Chewy::RakeHelper.reset_index` is removed, use `Chewy::RakeHelper.reset` instead
+    * `Chewy::RakeHelper.reset_all` is removed, use `Chewy::RakeHelper.reset` instead
+    * `Chewy::RakeHelper.update_index` is removed, use `Chewy::RakeHelper.update` instead
+    * `Chewy::RakeHelper.update_all` is removed, use `Chewy::RakeHelper.update` instead
+    * `rake chewy:apply_changes_from` is removed, use `rake chewy:journal:apply` instead
+    * `rake chewy:clean_journal` is removed, use `rake chewy:journal:clean` instead
+
 ## 7.1.0 (2021-03-03)
 
 ### Changes
@@ -531,6 +637,7 @@
 [@aglushkov]: https://github.com/aglushkov
 [@AlexVPopov]: https://github.com/AlexVPopov
 [@AndreySavelyev]: https://github.com/AndreySavelyev
+[@afg419]: https://github.com/afg419
 [@arion]: https://github.com/arion
 [@arturtr]: https://github.com/arturtr
 [@averell23]: https://github.com/averell23
@@ -560,6 +667,7 @@
 [@inbeom]: https://github.com/inbeom
 [@jesjos]: https://github.com/jesjos
 [@JF-Lalonde]: https://github.com/JF-Lalonde
+[@jiajiawang]: https://github.com/jiajiawang
 [@jimmybaker]: https://github.com/jimmybaker
 [@jirikolarik]: https://github.com/jirikolarik
 [@jirutka]: https://github.com/jirutka
@@ -570,6 +678,7 @@
 [@josephchoe]: https://github.com/josephchoe
 [@jshirley]: https://github.com/jshirley
 [@ka8725]: https://github.com/ka8725
+[@kolauren]: https://github.com/kolauren
 [@konalegi]: https://github.com/konalegi
 [@lardawge]: https://github.com/lardawge
 [@leemhenson]: https://github.com/leemhenson
@@ -583,6 +692,7 @@
 [@mattzollinhofer]: https://github.com/mattzollinhofer
 [@menglewis]: https://github.com/menglewis
 [@mikeyhogarth]: https://github.com/mikeyhogarth
+[@milk1000cc]: https://github.com/milk1000cc
 [@mkcode]: https://github.com/mkcode
 [@mpeychich]: https://github.com/mpeychich
 [@mrbrdo]: https://github.com/mrbrdo
@@ -607,5 +717,7 @@
 [@taylor-au]: https://github.com/taylor-au
 [@TikiTDO]: https://github.com/TikiTDO
 [@undr]: https://github.com/undr
+[@Vitalina-Vakulchyk]: https://github.com/Vitalina-Vakulchyk
 [@webgago]: https://github.com/webgago
 [@yahooguntu]: https://github.com/yahooguntu
+

data/Gemfile

@@ -3,18 +3,11 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'activerecord'
-# gem 'mongoid'
-# gem 'sequel'
 
 gem 'activejob', require: false
-gem 'resque', require: false
 gem 'sidekiq', require: false
 
-gem 'aws-sdk-sqs', require: false
-gem 'shoryuken', require: false
-
 gem 'kaminari-core', require: false
-gem 'will_paginate', require: false
 
 gem 'parallel', require: false
 gem 'ruby-progressbar', require: false

data/Guardfile

@@ -9,7 +9,9 @@ guard :rspec, cmd: 'rspec' do
   # Rails example
   watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
   watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
-  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  do |m|
+    ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"]
+  end
   watch(%r{^spec/support/(.+)\.rb$})                  { 'spec' }
   watch('config/routes.rb')                           { 'spec/routing' }
   watch('app/controllers/application_controller.rb')  { 'spec/controllers' }