searchkick 1.5.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fa47681f8cf22fcc751a944326bfbd16f437a55
-  data.tar.gz: 270f29030b412fb937c33c04e00069982c48e3c9
+  metadata.gz: 06b1b68ac3cb57317a8fdd0c94e3988ffed37852
+  data.tar.gz: b5a51c3c2126b88749bd114c0355a9e593f2cdfa
 SHA512:
-  metadata.gz: a721f818961659f9d3337573c52da0414db81040d223830f5ca05d8fda59035f4580de17bab411331ea7939bf98795fe60a8d25bd2fa8375b25370f74cee4551
-  data.tar.gz: 5ba8046de966775866b9015f3506aa4d9d6a6c2e8a83536adc847a31b94754a395fec203530367b95bed518f481bff689e6c52d80f0c34758ca72908d888eee8
+  metadata.gz: b520ec977fec7ac5a65aa6a5aacd9fb4c6142a079385bd63dce20b28ccd59f7cf84993daa4e1f68f8befba383ceb2246ce2a78b38846ec43e7d4432bb9587b40
+  data.tar.gz: b0032add9b2f7ed647ecbc9f2db958f5f240a0725b3990ea24697290e8b61c5e2d6afdf8777742fafaa2fbb33407f0d62f6480239522099869a9bccaf4b9092e

data/.travis.yml

@@ -15,13 +15,6 @@ notifications:
 gemfile:
   - Gemfile
   - test/gemfiles/activerecord42.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
   - test/gemfiles/mongoid6.gemfile
 env:
@@ -29,12 +22,6 @@ env:
 jdk: oraclejdk8
 matrix:
   include:
-    - gemfile: Gemfile
-      env: ELASTICSEARCH_VERSION=1.0.0
-      jdk: oraclejdk7
-    - gemfile: Gemfile
-      env: ELASTICSEARCH_VERSION=1.7.0
-      jdk: oraclejdk7
     - gemfile: Gemfile
       env: ELASTICSEARCH_VERSION=2.0.0
       jdk: oraclejdk7

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 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`
+- 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.5.1
 
 - Added `client_options`

data/README.md

@@ -27,6 +27,8 @@ Plus:
 
 [![Build Status](https://travis-ci.org/ankane/searchkick.svg?branch=master)](https://travis-ci.org/ankane/searchkick)
 
+**Searchkick 2.0 was just released!** See [notable changes](#200).
+
 ## Get Started
 
 [Install Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/setup.html). For Homebrew, use:
@@ -44,6 +46,8 @@ Add this line to your application’s Gemfile:
 gem 'searchkick'
 ```
 
