searchkick 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01f20120d276745b8434ffaa0529c328f8870080
-  data.tar.gz: 18756878052ac0bd566d025e7f87569992f903aa
+  metadata.gz: 49a9ad19b612e5079b3c97ec4ff756e62b8e2333
+  data.tar.gz: 2e9133f49f0287cabf5bc88fe2fd28e6594ffa27
 SHA512:
-  metadata.gz: 51e077ad2d600a823fea927c02a9c76299423a923286bf483ac9d0caffd32632de2592b9116fb5e34bd7558216e171d8ce8cff78a43bf2900a394830580cbf6c
-  data.tar.gz: 106cca0902d1a59b1de01380b6da09972c626075520e54a29e879740b90ff0ecf42f69d8fe16467308ed8c013526b51295a9e1e848ac1e0cec945aa524b309c0
+  metadata.gz: 4e15ce0859a66945f0675226bb5492d67db7612f23e480d5cec930903db151c2622380d30192e1eace1feb146b455f56b5cb3f55c07129580ac8117da224f42e
+  data.tar.gz: 87c387df771fcf4dcec72b46f779169515acef02bd29ff12565c1c52374fc99a13d54a7d5a38ff0ef57cb7beb58412b0c354abf2beb0860342f2ff545605130a

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.2.0
+
+- Fixed deprecation warnings with `alias_method_chain`
+- Added `analyzed_only` option for large text fields
+- Added `encoder` option to highlight
+- Fixed issue in `similar` method with `per_page` option
+- Added basic support for multiple models
+
 ## 1.1.2
 
 - Added bulk updates with `callbacks` method

data/README.md

@@ -35,6 +35,9 @@ Plus:
 
 ```sh
 brew install elasticsearch
+
+# start the server
+elasticsearch
 ```
 
 Add this line to your application’s Gemfile:
@@ -394,7 +397,7 @@ There are three 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
+  And [install Active Job](https://github.com/ankane/activejob_backport) for Rails 4.1 and below. Jobs are added to a queue named `searchkick`.
 
 3. Manual
 
@@ -1121,6 +1124,14 @@ Remove old indices
 Product.clean_indices
 ```
 
+Use custom settings
+
+```ruby
+class Product < ActiveRecord::Base
+  searchkick settings: {number_of_shards: 3}
+end
+```
+
 Use a different index name
 
 ```ruby
@@ -1235,6 +1246,12 @@ class Product < ActiveRecord::Base
 end
 ```
 
+Search multiple models [master]
+
+```ruby
+Searchkick.search "milk", index_name: [Product, Category]
+```
+
 Reindex all models - Rails only
 
 ```sh

data/lib/searchkick.rb

@@ -128,6 +128,16 @@ module Searchkick
   def self.callbacks_value=(value)
     Thread.current[:searchkick_callbacks_enabled] = value
   end
+
+  def self.search(term = nil, options = {}, &block)
+    query = Searchkick::Query.new(nil, term, options)
+    block.call(query.body) if block
+    if options[:execute] == false
+      query
+    else
+      query.execute
+    end
+  end
 end
 
 # TODO find better ActiveModel hook

data/lib/searchkick/index.rb

@@ -102,7 +102,7 @@ module Searchkick
       options[:where] ||= {}
       options[:where][:_id] ||= {}
       options[:where][:_id][:not] = record.id.to_s
-      options[:limit] ||= 10
+      options[:per_page] ||= 10
       options[:similar] = true
 
       # TODO use index class instead of record class
@@ -132,7 +132,12 @@ module Searchkick
 
     # remove old indices that start w/ index_name
     def clean_indices
-      all_indices = client.indices.get_aliases
+      all_indices =
+        begin
+          client.indices.get_aliases
+        rescue Elasticsearch::Transport::Transport::Errors::NotFound
+          []
+        end
       indices = all_indices.select { |k, v| (v.empty? || v["aliases"].empty?) && k =~ /\A#{Regexp.escape(name)}_\d{14,17}\z/ }.keys
       indices.each do |index|
         Searchkick::Index.new(index).delete
@@ -408,7 +413,7 @@ module Searchkick
         end
 
         mapping_options = Hash[
-          [:autocomplete, :suggest, :word, :text_start, :text_middle, :text_end, :word_start, :word_middle, :word_end, :highlight, :searchable]
+          [:autocomplete, :suggest, :word, :text_start, :text_middle, :text_end, :word_start, :word_middle, :word_end, :highlight, :searchable, :only_analyzed]
             .map { |type| [type, (options[type] || []).map(&:to_s)] }
         ]
 
@@ -417,11 +422,13 @@ module Searchkick
         mapping_options.values.flatten.uniq.each do |field|
           field_mapping = {
             type: "multi_field",
-            fields: {
-              field => {type: "string", index: "not_analyzed"}
-            }
+            fields: {}
           }
 
+          unless mapping_options[:only_analyzed].include?(field)
+            field_mapping[:fields][field] = {type: "string", index: "not_analyzed"}
+          end
+
           if !options[:searchable] || mapping_options[:searchable].include?(field)
             if word
               field_mapping[:fields]["analyzed"] = {type: "string", index: "analyzed"}
@@ -431,7 +438,7 @@ module Searchkick
               end
             end
 
-            mapping_options.except(:highlight, :searchable).each do |type, fields|
+            mapping_options.except(:highlight, :searchable, :only_analyzed).each do |type, fields|
               if options[:match] == type || fields.include?(field)
                 field_mapping[:fields][type] = {type: "string", index: "analyzed", analyzer: "searchkick_#{type}_index"}
               end

data/lib/searchkick/logging.rb

@@ -1,54 +1,51 @@
 # based on https://gist.github.com/mnutt/566725
 
 module Searchkick
-  class Query
-    def execute_search_with_instrumentation
+  module QueryWithInstrumentation
+    def execute_search
       event = {
         name: "#{searchkick_klass.name} Search",
         query: params
       }
       ActiveSupport::Notifications.instrument("search.searchkick", event) do
-        execute_search_without_instrumentation
+        super
       end
     end
-    alias_method_chain :execute_search, :instrumentation
   end
 
-  class Index
-    def store_with_instrumentation(record)
+  module IndexWithInstrumentation
+    def store(record)
       event = {
         name: "#{record.searchkick_klass.name} Store",
         id: search_id(record)
       }
       ActiveSupport::Notifications.instrument("request.searchkick", event) do
-        store_without_instrumentation(record)
+        super(record)
       end
     end
-    alias_method_chain :store, :instrumentation
 
-    def remove_with_instrumentation(record)
+
+    def remove(record)
       event = {
         name: "#{record.searchkick_klass.name} Remove",
         id: search_id(record)
       }
       ActiveSupport::Notifications.instrument("request.searchkick", event) do
-        remove_without_instrumentation(record)
+        super(record)
       end
     end
-    alias_method_chain :remove, :instrumentation
 
-    def import_with_instrumentation(records)
+    def import(records)
       if records.any?
         event = {
           name: "#{records.first.searchkick_klass.name} Import",
           count: records.size
         }
         ActiveSupport::Notifications.instrument("request.searchkick", event) do
-          import_without_instrumentation(records)
+          super(records)
         end
       end
     end
-    alias_method_chain :import, :instrumentation
   end
 
   # https://github.com/rails/rails/blob/master/activerecord/lib/active_record/log_subscriber.rb
@@ -131,7 +128,8 @@ module Searchkick
     end
   end
 end
-
+Searchkick::Query.send(:prepend, Searchkick::QueryWithInstrumentation)
+Searchkick::Index.send(:prepend, Searchkick::IndexWithInstrumentation)
 Searchkick::LogSubscriber.attach_to :searchkick
 ActiveSupport.on_load(:action_controller) do
   include Searchkick::ControllerRuntime

data/lib/searchkick/middleware.rb

@@ -3,8 +3,8 @@ require "faraday/middleware"
 module Searchkick
   class Middleware < Faraday::Middleware
     def call(env)
-      if env.method == :get && env.url.path.to_s.end_with?("/_search")
-        env.request.timeout = Searchkick.search_timeout
+      if env[:method] == :get && env[:url].path.to_s.end_with?("/_search")
+        env[:request][:timeout] = Searchkick.search_timeout
       end
       @app.call(env)
     end

data/lib/searchkick/query.rb

@@ -28,20 +28,29 @@ module Searchkick
     end
 
     def searchkick_index
-      klass.searchkick_index
+      klass ? klass.searchkick_index : nil
     end
 
     def searchkick_options
-      klass.searchkick_options
+      klass ? klass.searchkick_options : {}
     end
 
     def searchkick_klass
-      klass.searchkick_klass
+      klass ? klass.searchkick_klass : nil
     end
 
     def params
+      index =
+        if options[:index_name]
+          Array(options[:index_name]).map { |v| v.respond_to?(:searchkick_index) ? v.searchkick_index.name : v }.join(",")
+        elsif searchkick_index
+          searchkick_index.name
+        else
+          "_all"
+        end
+
       params = {
-        index: options[:index_name] || searchkick_index.name,
+        index: index,
         body: body
       }
       params.merge!(type: @type) if @type
@@ -60,7 +69,7 @@ module Searchkick
         rescue => e # TODO rescue type
           status_code = e.message[1..3].to_i
           if status_code == 404
-            raise MissingIndexError, "Index missing - run #{searchkick_klass.name}.reindex"
+            raise MissingIndexError, "Index missing - run #{reindex_command}"
           elsif status_code == 500 && (
               e.message.include?("IllegalArgumentException[minimumSimilarity >= 1]") ||
               e.message.include?("No query registered for [multi_match]") ||
@@ -71,7 +80,7 @@ module Searchkick
             raise UnsupportedVersionError, "This version of Searchkick requires Elasticsearch 1.0 or greater"
           elsif status_code == 400
             if e.message.include?("[multi_match] analyzer [searchkick_search] not found")
-              raise InvalidQueryError, "Bad mapping - run #{searchkick_klass.name}.reindex"
+              raise InvalidQueryError, "Bad mapping - run #{reindex_command}"
             else
               raise InvalidQueryError, e.message
             end
@@ -116,6 +125,10 @@ module Searchkick
 
     private
 
+    def reindex_command
+      searchkick_klass ? "#{searchkick_klass.name}.reindex" : "reindex"
+    end
+
     def execute_search
       Searchkick.client.search(params)
     end
@@ -536,6 +549,9 @@ module Searchkick
             if (fragment_size = options[:highlight][:fragment_size])
               payload[:highlight][:fragment_size] = fragment_size
             end
+            if (encoder = options[:highlight][:encoder])
+              payload[:highlight][:encoder] = encoder
+            end
 
             highlight_fields = options[:highlight][:fields]
             if highlight_fields
@@ -558,7 +574,7 @@ module Searchkick
           payload[:fields] = []
         end
 
-        if options[:type] || klass != searchkick_klass
+        if options[:type] || (klass != searchkick_klass && searchkick_index)
           @type = [options[:type] || klass].flatten.map { |v| searchkick_index.klass_document_type(v) }
         end
 

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "1.1.2"
+  VERSION = "1.2.0"
 end

data/test/highlight_test.rb

@@ -36,6 +36,11 @@ class HighlightTest < Minitest::Test
     assert_equal "<em>Hello</em> World <em>Hello</em>", Product.search("hello", fields: [:name], highlight: true).with_details.first[1][:highlight][:name]
   end
 
+  def test_encoder
+    store_names ["<b>Hello</b>"]
+    assert_equal "&lt;b&gt;<em>Hello</em>&lt;&#x2F;b&gt;", Product.search("hello", fields: [:name], highlight: {encoder: "html"}, misspellings: false).with_details.first[1][:highlight][:name]
+  end
+
   def test_json
     skip if ENV["MATCH"] == "word_start"
     store_names ["Two Door Cinema Club"]

data/test/index_test.rb

@@ -110,4 +110,11 @@ class IndexTest < Minitest::Test
     end
     assert_search "product", []
   end
+
+  def test_analyzed_only
+    skip if nobrainer?
+    large_value = 10000.times.map { "hello" }.join(" ")
+    store [{name: "Product A", alt_description: large_value}]
+    assert_search "product", ["Product A"]
+  end
 end

data/test/model_test.rb

@@ -33,4 +33,10 @@ class ModelTest < Minitest::Test
 
     assert_search "product", ["product a", "product b"]
   end
+
+  def test_multiple_models
+    store_names ["Product A"]
+    store_names ["Product B"], Store
+    assert_equal Product.all + Store.all, Searchkick.search("product", index_name: [Product, Store], order: "name").to_a
+  end
 end

data/test/similar_test.rb

@@ -15,4 +15,14 @@ class SimilarTest < Minitest::Test
     store_names ["Lucerne Milk Chocolate Fat Free", "Clover Fat Free Milk"]
     assert_order "Lucerne Fat Free Chocolate Milk", ["Lucerne Milk Chocolate Fat Free", "Clover Fat Free Milk"], similar: true
   end
+
+  def test_limit
+    store_names ["1% Organic Milk", "2% Organic Milk", "Fat Free Organic Milk", "Popcorn"]
+    assert_equal ["2% Organic Milk"], Product.where(name: "1% Organic Milk").first.similar(fields: ["name"], order: ["name"], limit: 1).map(&:name)
+  end
+
+  def test_per_page
+    store_names ["1% Organic Milk", "2% Organic Milk", "Fat Free Organic Milk", "Popcorn"]
+    assert_equal ["2% Organic Milk"], Product.where(name: "1% Organic Milk").first.similar(fields: ["name"], order: ["name"], per_page: 1).map(&:name)
+  end
 end

data/test/test_helper.rb

@@ -73,6 +73,7 @@ if defined?(Mongoid)
     field :latitude, type: BigDecimal
     field :longitude, type: BigDecimal
     field :description
+    field :alt_description
   end
 
   class Store
@@ -114,6 +115,7 @@ elsif defined?(NoBrainer)
     field :latitude
     field :longitude
     field :description, type: String
+    field :alt_description, type: String
 
     belongs_to :store, validates: false
   end
@@ -164,6 +166,7 @@ else
     t.decimal :latitude, precision: 10, scale: 7
     t.decimal :longitude, precision: 10, scale: 7
     t.text :description
+    t.text :alt_description
     t.timestamps null: true
   end
 
@@ -219,6 +222,7 @@ class Product
     highlight: [:name],
     # unsearchable: [:description],
     searchable: [:name, :color],
+    only_analyzed: [:alt_description],
     match: ENV["MATCH"] ? ENV["MATCH"].to_sym : nil
 
   attr_accessor :conversions, :user_ids, :aisle

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-18 00:00:00.000000000 Z
+date: 2016-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -219,3 +219,4 @@ test_files:
 - test/synonyms_test.rb
 - test/test_helper.rb
 - test/where_test.rb
+has_rdoc: