searchkick 0.9.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0227952cfe570c64d03eacd4db89689ec4a0b2d5
-  data.tar.gz: 14d2061a47667de91432894f8ef220b1a73bec3c
+  metadata.gz: 49cbfbcd21df174e93c80f8960ed0771182c0bd6
+  data.tar.gz: 7f02c54a57a145744797000aae4d48c6c3fd5219
 SHA512:
-  metadata.gz: d9e12c3156a856a53d7b5157f40b167dce9ff05949f5312f34100222b6769801ab602baba3ca10aec2e80db21e2ae0410229120d865f0682a7167827b4bb7b82
-  data.tar.gz: cbfbbaca6c443d5f319a97342d1969f85d94749b5662f86b3da557d310a9bd6ed02fc1d7af54e8f2ca0be703bf35c8bb49164bf4d13195e348c221708e8e9793
+  metadata.gz: 322e05f51de0e35bc8636f92838ae37ac482c518fbe9163e4a1c91b1f60e607e56e1c9e0fc1271ffd83ef082d77c23f316b5dd9494ca12899696fba9cd03e60b
+  data.tar.gz: 387c81af6e19c8faeaa0fe2904d41b13f375ab970bff47b15814b1e874a149dabd0f9a48928773f6bddc94e4c21429f3cf89a1f4be5b3c3a4445702109d476f9

data/.travis.yml

@@ -4,7 +4,7 @@ services:
   - elasticsearch
   - mongodb
 before_install:
-  - ./ci/before_install.sh
+  - ./test/ci/before_install.sh
 script: bundle exec rake test
 before_script:
   - psql -c 'create database searchkick_test;' -U postgres
@@ -14,14 +14,15 @@ notifications:
     on_failure: change
 gemfile:
   - Gemfile
-  - gemfiles/activerecord41.gemfile
-  - gemfiles/activerecord40.gemfile
-  - gemfiles/activerecord32.gemfile
-  - gemfiles/activerecord31.gemfile
-  - gemfiles/mongoid2.gemfile
-  - gemfiles/mongoid3.gemfile
-  - gemfiles/mongoid4.gemfile
+  - test/gemfiles/activerecord41.gemfile
+  - test/gemfiles/activerecord40.gemfile
+  - test/gemfiles/activerecord32.gemfile
+  - test/gemfiles/activerecord31.gemfile
+  - test/gemfiles/mongoid2.gemfile
+  - test/gemfiles/mongoid3.gemfile
+  - test/gemfiles/mongoid4.gemfile
+  - test/gemfiles/mongoid5.gemfile
 matrix:
   include:
-    - gemfile: gemfiles/nobrainer.gemfile
+    - gemfile: test/gemfiles/nobrainer.gemfile
       env: NOBRAINER=true

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 1.0.0
+
+- Added support for Elasticsearch 2.0
+- Added support for aggregations
+- Added ability to use misspellings for partial matches
+- Added `fragment_size` option for highlight
+- Added `took` method to results
+
+Breaking changes
+
+- Raise `Searchkick::DangerousOperation` error when calling reindex with scope
+- Enabled misspellings by default for partial matches
+- Enabled transpositions by default for misspellings
+
 ## 0.9.1
 
 - `and` now matches `&`

data/README.md

@@ -21,6 +21,8 @@ Plus:
 - “Did you mean” suggestions
 - works with ActiveRecord, Mongoid, and NoBrainer
 
