searchkick 0.8.3 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b8b951d29bd106ae56b6ca7d2738574430f76ae
-  data.tar.gz: a56ba366f77bfb6f0378e8f5711704bec31ef2cf
+  metadata.gz: c50ef339d04f201523ff1f41aad11277d7168dab
+  data.tar.gz: d7f79bf282327a781e23475f64b7530dfac6beab
 SHA512:
-  metadata.gz: 7f532ecc2e7bb89ad4a705400c89151d7b5ab114efc7c8d4fa9771578de22a3e3ed5361863b6cea9cf56ea9ab6cf4b3379899168af619242844035197c1b294a
-  data.tar.gz: 37c8d654358714fc2a5389190940fdf5f9714b60ded559364ec28ea6a639ed69570f80495e004e2d17c3354e8aada69b7f5e9cf062176f595d4e626024921b1c
+  metadata.gz: 61072c05e3aa82903b699e2062dc0a2944f7fcec20545709d2b83f1f0a760778adffbc7cf7002815c56c2ba6f9484de13f35134c484842ebbf56785d549a6883
+  data.tar.gz: 5c95dd8df5ead5050d2b24175e01b6ad197d7f430f92554f2330cb3b0976360ab4182d956e62ae734ce38b77985eb84f6c0e7e95a0d147d18f061e0964ee61e6

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.8.5
+
+- Added support for Elasticsearch 1.4
+- Added `unsearchable` option
+- Added `select: true` option
+- Added `body` option
+
+## 0.8.4
+
+- Added `boost_by_distance`
+- More flexible highlight options
+- Better `env` logic
+
 ## 0.8.3
 
 - Added support for ActiveJob

data/README.md

@@ -124,7 +124,7 @@ Boost important fields
 fields: ["title^10", "description"]
 ```
 
-Boost by the value of a field
+Boost by the value of a field (field must be numeric)
 
 ```ruby
 boost_by: [:orders_count] # give popular documents a little boost
@@ -553,7 +553,7 @@ Highlight the search query in the results.
 bands = Band.search "cinema", fields: [:name], highlight: true
 ```
 
-**Note:** The `fields` option is required.
+**Note:** The `fields` option is required, unless highlight options are given - see below.
 
 View the highlighted fields with:
 
@@ -569,6 +569,20 @@ To change the tag, use:
 Band.search "cinema", fields: [:name], highlight: {tag: "<strong>"}
 ```
 