+The latest version works with Elasticsearch 2 and 5. For Elasticsearch 1, use version 1.5.1 and [this readme](https://github.com/ankane/searchkick/blob/v1.5.1/README.md).
+
 Add searchkick to models you want to search.
 
 ```ruby
@@ -115,7 +119,7 @@ limit: 20, offset: 40
 Select
 
 ```ruby
-select_v2: ["name"]
+select: ["name"]
 ```
 
 ### Results
@@ -759,53 +763,6 @@ Product.search "pear", aggs: {products_per_year: {date_histogram: {field: :creat
   aggs: {date_field: {date_ranges: date_ranges}}
   ```
 
-### Facets [deprecated]
-
-Facets have been deprecated in favor of aggregations as of Searchkick 1.0. See [how to upgrade](#moving-from-facets).
-
-```ruby
-products = Product.search "chuck taylor", facets: [:product_type, :gender, :brand]
-p products.facets
-```
-
-By default, `where` conditions are not applied to facets (for backward compatibility).
-
-```ruby
-Product.search "wingtips", where: {color: "brandy"}, facets: [:size]
-# facets *not* filtered by color :(
-```
-
-Change this with:
-
-```ruby
-Product.search "wingtips", where: {color: "brandy"}, facets: [:size], smart_facets: true
-```
-
-or set `where` conditions for each facet separately:
-
-```ruby
-Product.search "wingtips", facets: {size: {where: {color: "brandy"}}}
-```
-
-Limit
-
-```ruby
-Product.search "apples", facets: {store_id: {limit: 10}}
-```
-
-Ranges
-
-```ruby
-price_ranges = [{to: 20}, {from: 20, to: 50}, {from: 50}]
-Product.search "*", facets: {price: {ranges: price_ranges}}
-```
-
-Use the `stats` option to get to max, min, mean, and total scores for each facet
-
-```ruby
-Product.search "*", facets: {store_id: {stats: true}}
-```
-
 ### Highlight
 
 Specify which fields to index with highlighting.
@@ -1001,7 +958,7 @@ Product.search("soap", explain: true).response
 See how Elasticsearch tokenizes your queries with:
 
 ```ruby
-Product.searchkick_index.tokens("Dish Washer Soap", analyzer: "default_index")
+Product.searchkick_index.tokens("Dish Washer Soap", analyzer: "searchkick_index")
 # ["dish", "dishwash", "washer", "washersoap", "soap"]
 
 Product.searchkick_index.tokens("dishwasher soap", analyzer: "searchkick_search")
@@ -1297,11 +1254,6 @@ product.reindex_async
 Reindex more than one record without recreating the index
 
 ```ruby
-# do this ...
-some_company.products.each { |p| p.reindex }
-# or this ...
-Product.searchkick_index.import(some_company.products)
-# don't do the following as it will recreate the index with some_company's products only
 some_company.products.reindex
 ```
 
@@ -1531,6 +1483,21 @@ View the [changelog](https://github.com/ankane/searchkick/blob/master/CHANGELOG.
 
 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`
+- 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

data/lib/searchkick.rb

@@ -7,7 +7,6 @@ require "searchkick/index"
 require "searchkick/indexer"
 require "searchkick/results"
 require "searchkick/query"
-require "searchkick/reindex_job"
 require "searchkick/model"
 require "searchkick/tasks"
 require "searchkick/middleware"
@@ -75,7 +74,7 @@ module Searchkick
     Gem::Version.new(server_version.sub("-", ".")) < Gem::Version.new(version.sub("-", "."))
   end
 
-  def self.search(term = nil, options = {}, &block)
+  def self.search(term = "*", **options, &block)
     query = Searchkick::Query.new(nil, term, options)
     block.call(query.body) if block
     if options[:execute] == false
@@ -92,7 +91,7 @@ module Searchkick
         query.handle_response(responses[i])
       end
     end
-    nil
+    queries
   end
 
   # callbacks

data/lib/searchkick/index.rb

@@ -105,17 +105,15 @@ module Searchkick
       if Searchkick.callbacks_value.nil?
         if defined?(Searchkick::ReindexV2Job)
           Searchkick::ReindexV2Job.perform_later(record.class.name, record.id.to_s)
-        elsif defined?(Delayed::Job)
-          Delayed::Job.enqueue Searchkick::ReindexJob.new(record.class.name, record.id.to_s)
         else
-          raise Searchkick::Error, "Job adapter not found"
+          raise Searchkick::Error, "Active Job not found"
         end
       else
         reindex_record(record)
       end
     end
 
-    def similar_record(record, options = {})
+    def similar_record(record, **options)
       like_text = retrieve(record).to_hash
         .keep_if { |k, _| !options[:fields] || options[:fields].map(&:to_s).include?(k) }
         .values.compact.join(" ")
@@ -133,7 +131,7 @@ module Searchkick
 
     # search
 
-    def search_model(searchkick_klass, term = nil, options = {}, &block)
+    def search_model(searchkick_klass, term = "*", **options, &block)
       query = Searchkick::Query.new(searchkick_klass, term, options)
       yield(query.body) if block
       if options[:execute] == false
@@ -145,21 +143,21 @@ module Searchkick
 
     # reindex
 
-    def create_index(options = {})
-      index_options = options[:index_options] || self.index_options
+    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.create(index_options)
       index
     end
 
-    def all_indices(options = {})
+    def all_indices(unaliased: false)
       indices =
         begin
           client.indices.get_aliases
         rescue Elasticsearch::Transport::Transport::Errors::NotFound
           {}
         end
-      indices = indices.select { |_k, v| v.empty? || v["aliases"].empty? } if options[:unaliased]
+      indices = indices.select { |_k, v| v.empty? || v["aliases"].empty? } if unaliased
       indices.select { |k, _v| k =~ /\A#{Regexp.escape(name)}_\d{14,17}\z/ }.keys
     end
 
@@ -187,10 +185,7 @@ module Searchkick
 
     # https://gist.github.com/jarosan/3124884
     # http://www.elasticsearch.org/blog/changing-mapping-with-zero-downtime/
-    def reindex_scope(scope, options = {})
-      skip_import = options[:import] == false
-      resume = options[:resume]
-
+    def reindex_scope(scope, import: true, resume: false)
       if resume
         index_name = all_indices.sort.last
         raise Searchkick::Error, "No index to resume" unless index_name
@@ -204,7 +199,7 @@ module Searchkick
       # check if alias exists
       if alias_exists?
         # import before swap
-        index.import_scope(scope, resume: resume) unless skip_import
+        index.import_scope(scope, resume: resume) if import
 
         # get existing indices to remove
         swap(index.name)
@@ -214,7 +209,7 @@ module Searchkick
         swap(index.name)
 
         # import after swap
-        index.import_scope(scope, resume: resume) unless skip_import
+        index.import_scope(scope, resume: resume) if import
       end
 
       index.refresh
@@ -222,14 +217,13 @@ module Searchkick
       true
     end
 
-    def import_scope(scope, options = {})
+    def import_scope(scope, resume: false, method_name: nil)
       batch_size = @options[:batch_size] || 1000
-      method_name = options[:method_name]
 
       # use scope for import
       scope = scope.search_import if scope.respond_to?(:search_import)
       if scope.respond_to?(:find_in_batches)
-        if options[:resume]
+        if resume
           # use total docs instead of max id since there's not a great way
           # to get the max _id without scripting since it's a string
 

data/lib/searchkick/index_options.rb

@@ -12,7 +12,7 @@ module Searchkick
         below22 = Searchkick.server_below?("2.2.0")
         below50 = Searchkick.server_below?("5.0.0-alpha1")
         default_type = below50 ? "string" : "text"
-        default_analyzer = below50 ? :default_index : :default
+        default_analyzer = :searchkick_index
         keyword_mapping =
           if below50
             {
@@ -58,11 +58,6 @@ module Searchkick
                 filter: ["standard", "lowercase", "asciifolding", "searchkick_stemmer"]
               },
               # https://github.com/leschenko/elasticsearch_autocomplete/blob/master/lib/elasticsearch_autocomplete/analyzers.rb
-              searchkick_autocomplete_index: {
-                type: "custom",
-                tokenizer: "searchkick_autocomplete_ngram",
-                filter: ["lowercase", "asciifolding"]
-              },
               searchkick_autocomplete_search: {
                 type: "custom",
                 tokenizer: "keyword",
@@ -149,13 +144,6 @@ module Searchkick
                 type: "mapping",
                 mappings: ["&=> and "]
               }
-            },
-            tokenizer: {
-              searchkick_autocomplete_ngram: {
-                type: "edgeNGram",
-                min_gram: 1,
-                max_gram: 50
-              }
             }
           }
         }
@@ -233,7 +221,7 @@ module Searchkick
         end
 
         mapping_options = Hash[
-          [:autocomplete, :suggest, :word, :text_start, :text_middle, :text_end, :word_start, :word_middle, :word_end, :highlight, :searchable, :filterable, :only_analyzed]
+          [:suggest, :word, :text_start, :text_middle, :text_end, :word_start, :word_middle, :word_end, :highlight, :searchable, :filterable]
             .map { |type| [type, (options[type] || []).map(&:to_s)] }
         ]
 
@@ -242,7 +230,7 @@ module Searchkick
         mapping_options.values.flatten.uniq.each do |field|
           fields = {}
 
-          if mapping_options[:only_analyzed].include?(field) || (options.key?(:filterable) && !mapping_options[:filterable].include?(field))
+          if options.key?(:filterable) && !mapping_options[:filterable].include?(field)
             fields[field] = {type: default_type, index: "no"}
           else
             fields[field] = keyword_mapping
@@ -257,7 +245,7 @@ module Searchkick
               end
             end
 
-            mapping_options.except(:highlight, :searchable, :filterable, :only_analyzed, :word).each do |type, f|
+            mapping_options.except(:highlight, :searchable, :filterable, :word).each do |type, f|
               if options[:match] == type || f.include?(field)
                 fields[type] = {type: default_type, index: "analyzed", analyzer: "searchkick_#{type}_index"}
               end
@@ -286,13 +274,6 @@ module Searchkick
           mapping[field] = shape_options.merge(type: "geo_shape")
         end
 
-        (options[:unsearchable] || []).map(&:to_s).each do |field|
-          mapping[field] = {
-            type: default_type,
-            index: "no"
-          }
-        end
-
         routing = {}
         if options[:routing]
           routing = {required: true}
@@ -336,8 +317,7 @@ module Searchkick
             dynamic_fields["{name}"].merge(fields: dynamic_fields.except("{name}"))
           end
 
-        # TODO make dynamic
-        all_enabled = true
+        all_enabled = !options[:searchable] || options[:searchable].to_a.include?("_all")
 
         mappings = {
           _default_: {

data/lib/searchkick/model.rb

@@ -1,8 +1,13 @@
 module Searchkick
-  module Reindex; end # legacy for Searchjoy
-
   module Model
-    def searchkick(options = {})
+    def searchkick(**options)
+      unknown_keywords = options.keys - [:batch_size, :callbacks, :conversions,
+        :filterable, :geo_shape, :highlight, :ignore_above, :index_name, :index_prefix, :language,
+        :locations, :mappings, :match, :merge_mappings, :routing, :searchable, :settings, :similarity,
+        :special_characters, :stem_conversions, :suggest, :synonyms, :text_end,
+        :text_middle, :text_start, :word, :wordnet, :word_end, :word_middle, :word_start]
+      raise ArgumentError, "unknown keywords: #{unknown_keywords.join(", ")}" if unknown_keywords.any?
+
       raise "Only call searchkick once per model" if respond_to?(:searchkick_index)
 
       Searchkick.models << self
@@ -20,7 +25,7 @@ module Searchkick
           [options[:index_prefix], model_name.plural, Searchkick.env].compact.join("_")
 
         class << self
-          def searchkick_search(term = nil, options = {}, &block)
+          def searchkick_search(term = "*", **options, &block)
             searchkick_index.search_model(self, term, options, &block)
           end
           alias_method Searchkick.search_method_name, :searchkick_search if Searchkick.search_method_name
@@ -43,51 +48,32 @@ module Searchkick
             class_variable_get(:@@searchkick_callbacks) && Searchkick.callbacks?
           end
 
-          def searchkick_reindex(method_name = nil, **options)
+          def searchkick_reindex(method_name = nil, full: false, **options)
+            scoped = (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)
+
+            refresh = options.fetch(:refresh, !scoped)
+
             if method_name
+              # update
               searchkick_index.import_scope(searchkick_klass, method_name: method_name)
-              searchkick_index.refresh
-              true
+              searchkick_index.refresh if refresh
+            elsif scoped && !full
+              # reindex association
+              searchkick_index.import_scope(searchkick_klass)
+              searchkick_index.refresh if refresh
             else
-              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
+              # full reindex
               searchkick_index.reindex_scope(searchkick_klass, options)
             end
+            true
           end
           alias_method :reindex, :searchkick_reindex unless method_defined?(:reindex)
 
-          def searchkick_partial_reindex(method_name)
-            searchkick_reindex(method_name)
-          end
-          alias_method :partial_reindex, :searchkick_partial_reindex unless method_defined?(:partial_reindex)
-
-          def clean_indices
-            searchkick_index.clean_indices
-          end
-
-          def searchkick_import(options = {})
-            (options[:index] || searchkick_index).import_scope(searchkick_klass)
-          end
-
-          def searchkick_create_index
-            searchkick_index.create_index
-          end
-
           def searchkick_index_options
             searchkick_index.index_options
           end
-
-          def searchkick_debug
-            warn "Use debug option with search method instead"
-
-            nil # do not return anything, as this is strictly used for manual debugging
-          end
         end
-        extend Searchkick::Reindex # legacy for Searchjoy
 
         callback_name = callbacks == :async ? :reindex_async : :reindex
         if respond_to?(:after_commit)
@@ -97,24 +83,19 @@ module Searchkick
           after_destroy callback_name, if: proc { self.class.search_callbacks? }
         end
 
-        def reindex(method_name = nil, **options)
+        def reindex(method_name = nil, refresh: false)
           if method_name
             self.class.searchkick_index.bulk_update([self], method_name)
           else
             self.class.searchkick_index.reindex_record(self)
           end
-          self.class.searchkick_index.refresh if options[:refresh]
+          self.class.searchkick_index.refresh if refresh
         end unless method_defined?(:reindex)
 
         def reindex_async
           self.class.searchkick_index.reindex_record_async(self)
         end unless method_defined?(:reindex_async)
 
-        def partial_reindex(method_name)
-          reindex(method_name, refresh: true)
-          true
-        end unless method_defined?(:partial_reindex)
-
         def similar(options = {})
           self.class.searchkick_index.similar_record(self, options)
         end unless method_defined?(:similar)