searchkick 5.0.0 → 5.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc223f746f73c44e5c6f56b5e351cb31ae5a655069d92f5bfd2a0b2e531afae8
-  data.tar.gz: 1969964f34a5adaf3ed746230fbef57673454f7304d890466e2814d27eb2cb47
+  metadata.gz: ec7741cb306a56f1a5ae5a07450c5c102236bc6103079fc34a5f602fa2853b31
+  data.tar.gz: 2bd747ee31846c901ce2a58125b34e9c90af6937a2c7dc041f2dd9f69701f1e9
 SHA512:
-  metadata.gz: 17259c3e071d69c3852584aba480b523211b167f1249951f32d1bd2f761fc07322144283f0ccabac4878c0a2ff2f4c9dd8def2db2beac004c449839052e503ea
-  data.tar.gz: 1109a53d99eb30f7e76cab8df00505c82af5e898c4e3f1821773932b8f6917e68f6bfedfa952b8e4acb25387607edf10856cc994021943671086af4d751cc728
+  metadata.gz: f92f2a3c7bb27862b1768f5ecedc19ad0eab515d62515f94d72412ed7c22a20493049dd0e52cba21b3a43d8c846b0dc0c6cda40c68edc12f6af37e8487fb9403
+  data.tar.gz: f69a1cfc401bad0f09bda3f2788b1096cc004dcb765eb20b3d8ada06202185eeae630d953005298e5944ed1b8c239fa808eeebb32e9440cc7ae9a32e771469dc

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 5.0.3 (2022-03-13)
+
+- Fixed context for index name for inherited models
+
+## 5.0.2 (2022-03-03)
+
+- Fixed index name for inherited models
+
+## 5.0.1 (2022-02-27)
+
+- Prefer `mode: :async` over `async: true` for full reindex
+- Fixed instance method overriding with concerns
+
 ## 5.0.0 (2022-02-21)
 
 - Searches now use lazy loading (similar to Active Record)
@@ -15,7 +28,7 @@
 - Raise error when `search` called on relations
 - Raise `ArgumentError` (instead of warning) for invalid regular expression modifiers
 - Raise `ArgumentError` instead of `RuntimeError` for unknown operators
-- Removed mapping of `id` to `_id` with `order` option
+- Removed mapping of `id` to `_id` with `order` option (not supported in Elasticsearch 8)
 - Removed `wordnet` option (no longer worked)
 - Removed dependency on `elasticsearch` gem (can use `elasticsearch` or `opensearch-ruby`)
 - Dropped support for Elasticsearch 6

data/README.md

@@ -50,8 +50,8 @@ Searchkick 5.0 was recently released! See [how to upgrade](#upgrading)
 Install [Elasticsearch](https://www.elastic.co/downloads/elasticsearch) or [OpenSearch](https://opensearch.org/downloads.html). For Homebrew, use:
 
 ```sh
-brew install elasticsearch
-brew services start elasticsearch
+brew install elastic/tap/elasticsearch-full
+brew services start elasticsearch-full
 # or
 brew install opensearch
 brew services start opensearch
@@ -98,7 +98,7 @@ Searchkick supports the complete [Elasticsearch Search API](https://www.elastic.
 Query like SQL
 
 ```ruby
-Product.search "apples", where: {in_stock: true}, limit: 10, offset: 50
+Product.search("apples", where: {in_stock: true}, limit: 10, offset: 50)
 ```
 
 Search specific fields
@@ -226,7 +226,7 @@ You can also boost by:
 Use a `*` for the query.
 
 ```ruby
-Product.search "*"
+Product.search("*")
 ```
 
 ### Pagination
@@ -235,7 +235,7 @@ Plays nicely with kaminari and will_paginate.
 
 ```ruby
 # controller
-@products = Product.search "milk", page: params[:page], per_page: 20
+@products = Product.search("milk", page: params[:page], per_page: 20)
 ```
 
 View with kaminari
@@ -255,13 +255,13 @@ View with will_paginate
 By default, results must match all words in the query.
 
 ```ruby
-Product.search "fresh honey" # fresh AND honey
+Product.search("fresh honey") # fresh AND honey
 ```
 
 To change this, use:
 
 ```ruby
-Product.search "fresh honey", operator: "or" # fresh OR honey
+Product.search("fresh honey", operator: "or") # fresh OR honey
 ```
 
 By default, results must match the entire word - `back` will not match `backpack`. You can change this behavior with:
@@ -275,7 +275,7 @@ end
 And to search (after you reindex):
 
 ```ruby
-Product.search "back", fields: [:name], match: :word_start
+Product.search("back", fields: [:name], match: :word_start)
 ```
 
 Available options are:
@@ -297,7 +297,7 @@ The default is `:word`. The most matches will happen with `:word_middle`.
 To match a field exactly (case-sensitive), use:
 
 ```ruby
-User.search query, fields: [{email: :exact}, :name]
+Product.search(query, fields: [{email: :exact}, :name])
 ```
 
 ### Phrase Matches
@@ -305,7 +305,7 @@ User.search query, fields: [{email: :exact}, :name]
 To only match the exact order, use:
 
 ```ruby
-User.search "fresh honey", match: :phrase
+Product.search("fresh honey", match: :phrase)
 ```
 
 ### Stemming and Language
@@ -426,7 +426,7 @@ end
 Search with:
 
 ```ruby
-Product.search query, fields: [:name_tagged]
+Product.search(query, fields: [:name_tagged])
 ```
 
 ### Misspellings
@@ -436,13 +436,13 @@ By default, Searchkick handles misspelled queries by returning results with an [
 You can change this with:
 
 ```ruby
-Product.search "zucini", misspellings: {edit_distance: 2} # zucchini
+Product.search("zucini", misspellings: {edit_distance: 2}) # zucchini
 ```
 
 To prevent poor precision and improve performance for correctly spelled queries (which should be a majority for most applications), Searchkick can first perform a search without misspellings, and if there are too few results, perform another with them.
 
 ```ruby
-Product.search "zuchini", misspellings: {below: 5}
+Product.search("zuchini", misspellings: {below: 5})
 ```
 
 If there are fewer than 5 results, a 2nd search is performed with misspellings enabled. The result of this query is returned.
@@ -450,13 +450,13 @@ If there are fewer than 5 results, a 2nd search is performed with misspellings e
 Turn off misspellings with:
 
 ```ruby
-Product.search "zuchini", misspellings: false # no zucchini
+Product.search("zuchini", misspellings: false) # no zucchini
 ```
 
 Specify which fields can include misspellings with:
 
 ```ruby
-Product.search "zucini", fields: [:name, :color], misspellings: {fields: [:name]}
+Product.search("zucini", fields: [:name, :color], misspellings: {fields: [:name]})
 ```
 
 > When doing this, you must also specify fields to search
@@ -466,7 +466,7 @@ Product.search "zucini", fields: [:name, :color], misspellings: {fields: [:name]
 If a user searches `butter`, they may also get results for `peanut butter`. To prevent this, use:
 
 ```ruby
-Product.search "butter", exclude: ["peanut butter"]
+Product.search("butter", exclude: ["peanut butter"])
 ```
 
 You can map queries and terms to exclude with:
@@ -477,7 +477,7 @@ exclude_queries = {
   "cream" => ["ice cream", "whipped cream"]
 }
 
-Product.search query, exclude: exclude_queries[query]
+Product.search(query, exclude: exclude_queries[query])
 ```
 
 You can demote results by boosting by a factor less than one:
@@ -499,7 +499,7 @@ gem "gemoji-parser"
 And use:
 
 ```ruby
-Product.search "🍨🍰", emoji: true
+Product.search("🍨🍰", emoji: true)
 ```
 
 ## Indexing
@@ -596,7 +596,7 @@ You can also do bulk updates.
 
 ```ruby
 Searchkick.callbacks(:bulk) do
-  User.find_each(&:update_fields)
+  Product.find_each(&:update_fields)
 end
 ```
 
@@ -604,7 +604,7 @@ Or temporarily skip updates.
 
 ```ruby
 Searchkick.callbacks(false) do
-  User.find_each(&:update_fields)
+  Product.find_each(&:update_fields)
 end
 ```
 
@@ -651,7 +651,7 @@ end
 The best starting point to improve your search **by far** is to track searches and conversions. [Searchjoy](https://github.com/ankane/searchjoy) makes it easy.
 
 ```ruby
-Product.search "apple", track: {user_id: current_user.id}
+Product.search("apple", track: {user_id: current_user.id})
 ```
 
 [See the docs](https://github.com/ankane/searchjoy) for how to install and use.
@@ -683,7 +683,7 @@ end
 
 Reindex and set up a cron job to add new conversions daily.
 
-```ruby
+```sh
 rake searchkick:reindex CLASS=Product
 ```
 
@@ -709,7 +709,7 @@ end
 Reindex and search with:
 
 ```ruby
-Product.search "milk", boost_where: {orderer_ids: current_user.id}
+Product.search("milk", boost_where: {orderer_ids: current_user.id})
 ```
 
 ## Instant Search / Autocomplete
@@ -733,7 +733,7 @@ end
 Reindex and search with:
 
 ```ruby
-Movie.search "jurassic pa", fields: [:title], match: :word_start
+Movie.search("jurassic pa", fields: [:title], match: :word_start)
 ```
 
 Typically, you want to use a JavaScript library like [typeahead.js](https://twitter.github.io/typeahead.js/) or [jQuery UI](https://jqueryui.com/autocomplete/).
@@ -793,7 +793,7 @@ end
 Reindex and search with:
 
 ```ruby
-products = Product.search "peantu butta", suggest: true
+products = Product.search("peantu butta", suggest: true)
 products.suggestions # ["peanut butter"]
 ```
 
@@ -804,40 +804,40 @@ products.suggestions # ["peanut butter"]
 ![Aggregations](https://gist.github.com/ankane/b6988db2802aca68a589b31e41b44195/raw/40febe948427e5bc53ec4e5dc248822855fef76f/facets.png)
 
 ```ruby
-products = Product.search "chuck taylor", aggs: [:product_type, :gender, :brand]
+products = Product.search("chuck taylor", aggs: [:product_type, :gender, :brand])
 products.aggs
 ```
 
 By default, `where` conditions apply to aggregations.
 
 ```ruby
-Product.search "wingtips", where: {color: "brandy"}, aggs: [:size]
+Product.search("wingtips", where: {color: "brandy"}, aggs: [:size])
 # aggregations for brandy wingtips are returned
 ```
 
 Change this with:
 
 ```ruby
-Product.search "wingtips", where: {color: "brandy"}, aggs: [:size], smart_aggs: false
+Product.search("wingtips", where: {color: "brandy"}, aggs: [:size], smart_aggs: false)
 # aggregations for all wingtips are returned
 ```
 
 Set `where` conditions for each aggregation separately with:
 
 ```ruby
-Product.search "wingtips", aggs: {size: {where: {color: "brandy"}}}
+Product.search("wingtips", aggs: {size: {where: {color: "brandy"}}})
 ```
 
 Limit
 
 ```ruby
-Product.search "apples", aggs: {store_id: {limit: 10}}
+Product.search("apples", aggs: {store_id: {limit: 10}})
 ```
 
 Order
 
 ```ruby
-Product.search "wingtips", aggs: {color: {order: {"_key" => "asc"}}} # alphabetically
+Product.search("wingtips", aggs: {color: {order: {"_key" => "asc"}}}) # alphabetically
 ```
 
 [All of these options are supported](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation.html#search-aggregations-bucket-terms-aggregation-order)
@@ -846,31 +846,31 @@ Ranges
 
 ```ruby
 price_ranges = [{to: 20}, {from: 20, to: 50}, {from: 50}]
-Product.search "*", aggs: {price: {ranges: price_ranges}}
+Product.search("*", aggs: {price: {ranges: price_ranges}})
 ```
 
 Minimum document count
 
 ```ruby
-Product.search "apples", aggs: {store_id: {min_doc_count: 2}}
+Product.search("apples", aggs: {store_id: {min_doc_count: 2}})
 ```
 
 Script support
 
 ```ruby
-Product.search "*", aggs: {color: {script: {source: "'Color: ' + _value"}}}
+Product.search("*", aggs: {color: {script: {source: "'Color: ' + _value"}}})
 ```
 
 Date histogram
 
 ```ruby
-Product.search "pear", aggs: {products_per_year: {date_histogram: {field: :created_at, interval: :year}}}
+Product.search("pear", aggs: {products_per_year: {date_histogram: {field: :created_at, interval: :year}}})
 ```
 
 For other aggregation types, including sub-aggregations, use `body_options`:
 
 ```ruby
-Product.search "orange", body_options: {aggs: {price: {histogram: {field: :price, interval: 10}}}}
+Product.search("orange", body_options: {aggs: {price: {histogram: {field: :price, interval: 10}}}})
 ```
 
 ## Highlight
@@ -878,7 +878,7 @@ Product.search "orange", body_options: {aggs: {price: {histogram: {field: :price
 Specify which fields to index with highlighting.
 
 ```ruby
-class Product < ApplicationRecord
+class Band < ApplicationRecord
   searchkick highlight: [:name]
 end
 ```
@@ -886,7 +886,7 @@ end
 Highlight the search query in the results.
 
 ```ruby
-bands = Band.search "cinema", highlight: true
+bands = Band.search("cinema", highlight: true)
 ```
 
 View the highlighted fields with:
@@ -900,19 +900,19 @@ end
 To change the tag, use:
 
 ```ruby
-Band.search "cinema", highlight: {tag: "<strong>"}
+Band.search("cinema", highlight: {tag: "<strong>"})
 ```
 
 To highlight and search different fields, use:
 
 ```ruby
-Band.search "cinema", fields: [:name], highlight: {fields: [:description]}
+Band.search("cinema", fields: [:name], highlight: {fields: [:description]})
 ```
 
 By default, the entire field is highlighted. To get small snippets instead, use:
 
 ```ruby
-bands = Band.search "cinema", highlight: {fragment_size: 20}
+bands = Band.search("cinema", highlight: {fragment_size: 20})
 bands.with_highlights(multiple: true).each do |band, highlights|
   highlights[:name].join(" and ")
 end
@@ -921,7 +921,7 @@ end
 Additional options can be specified for each field:
 
 ```ruby
-Band.search "cinema", fields: [:name], highlight: {fields: {name: {fragment_size: 200}}}
+Band.search("cinema", fields: [:name], highlight: {fields: {name: {fragment_size: 200}}})
 ```
 
 You can find available highlight options in the [Elasticsearch reference](https://www.elastic.co/guide/en/elasticsearch/reference/current/highlighting.html).
@@ -950,13 +950,13 @@ end
 Reindex and search with:
 
 ```ruby
-Restaurant.search "pizza", where: {location: {near: {lat: 37, lon: -114}, within: "100mi"}} # or 160km
+Restaurant.search("pizza", where: {location: {near: {lat: 37, lon: -114}, within: "100mi"}}) # or 160km
 ```
 
 Bounded by a box
 
 ```ruby
-Restaurant.search "sushi", where: {location: {top_left: {lat: 38, lon: -123}, bottom_right: {lat: 37, lon: -122}}}
+Restaurant.search("sushi", where: {location: {top_left: {lat: 38, lon: -123}, bottom_right: {lat: 37, lon: -122}}})
 ```
 
 **Note:** `top_right` and `bottom_left` also work
@@ -964,7 +964,7 @@ Restaurant.search "sushi", where: {location: {top_left: {lat: 38, lon: -123}, bo
 Bounded by a polygon
 
 ```ruby
-Restaurant.search "dessert", where: {location: {geo_polygon: {points: [{lat: 38, lon: -123}, {lat: 39, lon: -123}, {lat: 37, lon: 122}]}}}
+Restaurant.search("dessert", where: {location: {geo_polygon: {points: [{lat: 38, lon: -123}, {lat: 39, lon: -123}, {lat: 37, lon: 122}]}}})
 ```
 
 ### Boost By Distance
@@ -972,13 +972,13 @@ Restaurant.search "dessert", where: {location: {geo_polygon: {points: [{lat: 38,
 Boost results by distance - closer results are boosted more
 
 ```ruby
-Restaurant.search "noodles", boost_by_distance: {location: {origin: {lat: 37, lon: -122}}}
+Restaurant.search("noodles", boost_by_distance: {location: {origin: {lat: 37, lon: -122}}})
 ```
 
 Also supports [additional options](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html#function-decay)
 
 ```ruby
-Restaurant.search "wings", boost_by_distance: {location: {origin: {lat: 37, lon: -122}, function: "linear", scale: "30mi", decay: 0.5}}
+Restaurant.search("wings", boost_by_distance: {location: {origin: {lat: 37, lon: -122}, function: "linear", scale: "30mi", decay: 0.5}})
 ```
 
 ### Geo Shapes
@@ -1005,19 +1005,19 @@ See the [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsea
 Find shapes intersecting with the query shape
 
 ```ruby
-Restaurant.search "soup", where: {bounds: {geo_shape: {type: "polygon", coordinates: [[{lat: 38, lon: -123}, ...]]}}}
+Restaurant.search("soup", where: {bounds: {geo_shape: {type: "polygon", coordinates: [[{lat: 38, lon: -123}, ...]]}}})
 ```
 
 Falling entirely within the query shape
 
 ```ruby
-Restaurant.search "salad", where: {bounds: {geo_shape: {type: "circle", relation: "within", coordinates: [{lat: 38, lon: -123}], radius: "1km"}}}
+Restaurant.search("salad", where: {bounds: {geo_shape: {type: "circle", relation: "within", coordinates: [{lat: 38, lon: -123}], radius: "1km"}}})
 ```
 
 Not touching the query shape
 
 ```ruby
-Restaurant.search "burger", where: {bounds: {geo_shape: {type: "envelope", relation: "disjoint", coordinates: [{lat: 38, lon: -123}, {lat: 37, lon: -122}]}}}
+Restaurant.search("burger", where: {bounds: {geo_shape: {type: "envelope", relation: "disjoint", coordinates: [{lat: 38, lon: -123}, {lat: 37, lon: -122}]}}})
 ```
 
 ## Inheritance
@@ -1047,9 +1047,9 @@ Dog.reindex # equivalent, all animals reindexed
 And to search, use:
 
 ```ruby
-Animal.search "*"                   # all animals
-Dog.search "*"                      # just dogs
-Animal.search "*", type: [Dog, Cat] # just cats and dogs
+Animal.search("*")                   # all animals
+Dog.search("*")                      # just dogs
+Animal.search("*", type: [Dog, Cat]) # just cats and dogs
 ```
 
 **Notes:**
@@ -1057,7 +1057,7 @@ Animal.search "*", type: [Dog, Cat] # just cats and dogs
 1. The `suggest` option retrieves suggestions from the parent at the moment.
 
     ```ruby
-    Dog.search "airbudd", suggest: true # suggestions for all animals
+    Dog.search("airbudd", suggest: true) # suggestions for all animals
     ```
 2. This relies on a `type` field that is automatically added to the indexed document. Be wary of defining your own `type` field in `search_data`, as it will take precedence.
 
@@ -1100,7 +1100,7 @@ Product.search_index.tokens("dieg", analyzer: "searchkick_word_search")
 # ["dieg"] - match!!
 ```
 
-See the [complete list of analyzers](https://github.com/ankane/searchkick/blob/31780ddac7a89eab1e0552a32b403f2040a37931/lib/searchkick/index_options.rb#L32).
+See the [complete list of analyzers](lib/searchkick/index_options.rb#L36).
 
 ## Testing
 
@@ -1376,13 +1376,15 @@ Bonsai, Elastic Cloud, and Amazon OpenSearch Service all support encryption at r
 
 ### Automatic Failover
 
-Create an initializer `config/initializers/elasticsearch.rb` with multiple hosts:
+Create an initializer with multiple hosts:
 
 ```ruby
 ENV["ELASTICSEARCH_URL"] = "https://user:password@host1,https://user:password@host2"
+# or
+ENV["OPENSEARCH_URL"] = "https://user:password@host1,https://user:password@host2"
 ```
 
-See [elasticsearch-transport](https://github.com/elastic/elasticsearch-ruby/blob/master/elasticsearch-transport) for a complete list of options.
+See [elastic-transport](https://github.com/elastic/elastic-transport-ruby) or [opensearch-transport](https://github.com/opensearch-project/opensearch-ruby/tree/main/opensearch-transport) for a complete list of options.
 
 ### Lograge
 
@@ -1453,7 +1455,7 @@ end
 For large data sets, you can use background jobs to parallelize reindexing.
 
 ```ruby
-Product.reindex(async: true)
+Product.reindex(mode: :async)
 # {index_name: "products_production_20170111210018065"}
 ```
 
@@ -1478,7 +1480,7 @@ Searchkick.reindex_status(index_name)
 You can also have Searchkick wait for reindexing to complete
 
 ```ruby
-Product.reindex(async: {wait: true})
+Product.reindex(mode: :async, wait: true)
 ```
 
 You can use [ActiveJob::TrafficControl](https://github.com/nickelser/activejob-traffic_control) to control concurrency. Install the gem:
@@ -1504,7 +1506,7 @@ This will allow only 3 jobs to run at once.
 You can specify a longer refresh interval while reindexing to increase performance.
 
 ```ruby
-Product.reindex(async: true, refresh_interval: "30s")
+Product.reindex(mode: :async, refresh_interval: "30s")
 ```
 
 **Note:** This only makes a noticable difference with parallel reindexing.
@@ -1562,7 +1564,7 @@ end
 Reindex and search with:
 
 ```ruby
-Business.search "ice cream", routing: params[:city_id]
+Business.search("ice cream", routing: params[:city_id])
 ```
 
 ### Partial Reindexing
@@ -1685,7 +1687,7 @@ end
 And use the `body` option to search:
 
 ```ruby
-products = Product.search body: {query: {match: {name: "milk"}}}
+products = Product.search(body: {query: {match: {name: "milk"}}})
 ```
 
 View the response with:
@@ -1697,21 +1699,21 @@ products.response
 To modify the query generated by Searchkick, use:
 
 ```ruby
-products = Product.search "milk", body_options: {min_score: 1}
+products = Product.search("milk", body_options: {min_score: 1})
 ```
 
 or
 
 ```ruby
 products =
-  Product.search "apples" do |body|
+  Product.search("apples") do |body|
     body[:min_score] = 1
   end
 ```
 
 ### Client
 
-Searchkick is built on top of the [elasticsearch](https://github.com/elastic/elasticsearch-ruby) gem. To access the client directly, use:
+To access the `Elasticsearch::Client` or `OpenSearch::Client` directly, use:
 
 ```ruby
 Searchkick.client
@@ -1736,7 +1738,7 @@ Then use `products` and `coupons` as typical results.
 Search across multiple models with:
 
 ```ruby
-Searchkick.search "milk", models: [Product, Category]
+Searchkick.search("milk", models: [Product, Category])
 ```
 
 Boost specific models with:
@@ -1762,7 +1764,7 @@ end
 You can also scroll batches manually.
 
 ```ruby
-products = Product.search "*", scroll: "1m"
+products = Product.search("*", scroll: "1m")
 while products.any?
   # process batch ...
 
@@ -1793,7 +1795,7 @@ Product.search("pears", body_options: {track_total_hits: true})
 To query nested data, use dot notation.
 
 ```ruby
-User.search "san", fields: ["address.city"], where: {"address.zip_code" => 12345}
+Product.search("san", fields: ["store.city"], where: {"store.zip_code" => 12345})
 ```
 
 ## Reference
@@ -1923,7 +1925,7 @@ Searchkick.queue_name = :search_reindex
 Eager load associations
 
 ```ruby
-Product.search "milk", includes: [:brand, :stores]
+Product.search("milk", includes: [:brand, :stores])
 ```
 
 Eager load different associations by model
@@ -1935,7 +1937,7 @@ Searchkick.search("*",  models: [Product, Store], model_includes: {Product => [:
 Run additional scopes on results
 
 ```ruby
-Product.search "milk", scope_results: ->(r) { r.with_attached_images }
+Product.search("milk", scope_results: ->(r) { r.with_attached_images })
 ```
 
 Specify default fields to search
@@ -2031,13 +2033,13 @@ rake searchkick:reindex:all
 Turn on misspellings after a certain number of characters
 
 ```ruby
-Product.search "api", misspellings: {prefix_length: 2} # api, apt, no ahi
+Product.search("api", misspellings: {prefix_length: 2}) # api, apt, no ahi
 ```
 
 **Note:** With this option, if the query length is the same as `prefix_length`, misspellings are turned off with Elasticsearch 7 and OpenSearch
 
 ```ruby
-Product.search "ah", misspellings: {prefix_length: 2} # ah, no aha
+Product.search("ah", misspellings: {prefix_length: 2}) # ah, no aha
 ```
 
 ## Gotchas
@@ -2087,9 +2089,17 @@ Product.search("milk")
 Product.search("milk").to_a
 ```
 
+You can reindex relations in the background:
+
+```ruby
+store.products.reindex(mode: :async)
+# or
+store.products.reindex(mode: :queue)
+```
+
 And there’s a [new option](#default-scopes) for models with default scopes.
 
-Check out the [changelog](https://github.com/ankane/searchkick/blob/master/CHANGELOG.md) for the full list of changes.
+Check out the [changelog](https://github.com/ankane/searchkick/blob/master/CHANGELOG.md#500-2022-02-21) for the full list of changes.
 
 ## History
 

data/lib/searchkick/index.rb

@@ -71,12 +71,12 @@ module Searchkick
           }
         )
 
-      Searchkick::Results.new(nil, response).total_count
+      Results.new(nil, response).total_count
     end
 
     def promote(new_name, update_refresh_interval: false)
       if update_refresh_interval
-        new_index = Searchkick::Index.new(new_name, @options)
+        new_index = Index.new(new_name, @options)
         settings = options[:settings] || {}
         refresh_interval = (settings[:index] && settings[:index][:refresh_interval]) || "1s"
         new_index.update_settings(index: {refresh_interval: refresh_interval})
@@ -123,7 +123,7 @@ module Searchkick
     def clean_indices
       indices = all_indices(unaliased: true)
       indices.each do |index|
-        Searchkick::Index.new(index).delete
+        Index.new(index).delete
       end
       indices
     end
@@ -204,7 +204,7 @@ module Searchkick
     # queue
 
     def reindex_queue
-      Searchkick::ReindexQueue.new(name)
+      ReindexQueue.new(name)
     end
 
     # reindex
@@ -237,13 +237,26 @@ module Searchkick
         self.refresh if refresh
         true
       else
+        async = options.delete(:async)
+        if async
+          if async.is_a?(Hash) && async[:wait]
+            # TODO warn in 5.1
+            # Searchkick.warn "async option is deprecated - use mode: :async, wait: true instead"
+            options[:wait] = true unless options.key?(:wait)
+          else
+            # TODO warn in 5.1
+            # Searchkick.warn "async option is deprecated - use mode: :async instead"
+          end
+          options[:mode] ||= :async
+        end
+
         full_reindex(relation, **options)
       end
     end
 
     def create_index(index_options: nil)
       index_options ||= self.index_options
-      index = Searchkick::Index.new("#{name}_#{Time.now.strftime('%Y%m%d%H%M%S%L')}", @options)
+      index = Index.new("#{name}_#{Time.now.strftime('%Y%m%d%H%M%S%L')}", @options)
       index.create(index_options)
       index
     end
@@ -326,7 +339,7 @@ module Searchkick
     end
 
     def reindex_records(object, mode: nil, refresh: false, **options)
-      mode ||= Searchkick.callbacks_value || @options[:callbacks] || true
+      mode ||= Searchkick.callbacks_value || @options[:callbacks] || :inline
       mode = :inline if mode == :bulk
 
       result = RecordIndexer.new(self).reindex(object, mode: mode, full: false, **options)
@@ -336,12 +349,13 @@ module Searchkick
 
     # https://gist.github.com/jarosan/3124884
     # http://www.elasticsearch.org/blog/changing-mapping-with-zero-downtime/
-    # TODO deprecate async in favor of mode: :async, wait: true/false
-    def full_reindex(relation, import: true, resume: false, retain: false, async: false, refresh_interval: nil, scope: nil)
+    def full_reindex(relation, import: true, resume: false, retain: false, mode: nil, refresh_interval: nil, scope: nil, wait: nil)
+      raise ArgumentError, "wait only available in :async mode" if !wait.nil? && mode != :async
+
       if resume
         index_name = all_indices.sort.last
-        raise Searchkick::Error, "No index to resume" unless index_name
-        index = Searchkick::Index.new(index_name, @options)
+        raise Error, "No index to resume" unless index_name
+        index = Index.new(index_name, @options)
       else
         clean_indices unless retain
 
@@ -351,7 +365,7 @@ module Searchkick
       end
 
       import_options = {
-        mode: (async ? :async : :inline),
+        mode: (mode || :inline),
         full: true,
         resume: resume,
         scope: scope
@@ -365,7 +379,7 @@ module Searchkick
         import_before_promotion(index, relation, **import_options) if import
 
         # get existing indices to remove
-        unless async
+        unless mode == :async
           check_uuid(uuid, index.uuid)
           promote(index.name, update_refresh_interval: !refresh_interval.nil?)
           clean_indices unless retain
@@ -378,8 +392,8 @@ module Searchkick
         index.import_scope(relation, **import_options) if import
       end
 
-      if async
-        if async.is_a?(Hash) && async[:wait]
+      if mode == :async
+        if wait
           puts "Created index: #{index.name}"
           puts "Jobs queued. Waiting..."
           loop do
@@ -417,7 +431,7 @@ module Searchkick
     # https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html#index-creation
     def check_uuid(old_uuid, new_uuid)
       if old_uuid != new_uuid
-        raise Searchkick::Error, "Safety check failed - only run one Model.reindex per model at a time"
+        raise Error, "Safety check failed - only run one Model.reindex per model at a time"
       end
     end
 

data/lib/searchkick/index_options.rb

@@ -513,7 +513,7 @@ module Searchkick
         else
           [:searchkick_search2, :searchkick_word_search].each do |analyzer|
             unless settings[:analysis][:analyzer][analyzer].key?(:filter)
-              raise Searchkick::Error, "Search synonyms are not supported yet for language"
+              raise Error, "Search synonyms are not supported yet for language"
             end
 
             settings[:analysis][:analyzer][analyzer][:filter].insert(2, "searchkick_synonym_graph")

data/lib/searchkick/model.rb

@@ -22,16 +22,18 @@ module Searchkick
         raise ArgumentError, "Invalid value for callbacks"
       end
 
+      base = self
+
       mod = Module.new
       include(mod)
       mod.module_eval do
         def reindex(method_name = nil, mode: nil, refresh: false)
           self.class.searchkick_index.reindex([self], method_name: method_name, mode: mode, refresh: refresh, single: true)
-        end
+        end unless base.method_defined?(:reindex)
 
         def similar(**options)
           self.class.searchkick_index.similar_record(self, **options)
-        end
+        end unless base.method_defined?(:similar)
 
         def search_data
           data = respond_to?(:to_hash) ? to_hash : serializable_hash
@@ -39,11 +41,11 @@ module Searchkick
           data.delete("_id")
           data.delete("_type")
           data
-        end
+        end unless base.method_defined?(:search_data)
 
         def should_index?
           true
-        end
+        end unless base.method_defined?(:should_index?)
       end
 
       class_eval do
@@ -64,10 +66,10 @@ module Searchkick
           alias_method Searchkick.search_method_name, :searchkick_search if Searchkick.search_method_name
 
           def searchkick_index(name: nil)
-            index = name || searchkick_index_name
-            index = index.call if index.respond_to?(:call)
+            index_name = name || searchkick_klass.searchkick_index_name
+            index_name = index_name.call if index_name.respond_to?(:call)
             index_cache = class_variable_get(:@@searchkick_index_cache)
-            index_cache.fetch(index) { Searchkick::Index.new(index, searchkick_options) }
+            index_cache.fetch(index_name) { Searchkick::Index.new(index_name, searchkick_options) }
           end
           alias_method :search_index, :searchkick_index unless method_defined?(:search_index)
 

data/lib/searchkick/query.rb

@@ -187,11 +187,11 @@ module Searchkick
       end
 
       # set execute for multi search
-      @execute = Searchkick::Results.new(searchkick_klass, response, opts)
+      @execute = Results.new(searchkick_klass, response, opts)
     end
 
     def retry_misspellings?(response)
-      @misspellings_below && Searchkick::Results.new(searchkick_klass, response).total_count < @misspellings_below
+      @misspellings_below && Results.new(searchkick_klass, response).total_count < @misspellings_below
     end
 
     private

data/lib/searchkick/record_data.rb

@@ -25,6 +25,7 @@ module Searchkick
       {delete: record_data}
     end
 
+    # custom id can be useful for load: false
     def search_id
       id = record.respond_to?(:search_document_id) ? record.search_document_id : record.id
       id.is_a?(Numeric) ? id : id.to_s

data/lib/searchkick/record_indexer.rb

@@ -14,7 +14,7 @@ module Searchkick
       case mode
       when :async
         unless defined?(ActiveJob)
-          raise Searchkick::Error, "Active Job not found"
+          raise Error, "Active Job not found"
         end
 
         # we could likely combine ReindexV2Job, BulkReindexJob, and ProcessBatchJob
@@ -45,7 +45,7 @@ module Searchkick
         end
       when :queue
         if method_name
-          raise Searchkick::Error, "Partial reindex not supported with queue option"
+          raise Error, "Partial reindex not supported with queue option"
         end
 
         index.reindex_queue.push_records(records)

data/lib/searchkick/reindex_queue.rb

@@ -5,7 +5,7 @@ module Searchkick
     def initialize(name)
       @name = name
 
-      raise Searchkick::Error, "Searchkick.redis not set" unless Searchkick.redis
+      raise Error, "Searchkick.redis not set" unless Searchkick.redis
     end
 
     # supports single and multiple ids

data/lib/searchkick/relation.rb

@@ -1,13 +1,20 @@
 module Searchkick
   class Relation
+    NO_DEFAULT_VALUE = Object.new
+
     # note: modifying body directly is not supported
     # and has no impact on query after being executed
     # TODO freeze body object?
-    delegate :body, :params, to: :@query
+    delegate :body, :params, to: :query
     delegate_missing_to :private_execute
 
     def initialize(model, term = "*", **options)
-      @query = Query.new(model, term, **options)
+      @model = model
+      @term = term
+      @options = options
+
+      # generate query to validate options
+      query
     end
 
     # same as Active Record
@@ -23,14 +30,196 @@ module Searchkick
       self
     end
 
+    # experimental
+    def limit(value)
+      clone.limit!(value)
+    end
+
+    # experimental
+    def limit!(value)
+      check_loaded
+      @options[:limit] = value
+      self
+    end
+
+    # experimental
+    def offset(value = NO_DEFAULT_VALUE)
+      # TODO remove in Searchkick 6
+      if value == NO_DEFAULT_VALUE
+        private_execute.offset
+      else
+        clone.offset!(value)
+      end
+    end
+
+    # experimental
+    def offset!(value)
+      check_loaded
+      @options[:offset] = value
+      self
+    end
+
+    # experimental
+    def page(value)
+      clone.page!(value)
+    end
+
+    # experimental
+    def page!(value)
+      check_loaded
+      @options[:page] = value
+      self
+    end
+
+    # experimental
+    def per_page(value = NO_DEFAULT_VALUE)
+      # TODO remove in Searchkick 6
+      if value == NO_DEFAULT_VALUE
+        private_execute.per_page
+      else
+        clone.per_page!(value)
+      end
+    end
+
+    # experimental
+    def per_page!(value)
+      check_loaded
+      @options[:per_page] = value
+      self
+    end
+
+    # experimental
+    def where(value = NO_DEFAULT_VALUE)
+      if value == NO_DEFAULT_VALUE
+        Where.new(self)
+      else
+        clone.where!(value)
+      end
+    end
+
+    # experimental
+    def where!(value)
+      check_loaded
+      if @options[:where]
+        @options[:where] = {_and: [@options[:where], ensure_permitted(value)]}
+      else
+        @options[:where] = ensure_permitted(value)
+      end
+      self
+    end
+
+    # experimental
+    def rewhere(value)
+      clone.rewhere!(value)
+    end
+
+    # experimental
+    def rewhere!(value)
+      check_loaded
+      @options[:where] = ensure_permitted(value)
+      self
+    end
+
+    # experimental
+    def order(*values)
+      clone.order!(*values)
+    end
+
+    # experimental
+    def order!(*values)
+      values = values.first if values.size == 1 && values.first.is_a?(Array)
+      check_loaded
+      (@options[:order] ||= []).concat(values)
+      self
+    end
+
+    # experimental
+    def reorder(*values)
+      clone.reorder!(*values)
+    end
+
+    # experimental
+    def reorder!(*values)
+      check_loaded
+      @options[:order] = values
+      self
+    end
+
+    # experimental
+    def select(*values, &block)
+      if block_given?
+        private_execute.select(*values, &block)
+      else
+        clone.select!(*values)
+      end
+    end
+
+    # experimental
+    def select!(*values)
+      check_loaded
+      (@options[:select] ||= []).concat(values)
+      self
+    end
+
+    # experimental
+    def reselect(*values)
+      clone.reselect!(*values)
+    end
+
+    # experimental
+    def reselect!(*values)
+      check_loaded
+      @options[:select] = values
+      self
+    end
+
+    # experimental
+    def includes(*values)
+      clone.includes!(*values)
+    end
+
+    # experimental
+    def includes!(*values)
+      check_loaded
+      (@options[:includes] ||= []).concat(values)
+      self
+    end
+
+    # experimental
+    def only(*keys)
+      Relation.new(@model, @term, **@options.slice(*keys))
+    end
+
+    # experimental
+    def except(*keys)
+      Relation.new(@model, @term, **@options.except(*keys))
+    end
+
+    def loaded?
+      !@execute.nil?
+    end
+
     private
 
     def private_execute
-      @execute ||= @query.execute
+      @execute ||= query.execute
     end
 
     def query
-      @query
+      @query ||= Query.new(@model, @term, **@options)
+    end
+
+    def check_loaded
+      raise Error, "Relation loaded" if loaded?
+
+      # reset query since options will change
+      @query = nil
+    end
+
+    # provides *very* basic protection from unfiltered parameters
+    # this is not meant to be comprehensive and may be expanded in the future
+    def ensure_permitted(obj)
+      obj.to_h
     end
   end
 end

data/lib/searchkick/results.rb

@@ -141,7 +141,7 @@ module Searchkick
 
     def hits
       if error
-        raise Searchkick::Error, "Query error - use the error method to view it"
+        raise Error, "Query error - use the error method to view it"
       else
         @response["hits"]["hits"]
       end
@@ -178,7 +178,7 @@ module Searchkick
     end
 
     def scroll
-      raise Searchkick::Error, "Pass `scroll` option to the search method for scrolling" unless scroll_id
+      raise Error, "Pass `scroll` option to the search method for scrolling" unless scroll_id
 
       if block_given?
         records = self
@@ -191,10 +191,10 @@ module Searchkick
       else
         begin
           # TODO Active Support notifications for this scroll call
-          Searchkick::Results.new(@klass, Searchkick.client.scroll(scroll: options[:scroll], body: {scroll_id: scroll_id}), @options)
+          Results.new(@klass, Searchkick.client.scroll(scroll: options[:scroll], body: {scroll_id: scroll_id}), @options)
         rescue => e
           if Searchkick.not_found_error?(e) && e.message =~ /search_context_missing_exception/i
-            raise Searchkick::Error, "Scroll id has expired"
+            raise Error, "Scroll id has expired"
           else
             raise e
           end
@@ -232,7 +232,7 @@ module Searchkick
                 index_alias = index.split("_")[0..-2].join("_")
                 Array((options[:index_mapping] || {})[index_alias])
               end
-            raise Searchkick::Error, "Unknown model for index: #{index}. Pass the `models` option to the search method." unless models.any?
+            raise Error, "Unknown model for index: #{index}. Pass the `models` option to the search method." unless models.any?
             index_models[index] = models
           end
 

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "5.0.0"
+  VERSION = "5.0.3"
 end

data/lib/searchkick/where.rb

@@ -0,0 +1,11 @@
+module Searchkick
+  class Where
+    def initialize(relation)
+      @relation = relation
+    end
+
+    def not(value)
+      @relation.where(_not: value)
+    end
+  end
+end

data/lib/searchkick.rb

@@ -27,6 +27,7 @@ require "searchkick/relation"
 require "searchkick/relation_indexer"
 require "searchkick/results"
 require "searchkick/version"
+require "searchkick/where"
 
 # integrations
 require "searchkick/railtie" if defined?(Rails)
@@ -171,7 +172,7 @@ module Searchkick
     end
 
     options = options.merge(block: block) if block
-    Searchkick::Relation.new(klass, term, **options)
+    Relation.new(klass, term, **options)
   end
 
   def self.multi_search(queries)
@@ -183,7 +184,7 @@ module Searchkick
       body: queries.flat_map { |q| [q.params.except(:body).to_json, q.body.to_json] }.map { |v| "#{v}\n" }.join,
     }
     ActiveSupport::Notifications.instrument("multi_search.searchkick", event) do
-      Searchkick::MultiSearch.new(queries).perform
+      MultiSearch.new(queries).perform
     end
   end
 
@@ -241,9 +242,9 @@ module Searchkick
   end
 
   def self.reindex_status(index_name)
-    raise Searchkick::Error, "Redis not configured" unless redis
+    raise Error, "Redis not configured" unless redis
 
-    batches_left = Searchkick::Index.new(index_name).batches_left
+    batches_left = Index.new(index_name).batches_left
     {
       completed: batches_left == 0,
       batches_left: batches_left

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.0.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2022-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -71,6 +71,7 @@ files:
 - lib/searchkick/relation_indexer.rb
 - lib/searchkick/results.rb
 - lib/searchkick/version.rb
+- lib/searchkick/where.rb
 - lib/tasks/searchkick.rake
 homepage: https://github.com/ankane/searchkick
 licenses:
@@ -91,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Intelligent search made easy with Rails and Elasticsearch or OpenSearch