+**Searchkick 1.0 was just released!** See [instructions for upgrading](#100)
+
 :speech_balloon: Get [handcrafted updates](http://chartkick.us7.list-manage.com/subscribe?u=952c861f99eb43084e0a49f98&id=6ea6541e8e&group[0][4]=true) for new features
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
@@ -45,7 +47,7 @@ Add this line to your application’s Gemfile:
 gem 'searchkick'
 ```
 
-For Elasticsearch 0.90, use version `0.6.3` and [this readme](https://github.com/ankane/searchkick/blob/v0.6.3/README.md).
+For Elasticsearch 2.0, use the version `1.0` and above. For Elasticsearch 0.90, use version `0.6.3` and [this readme](https://github.com/ankane/searchkick/blob/v0.6.3/README.md).
 
 Add searchkick to models you want to search.
 
@@ -117,6 +119,35 @@ Limit / offset
 limit: 20, offset: 40
 ```
 
+### Results
+
+Searches return a `Searchkick::Results` object. This responds like an array to most methods.
+
+```ruby
+results = Product.search("milk")
+results.size
+results.any?
+results.each { ... }
+```
+
+Get total results
+
+```ruby
+results.total_count
+```
+
+Get the time the search took (in milliseconds)
+
+```ruby
+results.took
+```
+
+Get the full response from Elasticsearch
+
+```ruby
+results.response
+```
+
 ### Boosting
 
 Boost important fields
@@ -229,17 +260,19 @@ Searchkick defaults to English for stemming.  To change this, use:
 
 ```ruby
 class Product < ActiveRecord::Base
-  searchkick language: "German"
+  searchkick stemmer: "german"
 end
 ```
 
-[See the list of languages](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/analysis-snowball-tokenfilter.html)
+[See the list of stemmers](https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-stemmer-tokenfilter.html)
 
 ### Synonyms
 
 ```ruby
 class Product < ActiveRecord::Base
   searchkick synonyms: [["scallion", "green onion"], ["qtip", "cotton swab"]]
+  # or
+  # searchkick synonyms: -> { CSV.read("/some/path/synonyms.csv") }
 end
 ```
 
@@ -282,14 +315,6 @@ Or turn off misspellings with:
 Product.search "zuchini", misspellings: false # no zucchini
 ```
 
-Swapping two letters counts as two edits. To count the [transposition of two adjacent characters as a single edit](https://en.wikipedia.org/wiki/Damerau%E2%80%93Levenshtein_distance), use:
-
-```ruby
-Product.search "mikl", misspellings: {transpositions: true} # milk
-```
-
-This is planned to be the default in Searchkick 1.0.
-
 ### Indexing
 
 Control what data is indexed with the `search_data` method. Call `Product.reindex` after changing this method.
@@ -516,11 +541,110 @@ products = Product.search "peantu butta", suggest: true
 products.suggestions # ["peanut butter"]
 ```
 
-### Facets
+### Aggregations
+
+[Aggregations](http://www.elasticsearch.org/guide/reference/api/search/facets/) provide aggregated search data.
+
+![Aggregations](http://ankane.github.io/searchkick/facets.png)
+
+```ruby
+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]
+# aggregations for brandy wingtips are returned
+```
+
+Change this with:
+
+```ruby
+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"}}}
+```
+
+Limit
+
+```ruby
+Product.search "apples", aggs: {store_id: {limit: 10}}
+```
+
+Ranges
+
+```ruby
+price_ranges = [{to: 20}, {from: 20, to: 50}, {from: 50}]
+Product.search "*", aggs: {price: {ranges: price_ranges}}
+```
+
+#### Moving From Facets
+
+1. Replace `facets` with `aggs` in searches. **Note:** Stats facets are not supported at this time.
 
-[Facets](http://www.elasticsearch.org/guide/reference/api/search/facets/) provide aggregated search data.
+  ```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.
 
-![Facets](http://ankane.github.io/searchkick/facets.png)
+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}}
+  ```
+
+### Facets [deprecated]
+
+Facets have been deprecated in favor of aggregations as of Searchkick 0.9.2. See [how to upgrade](#moving-from-facets).
 
 ```ruby
 products = Product.search "chuck taylor", facets: [:product_type, :gender, :brand]
@@ -662,6 +786,8 @@ City.search "san", boost_by_distance: {field: :location, origin: [37, -122], fun
 
 Searchkick supports [Elasticsearch’s routing feature](https://www.elastic.co/blog/customizing-your-document-routing).
 
+**Note:** Routing is not yet supported for Elasticsearch 2.0.
+
 ```ruby
 class Contact < ActiveRecord::Base
   searchkick routing: :user_id
@@ -706,6 +832,12 @@ Dog.search "airbudd", suggest: true # suggestions for all animals
 
 ## Debugging Queries
 
+See how Elasticsearch scores your queries with:
+
+```ruby
+Product.search("soap", explain: true).response
+```
+
 See how Elasticsearch tokenizes your queries with:
 
 ```ruby
@@ -759,6 +891,28 @@ Then deploy and reindex:
 heroku run rake searchkick:reindex CLASS=Product
 ```
 
+### Amazon Elasticsearch Service
+
+You must use an [IP-based access policy](http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-gsg-search.html) for Searchkick to work.
+
+Include `elasticsearch 1.0.14` or greater in your Gemfile.
+
+```ruby
+gem "elasticsearch", ">= 1.0.14"
+```
+
+Create an initializer `config/initializers/elasticsearch.rb` with:
+
+```ruby
+ENV["ELASTICSEARCH_URL"] = "http://es-domain-1234.us-east-1.es.amazonaws.com"
+```
+
+Then deploy and reindex:
+
+```sh
+rake searchkick:reindex CLASS=Product
+```
+
 ### Other
 
 Create an initializer `config/initializers/elasticsearch.rb` with:
@@ -1085,6 +1239,28 @@ View the [changelog](https://github.com/ankane/searchkick/blob/master/CHANGELOG.
 
 Important notes are listed below.
 
+### 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!
+  ```
+
+  If this is what you intend to do, use:
+
+  ```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.

data/lib/searchkick.rb

@@ -22,6 +22,7 @@ module Searchkick
   class MissingIndexError < StandardError; end
   class UnsupportedVersionError < StandardError; end
   class InvalidQueryError < Elasticsearch::Transport::Transport::Errors::BadRequest; end
+  class DangerousOperation < StandardError; end
 
   class << self
     attr_accessor :search_method_name

data/lib/searchkick/index.rb

@@ -100,7 +100,7 @@ module Searchkick
 
     def similar_record(record, options = {})
       like_text = retrieve(record).to_hash
-        .keep_if { |k, v| !options[:fields] || options[:fields].map(&:to_s).include?(k) }
+        .keep_if { |k, _| !options[:fields] || options[:fields].map(&:to_s).include?(k) }
         .values.compact.join(" ")
 
       # TODO deep merge method
@@ -118,9 +118,7 @@ module Searchkick
 
     def search_model(searchkick_klass, term = nil, options = {}, &block)
       query = Searchkick::Query.new(searchkick_klass, term, options)
-      if block
-        block.call(query.body)
-      end
+      block.call(query.body) if block
       if options[:execute] == false
         query
       else
@@ -349,6 +347,9 @@ module Searchkick
 
         # synonyms
         synonyms = options[:synonyms] || []
+
+        synonyms = synonyms.call if synonyms.respond_to?(:call)
+
         if synonyms.any?
           settings[:analysis][:filter][:searchkick_synonym] = {
             type: "synonym",
@@ -379,7 +380,7 @@ module Searchkick
         end
 
         if options[:special_characters] == false
-          settings[:analysis][:analyzer].each do |analyzer, analyzer_settings|
+          settings[:analysis][:analyzer].each do |_, analyzer_settings|
             analyzer_settings[:filter].reject! { |f| f == "asciifolding" }
           end
         end
@@ -387,8 +388,8 @@ module Searchkick
         mapping = {}
 
         # conversions
-        if options[:conversions]
-          mapping[:conversions] = {
+        if (conversions_field = options[:conversions])
+          mapping[conversions_field] = {
             type: "nested",
             properties: {
               query: {type: "string", analyzer: "searchkick_keyword"},
@@ -561,6 +562,5 @@ module Searchkick
         obj
       end
     end
-
   end
 end

data/lib/searchkick/logging.rb

@@ -62,7 +62,8 @@ module Searchkick
     end
 
     def self.reset_runtime
-      rt, self.runtime = runtime, 0
+      rt = runtime
+      self.runtime = 0
       rt
     end
 
@@ -122,7 +123,8 @@ module Searchkick
 
     module ClassMethods
       def log_process_action(payload)
-        messages, runtime = super, payload[:searchkick_runtime]
+        messages = super
+        runtime = payload[:searchkick_runtime]
         messages << ("Searchkick: %.1fms" % runtime.to_f) if runtime.to_f > 0
         messages
       end

data/lib/searchkick/model.rb

@@ -2,7 +2,6 @@ module Searchkick
   module Reindex; end # legacy for Searchjoy
 
   module Model
-
     def searchkick(options = {})
       raise "Only call searchkick once per model" if respond_to?(:searchkick_index)
 
@@ -18,12 +17,11 @@ module Searchkick
         class_variable_set :@@searchkick_callbacks, callbacks
         class_variable_set :@@searchkick_index, options[:index_name] || [options[:index_prefix], model_name.plural, Searchkick.env].compact.join("_")
 
-        define_singleton_method(Searchkick.search_method_name) do |term = nil, options = {}, &block|
-          searchkick_index.search_model(self, term, options, &block)
-        end
-        extend Searchkick::Reindex # legacy for Searchjoy
-
         class << self
+          def searchkick_search(term = nil, options = {}, &block)
+            searchkick_index.search_model(self, term, options, &block)
+          end
+          alias_method Searchkick.search_method_name, :searchkick_search
 
           def searchkick_index
             index = class_variable_get :@@searchkick_index
@@ -43,9 +41,16 @@ module Searchkick
             class_variable_get(:@@searchkick_callbacks) && Searchkick.callbacks?
           end
 
-          def reindex(options = {})
+          def searchkick_reindex(options = {})
+            unless options[:accept_danger]
+              if (respond_to?(:current_scope) && respond_to?(:default_scoped) && current_scope && current_scope.to_sql != default_scoped.to_sql) ||
+                (respond_to?(:queryable) && queryable != unscoped.with_default_scope)
+                raise Searchkick::DangerousOperation, "Only call reindex on models, not relations. Pass `accept_danger: true` if this is your intention."
+              end
+            end
             searchkick_index.reindex_scope(searchkick_klass, options)
           end
+          alias_method :reindex, :searchkick_reindex unless method_defined?(:reindex)
 
           def clean_indices
             searchkick_index.clean_indices
@@ -62,8 +67,8 @@ module Searchkick
           def searchkick_index_options
             searchkick_index.index_options
           end
-
         end
+        extend Searchkick::Reindex # legacy for Searchjoy
 
         if callbacks
           callback_name = callbacks == :async ? :reindex_async : :reindex
@@ -94,9 +99,7 @@ module Searchkick
         def should_index?
           true
         end unless method_defined?(:should_index?)
-
       end
     end
-
   end
 end