chewy 8.0.0 → 8.1.0

data/docs/import.md

@@ -1,122 +0,0 @@
-# Import
-
-## Default import options
-
-Every index has `default_import_options` configuration to specify, suddenly, default import options:
-
-```ruby
-class ProductsIndex < Chewy::Index
-  index_scope Post.includes(:tags)
-  default_import_options batch_size: 100, bulk_size: 10.megabytes, refresh: false
-
-  field :name
-  field :tags, value: -> { tags.map(&:name) }
-end
-```
-
-See [import.rb](../lib/chewy/index/import.rb) for available options. For field definitions (`field`, `index_scope`, etc.), see [indexing.md](indexing.md#index-definition).
-
-## Raw import
-
-Another way to speed up import time is Raw Imports. This technology is only available in ActiveRecord adapter. Very often, ActiveRecord model instantiation is what consumes most of the CPU and RAM resources. Precious time is wasted on converting, say, timestamps from strings and then serializing them back to strings. Chewy can operate on raw hashes of data directly obtained from the database. All you need is to provide a way to convert that hash to a lightweight object that mimics the behaviour of the normal ActiveRecord object.
-
-```ruby
-class LightweightProduct
-  def initialize(attributes)
-    @attributes = attributes
-  end
-
-  # Depending on the database, `created_at` might
-  # be in different formats. In PostgreSQL, for example,
-  # you might see the following format:
-  #   "2016-03-22 16:23:22"
-  #
-  # Taking into account that Elastic expects something different,
-  # one might do something like the following, just to avoid
-  # unnecessary String -> DateTime -> String conversion.
-  #
-  #   "2016-03-22 16:23:22" -> "2016-03-22T16:23:22Z"
-  def created_at
-    @attributes['created_at'].tr(' ', 'T') << 'Z'
-  end
-end
-
-index_scope Product
-default_import_options raw_import: ->(hash) {
-  LightweightProduct.new(hash)
-}
-
-field :created_at, 'datetime'
-```
-
-Also, you can pass `:raw_import` option to the `import` method explicitly.
-
-## Index creation during import
-
-By default, when you perform import Chewy checks whether an index exists and creates it if it's absent.
-You can turn off this feature to decrease Elasticsearch hits count.
-To do so you need to set `skip_index_creation_on_import` parameter to `false` in your `config/chewy.yml`.
-
-## Skip record fields during import
-
-You can use `ignore_blank: true` to skip fields that return `true` for the `.blank?` method:
-
-```ruby
-index_scope Country
-field :id
-field :cities, ignore_blank: true do
-  field :id
-  field :name
-  field :surname, ignore_blank: true
-  field :description
-end
-```
-
-### Default values for different types
-
-By default `ignore_blank` is false on every type except `geo_point`.
-
-## Journaling
-
-You can record all actions that were made to the separate journal index in Elasticsearch.
-When you create/update/destroy your documents, it will be saved in this special index.
-If you make something with a batch of documents (e.g. during index reset) it will be saved as a one record, including primary keys of each document that was affected.
-Common journal record looks like this:
-
-```json
-{
-  "action": "index",
-  "object_id": [1, 2, 3],
-  "index_name": "...",
-  "created_at": "<timestamp>"
-}
-```
-
-This feature is turned off by default.
-You can turn it on by setting `journal` option to `true` in `config/chewy.yml`.
-
-Also, you can provide this option while you're importing some index:
-
-```ruby
-CityIndex.import journal: true
-```
-
-Or as a default import option for an index:
-
-```ruby
-class CityIndex
-  index_scope City
-  default_import_options journal: true
-end
-```
-
-You may be wondering why do you need it? The answer is simple: not to lose the data.
-
-Imagine that you reset your index in a zero-downtime manner (to separate index),
-and in the meantime somebody keeps updating the data frequently (to old
-index). So all these actions will be written to the journal index and you'll be
-able to apply them after index reset using the `Chewy::Journal` interface. You can subscribe to journal events via `ActiveSupport::Notifications` — see [configuration.md](configuration.md#activesupportnotifications-support) for details.
-
-When enabled, journal can grow to enormous size, consider setting up cron job
-that would clean it occasionally using [`chewy:journal:clean` rake
-task](rake_tasks.md#chewyjournal).

data/docs/indexing.md

@@ -1,329 +0,0 @@
-# Indexing
-
-## Index definition
-
-1. Create `/app/chewy/users_index.rb`
-
-  ```ruby
-  class UsersIndex < Chewy::Index
-
-  end
-  ```
-
-2. Define index scope (you can omit this part if you don't need to specify a scope (i.e. use PORO objects for import) or options)
-
-  ```ruby
-  class UsersIndex < Chewy::Index
-    index_scope User.active # or just model instead_of scope: index_scope User
-  end
-  ```
-
-3. Add some mappings
-
-  ```ruby
-  class UsersIndex < Chewy::Index
-    index_scope User.active.includes(:country, :badges, :projects)
-    field :first_name, :last_name # multiple fields without additional options
-    field :email, analyzer: 'email' # Elasticsearch-related options
-    field :country, value: ->(user) { user.country.name } # custom value proc
-    field :badges, value: ->(user) { user.badges.map(&:name) } # passing array values to index
-    field :projects do # the same block syntax for multi_field, if `:type` is specified
-      field :title
-      field :description # default data type is `text`
-      # additional top-level objects passed to value proc:
-      field :categories, value: ->(project, user) { project.categories.map(&:name) if user.active? }
-    end
-    field :rating, type: 'integer' # custom data type
-    field :created, type: 'date', include_in_all: false,
-      value: ->{ created_at } # value proc for source object context
-  end
-  ```
-
-  [See here for mapping definitions](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html).
-
-4. Add some index-related settings. Analyzer repositories might be used as well. See `Chewy::Index.settings` docs for details:
-
-  ```ruby
-  class UsersIndex < Chewy::Index
-    settings analysis: {
-      analyzer: {
-        email: {
-          tokenizer: 'keyword',
-          filter: ['lowercase']
-        }
-      }
-    }
-
-    index_scope User.active.includes(:country, :badges, :projects)
-    root date_detection: false do
-      template 'about_translations.*', type: 'text', analyzer: 'standard'
-
-      field :first_name, :last_name
-      field :email, analyzer: 'email'
-      field :country, value: ->(user) { user.country.name }
-      field :badges, value: ->(user) { user.badges.map(&:name) }
-      field :projects do
-        field :title
-        field :description
-      end
-      field :about_translations, type: 'object' # pass object type explicitly if necessary
-      field :rating, type: 'integer'
-      field :created, type: 'date', include_in_all: false,
-        value: ->{ created_at }
-    end
-  end
-  ```
-
-  [See index settings here](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html).
-  [See root object settings here](https://www.elastic.co/guide/en/elasticsearch/reference/current/dynamic-field-mapping.html).
-
-  See [mapping.rb](../lib/chewy/index/mapping.rb) for more details.
-
-5. Add model-observing code
-
-  ```ruby
-  class User < ActiveRecord::Base
-    update_index('users') { self } # specifying index and back-reference
-                                        # for updating after user save or destroy
-  end
-
-  class Country < ActiveRecord::Base
-    has_many :users
-
-    update_index('users') { users } # return single object or collection
-  end
-
-  class Project < ActiveRecord::Base
-    update_index('users') { user if user.active? } # you can return even `nil` from the back-reference
-  end
-
-  class Book < ActiveRecord::Base
-    update_index(->(book) {"books_#{book.language}"}) { self } # dynamic index name with proc.
-                                                               # For book with language == "en"
-                                                               # this code will generate `books_en`
-  end
-  ```
-
-  The `update_index` callback requires an active update strategy to be set. See [configuration.md](configuration.md#index-update-strategies) for available strategies and how they integrate with Rails.
-
-  Also, you can use the second argument for method name passing:
-
-  ```ruby
-  update_index('users', :self)
-  update_index('users', :users)
-  ```
-
-  In the case of a belongs_to association you may need to update both associated objects, previous and current:
-
-  ```ruby
-  class City < ActiveRecord::Base
-    belongs_to :country
-
-    update_index('cities') { self }
-    update_index 'countries' do
-      previous_changes['country_id'] || country
-    end
-  end
-  ```
-
-## Multi (nested) and object field types
-
-To define an objects field you can simply nest fields in the DSL:
-
-```ruby
-field :projects do
-  field :title
-  field :description
-end
-```
-
-This will automatically set the type or root field to `object`. You may also specify `type: 'objects'` explicitly.
-
-To define a multi field you have to specify any type except for `object` or `nested` in the root field:
-
-```ruby
-field :full_name, type: 'text', value: ->{ full_name.strip } do
-  field :ordered, analyzer: 'ordered'
-  field :untouched, type: 'keyword'
-end
-```
-
-The `value:` option for internal fields will no longer be effective.
-
-## Geo Point fields
-
-You can use [Elasticsearch's geo mapping](https://www.elastic.co/guide/en/elasticsearch/reference/current/geo-point.html) with the `geo_point` field type, allowing you to query, filter and order by latitude and longitude. You can use the following hash format:
-
-```ruby
-field :coordinates, type: 'geo_point', value: ->{ {lat: latitude, lon: longitude} }
-```
-
-or by using nested fields:
-
-```ruby
-field :coordinates, type: 'geo_point' do
-  field :lat, value: ->{ latitude }
-  field :long, value: ->{ longitude }
-end
-```
-
-See the section on *Script fields* for details on calculating distance in a search.
-
-## Join fields
-
-You can use a [join field](https://www.elastic.co/guide/en/elasticsearch/reference/current/parent-join.html)
-to implement parent-child relationships between documents.
-It [replaces the old `parent_id` based parent-child mapping](https://www.elastic.co/guide/en/elasticsearch/reference/current/removal-of-types.html#parent-child-mapping-types)
-
-To use it, you need to pass `relations` and `join` (with `type` and `id`) options:
-```ruby
-field :hierarchy_link, type: :join, relations: {question: %i[answer comment], answer: :vote, vote: :subvote}, join: {type: :comment_type, id: :commented_id}
-```
-assuming you have `comment_type` and `commented_id` fields in your model.
-
-Note that when you reindex a parent, its children and grandchildren will be reindexed as well.
-This may require additional queries to the primary database and to Elasticsearch.
-
-Also note that the join field doesn't support crutches (it should be a field directly defined on the model).
-
-## Crutches technology
-
-Assume you are defining your index like this (product has_many categories through product_categories):
-
-```ruby
-class ProductsIndex < Chewy::Index
-  index_scope Product.includes(:categories)
-  field :name
-  field :category_names, value: ->(product) { product.categories.map(&:name) } # or shorter just -> { categories.map(&:name) }
-end
-```
-
-Then the Chewy reindexing flow will look like the following pseudo-code:
-
-```ruby
-Product.includes(:categories).find_in_batches(1000) do |batch|
-  bulk_body = batch.map do |object|
-    {name: object.name, category_names: object.categories.map(&:name)}.to_json
-  end
-  # here we are sending every batch of data to ES
-  Chewy.client.bulk bulk_body
-end
-```
-
-If you meet complicated cases when associations are not applicable you can replace Rails associations with Chewy Crutches technology:
-
-```ruby
-class ProductsIndex < Chewy::Index
-  index_scope Product
-  crutch :categories do |collection| # collection here is a current batch of products
-    # data is fetched with a lightweight query without objects initialization
-    data = ProductCategory.joins(:category).where(product_id: collection.map(&:id)).pluck(:product_id, 'categories.name')
-    # then we have to convert fetched data to appropriate format
-    # this will return our data in structure like:
-    # {123 => ['sweets', 'juices'], 456 => ['meat']}
-    data.each.with_object({}) { |(id, name), result| (result[id] ||= []).push(name) }
-  end
-
-  field :name
-  # simply use crutch-fetched data as a value:
-  field :category_names, value: ->(product, crutches) { crutches[:categories][product.id] }
-end
-```
-
-An example flow will look like this:
-
-```ruby
-Product.includes(:categories).find_in_batches(1000) do |batch|
-  crutches[:categories] = ProductCategory.joins(:category).where(product_id: batch.map(&:id)).pluck(:product_id, 'categories.name')
-    .each.with_object({}) { |(id, name), result| (result[id] ||= []).push(name) }
-
-  bulk_body = batch.map do |object|
-    {name: object.name, category_names: crutches[:categories][object.id]}.to_json
-  end
-  Chewy.client.bulk bulk_body
-end
-```
-
-So Chewy Crutches technology is able to increase your indexing performance in some cases up to a hundredfold or even more depending on your associations complexity. For another approach to import performance, see [Raw import](import.md#raw-import).
-
-## Witchcraft technology
-
-One more experimental technology to increase import performance. As far as you know, chewy defines value proc for every imported field in mapping, so at the import time each of these procs is executed on imported object to extract result document to import. It would be great for performance to use one huge whole-document-returning proc instead. So basically the idea or Witchcraft technology is to compile a single document-returning proc from the index definition.
-
-```ruby
-index_scope Product
-witchcraft!
-
-field :title
-field :tags, value: -> { tags.map(&:name) }
-field :categories do
-  field :name, value: -> (product, category) { category.name }
-  field :type, value: -> (product, category, crutch) { crutch.types[category.name] }
-end
-```
-
-The index definition above will be compiled to something close to:
-
-```ruby
--> (object, crutches) do
-  {
-    title: object.title,
-    tags: object.tags.map(&:name),
-    categories: object.categories.map do |object2|
-      {
-        name: object2.name
-        type: crutches.types[object2.name]
-      }
-    end
-  }
-end
-```
-
-And don't even ask how is it possible, it is a witchcraft.
-Obviously not every type of definition might be compiled. There are some restrictions:
-
-1. Use reasonable formatting to make `method_source` be able to extract field value proc sources.
-2. Value procs with splat arguments are not supported right now.
-3. If you are generating fields dynamically use value proc with arguments, argumentless value procs are not supported yet:
-
-  ```ruby
-  [:first_name, :last_name].each do |name|
-    field name, value: -> (o) { o.send(name) }
-  end
-  ```
-
-However, it is quite possible that your index definition will be supported by Witchcraft technology out of the box in most of the cases.
-
-## Index manipulation
-
-```ruby
-UsersIndex.delete # destroy index if it exists
-UsersIndex.delete!
-
-UsersIndex.create
-UsersIndex.create! # use bang or non-bang methods
-
-UsersIndex.purge
-UsersIndex.purge! # deletes then creates index
-
-UsersIndex.import # import with 0 arguments process all the data specified in index_scope definition
-UsersIndex.import User.where('rating > 100') # or import specified users scope
-UsersIndex.import User.where('rating > 100').to_a # or import specified users array
-UsersIndex.import [1, 2, 42] # pass even ids for import, it will be handled in the most effective way
-UsersIndex.import User.where('rating > 100'), update_fields: [:email] # if update fields are specified - it will update their values only with the `update` bulk action
-UsersIndex.import! # raises an exception in case of any import errors
-
-UsersIndex.reset! # purges index and imports default data for all types
-```
-
-For more on import options, batching and journaling, see [import.md](import.md).
-
-If the passed user is `#destroyed?`, or satisfies a `delete_if` index_scope option, or the specified id does not exist in the database, import will perform delete from index action for this object.
-
-```ruby
-index_scope User, delete_if: :deleted_at
-index_scope User, delete_if: -> { deleted_at }
-index_scope User, delete_if: ->(user) { user.deleted_at }
-```
-
-See [actions.rb](../lib/chewy/index/actions.rb) for more details.

data/docs/querying.md

@@ -1,72 +0,0 @@
-# Querying
-
-## Composing requests
-
-The request DSL have the same chainable nature as AR. The main class is `Chewy::Search::Request`.
-
-```ruby
-CitiesIndex.query(match: {name: 'London'})
-```
-
-Main methods of the request DSL are: `query`, `filter` and `post_filter`, it is possible to pass pure query hashes or use `elasticsearch-dsl`.
-
-```ruby
-CitiesIndex
-  .filter(term: {name: 'Bangkok'})
-  .query(match: {name: 'London'})
-  .query.not(range: {population: {gt: 1_000_000}})
-```
-
-You can query a set of indexes at once:
-
-```ruby
-CitiesIndex.indices(CountriesIndex).query(match: {name: 'Some'})
-```
-
-See https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html and https://github.com/elastic/elasticsearch-dsl-ruby for more details.
-
-An important part of requests manipulation is merging. There are 4 methods to perform it: `merge`, `and`, `or`, `not`. See [Chewy::Search::QueryProxy](../lib/chewy/search/query_proxy.rb) for details. Also, `only` and `except` methods help to remove unneeded parts of the request.
-
-Every other request part is covered by a bunch of additional methods, see [Chewy::Search::Request](../lib/chewy/search/request.rb) for details:
-
-```ruby
-CitiesIndex.limit(10).offset(30).order(:name, {population: {order: :desc}})
-```
-
-Request DSL also provides additional scope actions, like `delete_all`, `exists?`, `count`, `pluck`, etc.
-
-## Pagination
-
-The request DSL supports pagination with `Kaminari`. An extension is enabled on initialization if `Kaminari` is available. See [Chewy::Search](../lib/chewy/search.rb) and [Chewy::Search::Pagination::Kaminari](../lib/chewy/search/pagination/kaminari.rb) for details.
-
-## Named scopes
-
-Chewy supports named scopes functionality. There is no specialized DSL for named scopes definition, it is simply about defining class methods.
-
-See [Chewy::Search::Scoping](../lib/chewy/search/scoping.rb) for details.
-
-## Scroll API
-
-Elasticsearch scroll API is utilized by a bunch of methods: `scroll_batches`, `scroll_hits`, `scroll_wrappers` and `scroll_objects`.
-
-See [Chewy::Search::Scrolling](../lib/chewy/search/scrolling.rb) for details.
-
-## Loading objects
-
-It is possible to load ORM/ODM source objects with the `objects` method. To provide additional loading options use `load` method:
-
-```ruby
-CitiesIndex.load(scope: -> { active }).to_a # to_a returns `Chewy::Index` wrappers.
-CitiesIndex.load(scope: -> { active }).objects # An array of AR source objects.
-```
-
-See [Chewy::Search::Loader](../lib/chewy/search/loader.rb) for more details.
-
-In case when it is necessary to iterate through both of the wrappers and objects simultaneously, `object_hash` method helps a lot:
-
-```ruby
-scope = CitiesIndex.load(scope: -> { active })
-scope.each do |wrapper|
-  scope.object_hash[wrapper]
-end
-```

data/docs/rake_tasks.md

@@ -1,108 +0,0 @@
-# Rake Tasks
-
-For a Rails application, some index-maintaining rake tasks are defined.
-
-## `chewy:reset`
-
-Performs zero-downtime reindexing as described [here](https://www.elastic.co/blog/changing-mapping-with-zero-downtime). So the rake task creates a new index with unique suffix and then simply aliases it to the common index name. The previous index is deleted afterwards (see `Chewy::Index.reset!` for more details).
-
-```bash
-rake chewy:reset # resets all the existing indices
-rake chewy:reset[users] # resets UsersIndex only
-rake chewy:reset[users,cities] # resets UsersIndex and CitiesIndex
-rake chewy:reset[-users,cities] # resets every index in the application except specified ones
-```
-
-## `chewy:upgrade`
-
-Performs reset exactly the same way as `chewy:reset` does, but only when the index specification (setting or mapping) was changed.
-
-It works only when index specification is locked in `Chewy::Stash::Specification` index. The first run will reset all indexes and lock their specifications.
-
-See [Chewy::Stash::Specification](../lib/chewy/stash.rb) and [Chewy::Index::Specification](../lib/chewy/index/specification.rb) for more details.
-
-
-```bash
-rake chewy:upgrade # upgrades all the existing indices
-rake chewy:upgrade[users] # upgrades UsersIndex only
-rake chewy:upgrade[users,cities] # upgrades UsersIndex and CitiesIndex
-rake chewy:upgrade[-users,cities] # upgrades every index in the application except specified ones
-```
-
-## `chewy:update`
-
-It doesn't create indexes, it simply imports everything to the existing ones and fails if the index was not created before.
-
-```bash
-rake chewy:update # updates all the existing indices
-rake chewy:update[users] # updates UsersIndex only
-rake chewy:update[users,cities] # updates UsersIndex and CitiesIndex
-rake chewy:update[-users,cities] # updates every index in the application except UsersIndex and CitiesIndex
-```
-
-## `chewy:sync`
-
-Provides a way to synchronize outdated indexes with the source quickly and without doing a full reset. By default field `updated_at` is used to find outdated records, but this could be customized by `outdated_sync_field` as described at [Chewy::Index::Syncer](../lib/chewy/index/syncer.rb).
-
-Arguments are similar to the ones taken by `chewy:update` task.
-
-See [Chewy::Index::Syncer](../lib/chewy/index/syncer.rb) for more details.
-
-```bash
-rake chewy:sync # synchronizes all the existing indices
-rake chewy:sync[users] # synchronizes UsersIndex only
-rake chewy:sync[users,cities] # synchronizes UsersIndex and CitiesIndex
-rake chewy:sync[-users,cities] # synchronizes every index in the application except UsersIndex and CitiesIndex
-```
-
-## `chewy:deploy`
-
-This rake task is especially useful during the production deploy. It is a combination of `chewy:upgrade` and `chewy:sync` and the latter is called only for the indexes that were not reset during the first stage.
-
-It is not possible to specify any particular indexes for this task as it doesn't make much sense.
-
-Right now the approach is that if some data had been updated, but index definition was not changed (no changes satisfying the synchronization algorithm were done), it would be much faster to perform manual partial index update inside data migrations or even manually after the deploy.
-
-Also, there is always full reset alternative with `rake chewy:reset`. See [configuration.md](configuration.md#index-update-strategies) for how update strategies interact with deployment.
-
-## `chewy:create_missing_indexes`
-
-This rake task creates newly defined indexes in Elasticsearch and skips existing ones. Useful for production-like environments.
-
-## Parallelizing rake tasks
-
-Every task described above has its own parallel version. Every parallel rake task takes the number for processes for execution as the first argument and the rest of the arguments are exactly the same as for the non-parallel task version.
-
-[https://github.com/grosser/parallel](https://github.com/grosser/parallel) gem is required to use these tasks.
-
-If the number of processes is not specified explicitly - `parallel` gem tries to automatically derive the number of processes to use.
-
-```bash
-rake chewy:parallel:reset
-rake chewy:parallel:upgrade[4]
-rake chewy:parallel:update[4,cities]
-rake chewy:parallel:sync[4,-users]
-rake chewy:parallel:deploy[4] # performs parallel upgrade and parallel sync afterwards
-```
-
-## `chewy:journal`
-
-This namespace contains two tasks for the journal manipulations: `chewy:journal:apply` and `chewy:journal:clean`. Both are taking time as the first argument (optional for clean) and a list of indexes exactly as the tasks above. Time can be in any format parsable by ActiveSupport.
-
-```bash
-rake chewy:journal:apply["$(date -v-1H -u +%FT%TZ)"] # apply journaled changes for the past hour
-rake chewy:journal:apply["$(date -v-1H -u +%FT%TZ)",users] # apply journaled changes for the past hour on UsersIndex only
-```
-
-See [import.md](import.md#journaling) for how journaling works and how to enable it.
-
-When the size of the journal becomes very large, the classical way of deletion would be obstructive and resource consuming. Fortunately, Chewy internally uses [delete-by-query](https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docs-delete-by-query.html#docs-delete-by-query-task-api) ES function which supports async execution with batching and [throttling](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html#docs-delete-by-query-throttle).
-
-The available options, which can be set by ENV variables, are listed below:
-* `WAIT_FOR_COMPLETION` - a boolean flag. It controls async execution. It waits by default. When set to `false` (`0`, `f`, `false` or `off` in any case spelling is accepted as `false`), Elasticsearch performs some preflight checks, launches the request, and returns a task reference you can use to cancel the task or get its status.
-* `REQUESTS_PER_SECOND` - float. The throttle for this request in sub-requests per second. No throttling is enforced by default.
-* `SCROLL_SIZE` - integer. The number of documents to be deleted in single sub-request. The default batch size is 1000.
-
-```bash
-rake chewy:journal:clean WAIT_FOR_COMPLETION=false REQUESTS_PER_SECOND=10 SCROLL_SIZE=5000
-```

data/docs/testing.md

@@ -1,41 +0,0 @@
-# Testing
-
-## RSpec integration
-
-Just add `require 'chewy/rspec'` to your spec_helper.rb and you will get additional features:
-
-[update_index](../lib/chewy/rspec/update_index.rb) helper
-`mock_elasticsearch_response` helper to mock elasticsearch response
-`mock_elasticsearch_response_sources` helper to mock elasticsearch response sources
-`build_query` matcher to compare request and expected query (returns `true`/`false`)
-
-To use `mock_elasticsearch_response` and `mock_elasticsearch_response_sources` helpers add `include Chewy::Rspec::Helpers` to your tests.
-
-See [chewy/rspec/](../lib/chewy/rspec/) for more details.
-
-## Minitest integration
-
-Add `require 'chewy/minitest'` to your test_helper.rb, and then for tests which you'd like indexing test hooks, `include Chewy::Minitest::Helpers`.
-
-You can set the `:bypass` strategy for test suites and manually handle imports and flush test indices using `Chewy.massacre`. This will help reduce unnecessary ES requests.
-
-But if you require chewy to index/update model regularly in your test suite then you can specify `:urgent` strategy for documents indexing. Add `Chewy.strategy(:urgent)` to test_helper.rb.
-
-Also, you can use additional helpers:
-
-`mock_elasticsearch_response` to mock elasticsearch response
-`mock_elasticsearch_response_sources` to mock elasticsearch response sources
-`assert_elasticsearch_query` to compare request and expected query (returns `true`/`false`)
-
-See [chewy/minitest/](../lib/chewy/minitest/) for more details.
-
-## DatabaseCleaner
-
-If you use `DatabaseCleaner` in your tests with [the `transaction` strategy](https://github.com/DatabaseCleaner/database_cleaner#how-to-use), you may run into the problem that `ActiveRecord`'s models are not indexed automatically on save despite the fact that you set the callbacks to do this with the `update_index` method. The issue arises because `chewy` indices data on `after_commit` run as default, but all `after_commit` callbacks are not run with the `DatabaseCleaner`'s' `transaction` strategy. You can solve this issue by changing the `Chewy.use_after_commit_callbacks` option. Just add the following initializer in your Rails application:
-
-```ruby
-#config/initializers/chewy.rb
-Chewy.use_after_commit_callbacks = !Rails.env.test?
-```
-
-If you're seeing other unexpected behavior in tests, check [troubleshooting.md](troubleshooting.md) for common issues and debugging tips.