+To highlight and search different fields, use:
+
+```ruby
+Band.search "cinema", fields: [:name], highlight: {fields: [:description]}
+```
+
+Additional options, including fragment size, can be specified for each field:
+
+```ruby
+Band.search "cinema", fields: [:name], highlight: {fields: {name: {fragment_size: 200}}}
+```
+
+You can find available highlight options in the [Elasticsearch reference](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-highlighting.html#_highlighted_fragments).
+
 ### Similar Items
 
 Find similar items.
@@ -602,6 +616,20 @@ Bounded by a box
 City.search "san", where: {location: {top_left: [38, -123], bottom_right: [37, -122]}}
 ```
 
+### Boost By Distance
+
+Boost results by distance - closer results are boosted more
+
+```ruby
+City.search "san", boost_by_distance: {field: :location, origin: [37, -122]}
+```
+
+Also supports [additional options](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-function-score-query.html#_decay_functions)
+
+```ruby
+City.search "san", boost_by_distance: {field: :location, origin: [37, -122], function: :linear, scale: "30mi", decay: 0.5}
+```
+
 ## Inheritance
 
 Searchkick supports single table inheritance.
@@ -703,15 +731,20 @@ rake searchkick:reindex CLASS=Product
 
 ### Performance
 
-For the best performance, add [Patron](https://github.com/toland/patron) to your Gemfile.
+For the best performance, add [Typhoeus](https://github.com/typhoeus/typhoeus) to your Gemfile.
 
 ```ruby
-gem 'patron'
+gem 'typhoeus'
 ```
 
-Searchkick will automatically use it.
+And create an initializer with:
+
+```ruby
+require "typhoeus/adapters/faraday"
+Ethon.logger = Logger.new("/dev/null")
+```
 
-**Note:** Patron is not available for Windows.
+**Note:** Typhoeus is not available for Windows.
 
 ### Automatic Failover
 
@@ -723,10 +756,26 @@ Searchkick.client = Elasticsearch::Client.new(hosts: ["localhost:9200", "localho
 
 See [elasticsearch-transport](https://github.com/elasticsearch/elasticsearch-ruby/blob/master/elasticsearch-transport) for a complete list of options.
 
+### Lograge
+
+Add the following to `config/environments/production.rb`:
+
+```ruby
+config.lograge.custom_options = lambda do |event|
+  options = {}
+  options[:search] = event.payload[:searchkick_runtime] if event.payload[:searchkick_runtime].to_f > 0
+  options
+end
+```
+
+See [Production Rails](https://github.com/ankane/production_rails) for other good practices.
+
 ## Advanced
 
 Prefer to use the [Elasticsearch DSL](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-queries.html) but still want awesome features like zero-downtime reindexing?
 
+### Advanced Mapping
+
 Create a custom mapping:
 
 ```ruby
@@ -741,32 +790,35 @@ class Product < ActiveRecord::Base
 end
 ```
 
-And use the `query` option to search:
+To keep the mappings and settings generated by Searchkick, use:
 
 ```ruby
-products = Product.search query: {match: {name: "milk"}}
+class Product < ActiveRecord::Base
+  searchkick merge_mappings: true, mappings: {...}
+end
 ```
 
-View the response with:
+### Advanced Search
+
+And use the `body` option to search:
 
 ```ruby
-products.response
+products = Product.search body: {match: {name: "milk"}}
 ```
 
-To keep the mappings and settings generated by Searchkick, use:
+View the response with:
 
 ```ruby
-class Product < ActiveRecord::Base
-  searchkick merge_mappings: true, mappings: {...}
-end
+products.response
 ```
 
 To modify the query generated by Searchkick, use:
 
 ```ruby
-query = Product.search "2% Milk", execute: false
-query.body[:query] = {match_all: {}}
-products = query.execute
+products =
+  Product.search "2% Milk" do |body|
+    body[:query] = {match_all: {}}
+  end
 ```
 
 ## Reference
@@ -850,6 +902,14 @@ class Product < ActiveRecord::Base
 end
 ```
 
+Make fields unsearchable but include in the source
+
+```ruby
+class Product < ActiveRecord::Base
+  searchkick unsearchable: [:color]
+end
+```
+
 Reindex asynchronously
 
 ```ruby

data/lib/searchkick/model.rb

@@ -5,15 +5,14 @@ module Searchkick
       raise "Only call searchkick once per model" if respond_to?(:searchkick_index)
 
       class_eval do
-        cattr_reader :searchkick_options, :searchkick_env, :searchkick_klass
+        cattr_reader :searchkick_options, :searchkick_klass
 
         callbacks = options.has_key?(:callbacks) ? options[:callbacks] : true
 
         class_variable_set :@@searchkick_options, options.dup
-        class_variable_set :@@searchkick_env, ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
         class_variable_set :@@searchkick_klass, self
         class_variable_set :@@searchkick_callbacks, callbacks
-        class_variable_set :@@searchkick_index, options[:index_name] || [options[:index_prefix], model_name.plural, searchkick_env].compact.join("_")
+        class_variable_set :@@searchkick_index, options[:index_name] || [options[:index_prefix], model_name.plural, Searchkick.env].compact.join("_")
 
         def self.searchkick_index
           index = class_variable_get :@@searchkick_index
@@ -21,8 +20,11 @@ module Searchkick
           Searchkick::Index.new(index)
         end
 
-        define_singleton_method(Searchkick.search_method_name) do |term = nil, options={}|
+        define_singleton_method(Searchkick.search_method_name) do |term = nil, options={}, &block|
           query = Searchkick::Query.new(self, term, options)
+          if block
+            block.call(query.body)
+          end
           if options[:execute] == false
             query
           else

data/lib/searchkick/query.rb

@@ -16,6 +16,7 @@ module Searchkick
       @options = options
 
       below12 = Gem::Version.new(Searchkick.server_version) < Gem::Version.new("1.2")
+      below14 = Gem::Version.new(Searchkick.server_version) < Gem::Version.new("1.4")
 
       boost_fields = {}
       fields =
@@ -56,6 +57,7 @@ module Searchkick
       all = term == "*"
       facet_limits = {}
 
+      options[:json] ||= options[:body]
       if options[:json]
         payload = options[:json]
       else
@@ -209,6 +211,21 @@ module Searchkick
           }
         end
 
+        boost_by_distance = options[:boost_by_distance]
+        if boost_by_distance
+          boost_by_distance = {function: :gauss, scale: "5mi"}.merge(boost_by_distance)
+          if !boost_by_distance[:field] or !boost_by_distance[:origin]
+            raise ArgumentError, "boost_by_distance requires :field and :origin"
+          end
+          function_params = boost_by_distance.select{|k,v| [:origin, :scale, :offset, :decay].include?(k) }
+          function_params[:origin] = function_params[:origin].reverse
+          custom_filters << {
+            boost_by_distance[:function] => {
+              boost_by_distance[:field] => function_params
+            }
+          }
+        end
+
         if custom_filters.any?
           payload = {
             function_score: {
@@ -264,7 +281,7 @@ module Searchkick
               payload[:facets][field] = {
                 terms_stats: {
                   key_field: field,
-                  value_script: "doc.score",
+                  value_script: below14 ? "doc.score" : "_score",
                   size: size
                 }
               }
@@ -320,18 +337,30 @@ module Searchkick
           payload[:highlight] = {
             fields: Hash[ fields.map{|f| [f, {}] } ]
           }
-          if options[:highlight].is_a?(Hash) and tag = options[:highlight][:tag]
-            payload[:highlight][:pre_tags] = [tag]
-            payload[:highlight][:post_tags] = [tag.to_s.gsub(/\A</, "</")]
+
+          if options[:highlight].is_a?(Hash)
+            if tag = options[:highlight][:tag]
+              payload[:highlight][:pre_tags] = [tag]
+              payload[:highlight][:post_tags] = [tag.to_s.gsub(/\A</, "</")]
+            end
+
+            highlight_fields = options[:highlight][:fields]
+            if highlight_fields
+              payload[:highlight][:fields] = {}
+
+              highlight_fields.each do |name, opts|
+                payload[:highlight][:fields]["#{name}.analyzed"] = opts || {}
+              end
+            end
           end
         end
 
         # An empty array will cause only the _id and _type for each hit to be returned
         # http://www.elasticsearch.org/guide/reference/api/search/fields/
-        if load
+        if options[:select]
+          payload[:fields] = options[:select] if options[:select] != true
+        elsif load
           payload[:fields] = []
-        elsif options[:select]
-          payload[:fields] = options[:select]
         end
 
         if options[:type] or klass != searchkick_klass

data/lib/searchkick/reindex.rb

@@ -7,7 +7,7 @@ module Searchkick
       skip_import = options[:import] == false
 
       alias_name = searchkick_index.name
-      new_name = alias_name + "_" + Time.now.strftime("%Y%m%d%H%M%S%L")
+      new_name = "#{alias_name}_#{Time.now.strftime('%Y%m%d%H%M%S%L')}"
       index = Searchkick::Index.new(new_name)
 
       clean_indices
@@ -40,7 +40,7 @@ module Searchkick
     # remove old indices that start w/ index_name
     def clean_indices
       all_indices = Searchkick.client.indices.get_aliases
-      indices = all_indices.select{|k, v| v["aliases"].empty? && k =~ /\A#{Regexp.escape(searchkick_index.name)}_\d{14,17}\z/ }.keys
+      indices = all_indices.select{|k, v| (v.empty? || v["aliases"].empty?) && k =~ /\A#{Regexp.escape(searchkick_index.name)}_\d{14,17}\z/ }.keys
       indices.each do |index|
         Searchkick::Index.new(index).delete
       end
@@ -203,7 +203,7 @@ module Searchkick
           }
         }
 
-        if searchkick_env == "test"
+        if Searchkick.env == "test"
           settings.merge!(number_of_shards: 1, number_of_replicas: 0)
         end
 
@@ -288,12 +288,19 @@ module Searchkick
           mapping[field] = field_mapping
         end
 
-        (options[:locations] || []).each do |field|
+        (options[:locations] || []).map(&:to_s).each do |field|
           mapping[field] = {
             type: "geo_point"
           }
         end
 
+        (options[:unsearchable] || []).map(&:to_s).each do |field|
+          mapping[field] = {
+            type: "string",
+            index: "no"
+          }
+        end
+
         mappings = {
           _default_: {
             properties: mapping,

data/lib/searchkick/results.rb

@@ -26,17 +26,7 @@ module Searchkick
             if options[:includes]
               records = records.includes(options[:includes])
             end
-            results[type] =
-              if records.respond_to?(:primary_key) and records.primary_key
-                # ActiveRecord
-                records.where(records.primary_key => grouped_hits.map{|hit| hit["_id"] }).to_a
-              elsif records.respond_to?(:all) and records.all.respond_to?(:for_ids)
-                # Mongoid 2
-                records.all.for_ids(grouped_hits.map{|hit| hit["_id"] }).to_a
-              else
-                # Mongoid 3+
-                records.queryable.for_ids(grouped_hits.map{|hit| hit["_id"] }).to_a
-              end
+            results[type] = results_query(records, grouped_hits)
           end
 
           # sort
@@ -137,11 +127,25 @@ module Searchkick
       next_page.nil?
     end
 
-    protected
-
     def hits
       @response["hits"]["hits"]
     end
 
+    private
+
+    def results_query(records, grouped_hits)
+      if records.respond_to?(:primary_key) and records.primary_key
+        # ActiveRecord
+        records.where(records.primary_key => grouped_hits.map{|hit| hit["_id"] }).to_a
+      elsif records.respond_to?(:all) and records.all.respond_to?(:for_ids)
+        # Mongoid 2
+        records.all.for_ids(grouped_hits.map{|hit| hit["_id"] }).to_a
+      elsif records.respond_to?(:queryable)
+        # Mongoid 3+
+        records.queryable.for_ids(grouped_hits.map{|hit| hit["_id"] }).to_a
+      else
+        raise "Not sure how to load records"
+      end
+    end
   end
 end

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "0.8.3"
+  VERSION = "0.8.5"
 end

data/lib/searchkick.rb

@@ -63,6 +63,10 @@ module Searchkick
   def self.callbacks?
     callbacks
   end
+
+  def self.env
+    @env ||= ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
+  end
 end
 
 # TODO find better ActiveModel hook

data/test/boost_test.rb

@@ -104,4 +104,13 @@ class TestBoost < Minitest::Test
     assert_first "tomato", "Tomato B", boost_where: {user_ids: {value: 2, factor: 10}}
   end
 
+  def test_boost_by_distance
+    store [
+      {name: "San Francisco", latitude: 37.7833, longitude: -122.4167},
+      {name: "San Antonio", latitude: 29.4167, longitude: -98.5000},
+      {name: "San Marino", latitude: 43.9333, longitude: 12.4667}
+    ]
+    assert_order "san", ["San Francisco", "San Antonio", "San Marino"], boost_by_distance: {field: :location, origin: [37, -122], scale: "1000mi"}
+  end
+
 end

data/test/highlight_test.rb

@@ -19,6 +19,18 @@ class TestHighlight < Minitest::Test
     assert_equal "<em>Cinema</em> Orange", highlight[:color]
   end
 
+  def test_fields
+    store [{name: "Two Door Cinema Club", color: "Cinema Orange"}]
+    highlight = Product.search("cinema", fields: [:name, :color], highlight: {fields: [:name]}).with_details.first[1][:highlight]
+    assert_equal "Two Door <em>Cinema</em> Club", highlight[:name]
+    assert_equal nil, highlight[:color]
+  end
+
+  def test_field_options
+    store_names ["Two Door Cinema Club are a Northern Irish indie rock band"]
+    assert_equal "Two Door <em>Cinema</em> Club are", Product.search("cinema", fields: [:name], highlight: {fields: {name: {fragment_size: 20}}}).with_details.first[1][:highlight][:name]
+  end
+
   def test_multiple_words
     store_names ["Hello World Hello"]
     assert_equal "<em>Hello</em> World <em>Hello</em>", Product.search("hello", fields: [:name], highlight: true).with_details.first[1][:highlight][:name]

data/test/index_test.rb

@@ -41,6 +41,21 @@ class TestIndex < Minitest::Test
     assert_equal ["Dollar Tree"], Store.search(json: {query: {match: {name: "Dollar Tree"}}}, load: false).map(&:name)
   end
 
+  def test_body
+    store_names ["Dollar Tree"], Store
+    assert_equal [], Store.search(query: {match: {name: "dollar"}}).map(&:name)
+    assert_equal ["Dollar Tree"], Store.search(body: {query: {match: {name: "Dollar Tree"}}}, load: false).map(&:name)
+  end
+
+  def test_block
+    store_names ["Dollar Tree"]
+    products =
+      Product.search "boom" do |body|
+        body[:query] = {match_all: {}}
+      end
+    assert_equal ["Dollar Tree"], products.map(&:name)
+  end
+
   def test_tokens
     assert_equal ["dollar", "dollartre", "tree"], Product.searchkick_index.tokens("Dollar Tree")
   end

data/test/match_test.rb

@@ -153,4 +153,11 @@ class TestMatch < Minitest::Test
     assert_search "to be", ["to be or not to be"]
   end
 
+  def test_unsearchable
+    store [
+      {name: "Unsearchable", description: "Almond"}
+    ]
+    assert_search "almond", []
+  end
+
 end

data/test/sql_test.rb

@@ -298,6 +298,13 @@ class TestSql < Minitest::Test
     assert_equal [1, 2], result.user_ids
   end
 
+  def test_select_all
+    store [{name: "Product A", user_ids: [1, 2]}]
+    hit = Product.search("product", select: true).hits.first
+    assert_equal hit["_source"]["name"], "Product A"
+    assert_equal hit["_source"]["user_ids"], [1, 2]
+  end
+
   def test_nested_object
     aisle = {"id" => 1, "name" => "Frozen"}
     store [{name: "Product A", aisle: aisle}]

data/test/test_helper.rb

@@ -53,6 +53,7 @@ if defined?(Mongoid)
     field :color
     field :latitude, type: BigDecimal
     field :longitude, type: BigDecimal
+    field :description
   end
 
   class Store
@@ -95,6 +96,7 @@ else
     t.string :color
     t.decimal :latitude, precision: 10, scale: 7
     t.decimal :longitude, precision: 10, scale: 7
+    t.text :description
     t.timestamps
   end
 
@@ -146,7 +148,8 @@ class Product
     word_start: [:name],
     word_middle: [:name],
     word_end: [:name],
-    highlight: [:name]
+    highlight: [:name],
+    unsearchable: [:description]
 
   attr_accessor :conversions, :user_ids, :aisle
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.5
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-21 00:00:00.000000000 Z
+date: 2014-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -188,4 +188,3 @@ test_files:
 - test/suggest_test.rb
 - test/synonyms_test.rb
 - test/test_helper.rb
-has_rdoc: