searchkick 2.5.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48b011f59eaeb3f3b2213e20bf2206d4963f7bb0
-  data.tar.gz: d3ffbd07eda7ca733915c251ce8b1e1c9c146e44
+  metadata.gz: 0114d21ec3a6707c49408e641fa27a5591cc9eca
+  data.tar.gz: d723af7de81aa5ff40818fcd229029724a0fcda7
 SHA512:
-  metadata.gz: 910eaa5810045780efabe7874e0c4e6bb669ad30c3f1bead3c37ab1f817e21a5e73c55acfcf7ffeacc63be95e163ddb5470b4912967379062afab45413d9d8ea
-  data.tar.gz: eae561c188d98071116695b8997f95ac31f1d0229fc56f968193aaac423020ee1219344568c61e2e1d7ddeee94f583189300845b5f5927a7122ab2cf5305f127
+  metadata.gz: 04b026c1acdd413476a2099f7b0b335c207f286e4aadd9d323f0f5d8f5bc18cd15da2219040830a12f258dba497c9412510815fd2af70682e3579239caeaabba
+  data.tar.gz: e41240ef1831b869311c588a3a6d87c054607fedd2d3da3d56db4d220ae7c1038a317cb703f220b36f06c2ada8b99f2a34cd8e3b7f7c046d6ad2fb2115004a3c

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,7 @@
+Hi,
+
+Before creating an issue, please check out the Contributing Guide:
+
+https://github.com/ankane/searchkick/blob/master/CONTRIBUTING.md
+
+Thanks!

data/.travis.yml

@@ -20,22 +20,13 @@ gemfile:
   - test/gemfiles/mongoid5.gemfile
   - test/gemfiles/mongoid6.gemfile
 env:
-  - ELASTICSEARCH_VERSION=6.2.1
+  - ELASTICSEARCH_VERSION=6.2.2
 jdk: oraclejdk8
 matrix:
   include:
-    - gemfile: Gemfile
-      env: ELASTICSEARCH_VERSION=2.0.0
-      jdk: oraclejdk7
-    - gemfile: Gemfile
-      env: ELASTICSEARCH_VERSION=2.4.6
-      jdk: oraclejdk7
     - gemfile: Gemfile
       env: ELASTICSEARCH_VERSION=5.0.1
-      jdk: oraclejdk8
     - gemfile: Gemfile
-      env: ELASTICSEARCH_VERSION=5.6.4
-      jdk: oraclejdk8
+      env: ELASTICSEARCH_VERSION=5.6.7
     - gemfile: Gemfile
       env: ELASTICSEARCH_VERSION=6.0.0
-      jdk: oraclejdk8

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## 3.0.0
+
+- Added support for Chinese
+- Results can be marshaled by default (unless using `highlight` option)
+
+Breaking changes
+
+- Removed support for Elasticsearch 2
+- Removed support for ActiveRecord < 4.2 and Mongoid < 5
+- Types are no longer used
+- The `_all` field is disabled by default in Elasticsearch 5
+- Conversions are not stemmed by default
+- An `ArgumentError` is raised instead of a warning when options are incompatible with the `body` option
+- Removed `log` option from `boost_by`
+- Removed `Model.enable_search_callbacks`, `Model.disable_search_callbacks`, and `Model.search_callbacks?`
+- Removed `reindex_async` method, as `reindex` now defaults to callbacks mode specified on the model
+- Removed `async` option from `record.reindex`
+- Removed `search_hit` method - use `with_hit` instead
+- Removed `each_with_hit` - use `with_hit.each` instead
+- Removed `with_details` - use `with_highlights` instead
+- Bumped default `limit` to 10,000
+
 ## 2.5.0
 
 - Try requests 3 times before raising error

data/CONTRIBUTING.md

@@ -29,7 +29,7 @@ Product.search("something", debug: true)
 
 If the above steps don’t help, create an issue.
 
-- For incorrect search results, recreate the problem by forking [this gist](https://gist.github.com/ankane/f80b0923d9ae2c077f41997f7b704e5c). Include a link to your gist and the output in the issue.
+- Recreate the problem by forking [this gist](https://gist.github.com/ankane/f80b0923d9ae2c077f41997f7b704e5c). Include a link to your gist and the output in the issue.
 - For exceptions, include the complete backtrace.
 
 ## Pull Requests

data/Gemfile

@@ -4,13 +4,13 @@ source "https://rubygems.org"
 gemspec
 
 gem "sqlite3"
-gem "activerecord", "~> 5.1.0"
+gem "activerecord", "~> 5.2.0.rc1"
 gem "gemoji-parser"
 gem "typhoeus"
-gem "activejob"
+gem "activejob", "~> 5.2.0.rc1"
 gem "redis"
 gem "connection_pool"
 
 # kaminari
-gem "actionpack"
+gem "actionpack", "~> 5.2.0.rc1"
 gem "kaminari"

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2016 Andrew Kane
+Copyright (c) 2013-2018 Andrew Kane
 
 MIT License
 

data/README.md

@@ -2,7 +2,7 @@
 
 :rocket: Intelligent search made easy
 
-Searchkick learns what **your users** are looking for. As more people search, it gets smarter and the results get better. It’s friendly for developers - and magical for your users.
+**Searchkick learns what your users are looking for.** As more people search, it gets smarter and the results get better. It’s friendly for developers - and magical for your users.
 
 Searchkick handles:
 
@@ -27,6 +27,12 @@ Plus:
 
 [![Build Status](https://travis-ci.org/ankane/searchkick.svg?branch=master)](https://travis-ci.org/ankane/searchkick)
 
+---
+
+Does your startup use Searchkick? Want a free hour of advising? Fill out [this application](https://goo.gl/forms/Or1HQTRb2rgQCNtd2). I’ll reach out to a few companies.
+
+---
+
 ## Contents
 
 - [Getting Started](#getting-started)
@@ -39,6 +45,10 @@ Plus:
 - [Elasticsearch DSL](#advanced)
 - [Reference](#reference)
 
+**Searchkick 3.0 was recently released!** See [how to upgrade](docs/Searchkick-3-Upgrade.md)
+
+Thinking of upgrading from Elasticsearch 5 to 6? [Read this first](#elasticsearch-5-to-6-upgrade)
+
 ## Getting Started
 
 [Install Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/setup.html). For Homebrew, use:
@@ -54,7 +64,7 @@ Add this line to your application’s Gemfile:
 gem 'searchkick'
 ```
 
-The latest version works with Elasticsearch 2, 5, and 6. For Elasticsearch 1, use version 1.5.1 and [this readme](https://github.com/ankane/searchkick/blob/v1.5.1/README.md).
+The latest version works with Elasticsearch 5 and 6. For Elasticsearch 2, use version 2.5.0 and [this readme](https://github.com/ankane/searchkick/blob/v2.5.0/README.md).
 
 Add searchkick to models you want to search.
 
@@ -73,7 +83,7 @@ Product.reindex
 And to query, use:
 
 ```ruby
-products = Product.search("apples", fields: [:name])
+products = Product.search("apples")
 products.each do |product|
   puts product.name
 end
@@ -289,6 +299,14 @@ end
 
 [See the list of stemmers](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-stemmer-tokenfilter.html)
 
+For Chinese, install the [elasticsearch-analysis-ik plugin](https://github.com/medcl/elasticsearch-analysis-ik) and use:
+
+```ruby
+class Product < ApplicationRecord
+  searchkick language: "chinese"
+end
+```
+
 ### Synonyms
 
 ```ruby
@@ -492,7 +510,7 @@ There are four strategies for keeping the index synced with your database.
   end
   ```
 
-  And [install Active Job](https://github.com/ankane/activejob_backport) for Rails 4.1 and below. Jobs are added to a queue named `searchkick`.
+  Jobs are added to a queue named `searchkick`.
 
 3. Queuing
 
@@ -535,7 +553,7 @@ class Image < ApplicationRecord
   after_commit :reindex_product
 
   def reindex_product
-    product.reindex # or reindex_async
+    product.reindex
   end
 end
 ```
@@ -563,7 +581,7 @@ Searchkick can use conversion data to learn what users are looking for. If a use
 
 The first step is to define your conversion metric and start tracking conversions. The database works well for low volume, but feel free to use Redis or another datastore.
 
-You do **not** need to clean up the search queries. Searchkick automatically treats `apple` and `APPLES` the same.
+Searchkick automatically treats `apple` and `APPLE` the same.
 
 Next, add conversions to the index.
 
@@ -571,7 +589,7 @@ Next, add conversions to the index.
 class Product < ApplicationRecord
   has_many :searches, class_name: "Searchjoy::Search", as: :convertable
 
-  searchkick conversions: ["conversions"] # name of field
+  searchkick conversions: [:conversions] # name of field
 
   def search_data
     {
@@ -767,63 +785,6 @@ For other aggregation types, including sub-aggregations, use `body_options`:
 Product.search "orange", body_options: {aggs: {price: {histogram: {field: :price, interval: 10}}}
 ```
 
-#### Moving From Facets
-
-1. Replace `facets` with `aggs` in searches. **Note:** Stats facets are not supported at this time.
-
-  ```ruby
-  products = Product.search "chuck taylor", facets: [:brand]
-  # to
-  products = Product.search "chuck taylor", aggs: [:brand]
-  ```
-
-2. Replace the `facets` method with `aggs` for results.
-
-  ```ruby
-  products.facets
-  # to
-  products.aggs
-  ```
-
-  The keys in results differ slightly. Instead of:
-
-  ```json
-  {
-    "_type":"terms",
-    "missing":0,
-    "total":45,
-    "other":34,
-    "terms":[
-      {"term":14.0,"count":11}
-    ]
-  }
-  ```
-
-  You get:
-
-  ```json
-  {
-    "doc_count":45,
-    "doc_count_error_upper_bound":0,
-    "sum_other_doc_count":34,
-    "buckets":[
-      {"key":14.0,"doc_count":11}
-    ]
-  }
-  ```
-
-  Update your application to handle this.
-
-3. By default, `where` conditions apply to aggregations. This is equivalent to `smart_facets: true`. If you have `smart_facets: true`, you can remove it. If this is not desired, set `smart_aggs: false`.
-
-4. If you have any range facets with dates, change the key from `ranges` to `date_ranges`.
-
-  ```ruby
-  facets: {date_field: {ranges: date_ranges}}
-  # to
-  aggs: {date_field: {date_ranges: date_ranges}}
-  ```
-
 ### Highlight
 
 Specify which fields to index with highlighting.
@@ -837,23 +798,21 @@ end
 Highlight the search query in the results.
 
 ```ruby
-bands = Band.search "cinema", fields: [:name], highlight: true
+bands = Band.search "cinema", highlight: true
 ```
 
-**Note:** The `fields` option is required, unless highlight options are given - see below.
-
 View the highlighted fields with:
 
 ```ruby
-bands.each do |band|
-  band.search_highlights[:name] # "Two Door <em>Cinema</em> Club"
+bands.with_highlights.each do |band, highlights|
+  highlights[:name] # "Two Door <em>Cinema</em> Club"
 end
 ```
 
 To change the tag, use:
 
 ```ruby
-Band.search "cinema", fields: [:name], highlight: {tag: "<strong>"}
+Band.search "cinema", highlight: {tag: "<strong>"}
 ```
 
 To highlight and search different fields, use:
@@ -862,7 +821,16 @@ To highlight and search different fields, use:
 Band.search "cinema", fields: [:name], highlight: {fields: [:description]}
 ```
 
-Additional options, including fragment size, can be specified for each field:
+By default, the entire field is highlighted. To get small snippets instead, use:
+
+```ruby
+bands = Band.search "cinema", highlight: {fragment_size: 20}
+bands.with_highlights(multiple: true).each do |band, highlights|
+  highlights[:name].join(" and ")
+end
+```
+
+Additional options can be specified for each field:
 
 ```ruby
 Band.search "cinema", fields: [:name], highlight: {fields: {name: {fragment_size: 200}}}
@@ -966,7 +934,7 @@ Not touching the query shape
 Restaurant.search "burger", where: {bounds: {geo_shape: {type: "envelope", relation: "disjoint", coordinates: [{lat: 38, lon: -123}, {lat: 37, lon: -122}]}}}
 ```
 
-Containing the query shape (Elasticsearch 2.2+)
+Containing the query shape
 
 ```ruby
 Restaurant.search "fries", where: {bounds: {geo_shape: {type: "envelope", relation: "contains", coordinates: [{lat: 38, lon: -123}, {lat: 37, lon: -122}]}}}
@@ -1093,12 +1061,6 @@ heroku run rake searchkick:reindex CLASS=Product
 
 ### Amazon Elasticsearch Service
 
-Include `elasticsearch 1.0.15` or greater in your Gemfile.
-
-```ruby
-gem 'elasticsearch', '>= 1.0.15'
-```
-
 Create an initializer `config/initializers/elasticsearch.rb` with:
 
 ```ruby
@@ -1108,7 +1070,7 @@ ENV["ELASTICSEARCH_URL"] = "https://es-domain-1234.us-east-1.es.amazonaws.com"
 To use signed request, include in your Gemfile:
 
 ```ruby
-gem 'faraday_middleware-aws-signers-v4', '>= 0.1.9'
+gem 'faraday_middleware-aws-sigv4'
 ```
 
 and add to your initializer:
@@ -1147,10 +1109,6 @@ Create an initializer `config/initializers/elasticsearch.rb` with multiple hosts
 
 ```ruby
 ENV["ELASTICSEARCH_URL"] = "http://localhost:9200,http://localhost:9201"
-
-Searchkick.client_options = {
-  retry_on_failure: true
-}
 ```
 
 See [elasticsearch-transport](https://github.com/elastic/elasticsearch-ruby/blob/master/elasticsearch-transport) for a complete list of options.
@@ -1192,7 +1150,7 @@ gem 'typhoeus'
 To reduce log noise, create an initializer with:
 
 ```ruby
-Ethon.logger = Logger.new("/dev/null")
+Ethon.logger = Logger.new(nil)
 ```
 
 If you run into issues on Windows, check out [this post](https://www.rastating.com/fixing-issues-in-typhoeus-and-httparty-on-windows/).
@@ -1217,7 +1175,7 @@ class Product < ApplicationRecord
 end
 ```
 
-**Note:** Non-string fields will always be filterable and should not be passed to this option.
+**Note:** Non-string fields are always filterable and should not be passed to this option.
 
 ### Parallel Reindexing
 
@@ -1535,8 +1493,6 @@ Reindex one record
 ```ruby
 product = Product.find(1)
 product.reindex
-# or to reindex in the background
-product.reindex_async
 ```
 
 Reindex multiple records
@@ -1666,7 +1622,7 @@ Eager load different associations by model
 Searchkick.search("*",  index_name: [Product, Store], model_includes: {Product => [:store], Store => [:product]})
 ```
 
-Run additional scopes on results [master]
+Run additional scopes on results
 
 ```ruby
 Product.search "milk", scope_results: ->(r) { r.with_attached_images }
@@ -1804,9 +1760,9 @@ RSpec.configure do |config|
   end
 
   config.around(:each, search: true) do |example|
-    Searchkick.enable_callbacks
-    example.run
-    Searchkick.disable_callbacks
+    Searchkick.callbacks(true) do
+      example.run
+    end
   end
 end
 ```
@@ -1858,60 +1814,27 @@ Searchkick.index_suffix = ENV["TEST_ENV_NUMBER"]
 
 Check out [this great post](https://www.tiagoamaro.com.br/2014/12/11/multi-tenancy-with-searchkick/) on the [Apartment](https://github.com/influitive/apartment) gem. Follow a similar pattern if you use another gem.
 
-## Upgrading
-
-View the [changelog](https://github.com/ankane/searchkick/blob/master/CHANGELOG.md).
-
-Important notes are listed below.
-
-### 2.0.0
-
-- Added support for `reindex` on associations
-
-#### Breaking Changes
-
-- Removed support for Elasticsearch 1 as it reaches [end of life](https://www.elastic.co/support/eol)
-- Removed facets, legacy options, and legacy methods
-- Invalid options now throw an `ArgumentError`
-- The `query` and `json` options have been removed in favor of `body`
-- The `include` option has been removed in favor of `includes`
-- The `personalize` option has been removed in favor of `boost_where`
-- The `partial` option has been removed in favor of `operator`
-- Renamed `select_v2` to `select` (legacy `select` no longer available)
-- The `_all` field is disabled if `searchable` option is used (for performance)
-- The `partial_reindex(:method_name)` method has been replaced with `reindex(:method_name)`
-- The `unsearchable` and `only_analyzed` options have been removed in favor of `searchable` and `filterable`
-- `load: false` no longer returns an array in Elasticsearch 2
-
-### 1.0.0
-
-- Added support for Elasticsearch 2.0
-- Facets are deprecated in favor of [aggregations](#aggregations) - see [how to upgrade](#moving-from-facets)
-
-#### Breaking Changes
-
-- **ActiveRecord 4.1+ and Mongoid 3+:** Attempting to reindex with a scope now throws a `Searchkick::DangerousOperation` error to keep your from accidentally recreating your index with only a few records.
-
-  ```ruby
-  Product.where(color: "brandy").reindex # error!
-  ```
+## Elasticsearch 5 to 6 Upgrade
 
-  If this is what you intend to do, use:
+Elasticsearch 6 removes the ability to reindex with the `_all` field. Before you upgrade, we recommend disabling this field manually and specifying default fields on your models.
 
-  ```ruby
-  Product.where(color: "brandy").reindex(accept_danger: true)
-  ```
-
-- Misspellings are enabled by default for [partial matches](#partial-matches). Use `misspellings: false` to disable.
-- [Transpositions](https://en.wikipedia.org/wiki/Damerau%E2%80%93Levenshtein_distance) are enabled by default for misspellings. Use `misspellings: {transpositions: false}` to disable.
-
-### 0.6.0 and 0.7.0
-
-If running Searchkick `0.6.0` or `0.7.0` and Elasticsearch `0.90`, we recommend upgrading to Searchkick `0.6.1` or `0.7.1` to fix an issue that causes downtime when reindexing.
+```ruby
+class Product < ApplicationRecord
+  searchkick _all: false, default_fields: [:name]
+end
+```
 
-### 0.3.0
+If you need search across multiple fields, we recommend creating a similar field in your search data.
 
-Before `0.3.0`, locations were indexed incorrectly. When upgrading, be sure to reindex immediately.
+```ruby
+class Product < ApplicationRecord
+  def search_data
+    {
+      all: [name, size, quantity].join(" ")
+    }
+  end
+end
+```
 
 ## Elasticsearch Gotchas
 
@@ -1936,6 +1859,10 @@ end
 
 For convenience, this is set by default in the test environment.
 
+## History
+
+View the [changelog](https://github.com/ankane/searchkick/blob/master/CHANGELOG.md).
+
 ## Thanks
 
 Thanks to Karel Minarik for [Elasticsearch Ruby](https://github.com/elasticsearch/elasticsearch-ruby) and [Tire](https://github.com/karmi/retire), Jaroslav Kalistsuk for [zero downtime reindexing](https://gist.github.com/jarosan/3124884), and Alex Leschenko for [Elasticsearch autocomplete](https://github.com/leschenko/elasticsearch_autocomplete).