searchkick 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49cbfbcd21df174e93c80f8960ed0771182c0bd6
-  data.tar.gz: 7f02c54a57a145744797000aae4d48c6c3fd5219
+  metadata.gz: a27fb3f9f9fd1773e06eec376ec0677ef60aca65
+  data.tar.gz: 03c0d4c6dabe39b5e9e7beda4f0365e0a3f71472
 SHA512:
-  metadata.gz: 322e05f51de0e35bc8636f92838ae37ac482c518fbe9163e4a1c91b1f60e607e56e1c9e0fc1271ffd83ef082d77c23f316b5dd9494ca12899696fba9cd03e60b
-  data.tar.gz: 387c81af6e19c8faeaa0fe2904d41b13f375ab970bff47b15814b1e874a149dabd0f9a48928773f6bddc94e4c21429f3cf89a1f4be5b3c3a4445702109d476f9
+  metadata.gz: 722dce0a1e9366ed296a9003b435deddc6f6f4c43a90771644bd0f6558d969c348b42279e4c6d04e5ef3cfa188abc75b26a483c6d3d022bd175453135e78f8d6
+  data.tar.gz: e59ff3b1b239b5a9d6d96f3c8482bfece495d936caef69397958292be7069c6e130c6c1bb7aec8b4fb5c0b412914eca4ad9d3af80dca5bf4b9976f9e76496de9

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.0.1
+
+- Added aggregations method to get raw response
+- Use `execute: false` for lazy loading
+- Return nil when no aggs
+- Added emoji search
+
 ## 1.0.0
 
 - Added support for Elasticsearch 2.0

data/Gemfile

@@ -5,3 +5,4 @@ gemspec
 
 gem "sqlite3"
 gem "activerecord", "~> 4.2.0"
+gem "gemoji-parser"

data/README.md

@@ -315,6 +315,22 @@ Or turn off misspellings with:
 Product.search "zuchini", misspellings: false # no zucchini
 ```
 
+### Emoji
+
+Make :ice_cream::cake: match `ice cream cake`!
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'gemoji-parser'
+```
+
+And use:
+
+```ruby
+Product.search "[emoji go here]", emoji: true
+```
+
 ### Indexing
 
 Control what data is indexed with the `search_data` method. Call `Product.reindex` after changing this method.
@@ -644,7 +660,7 @@ Product.search "*", aggs: {price: {ranges: price_ranges}}
 
 ### Facets [deprecated]
 
-Facets have been deprecated in favor of aggregations as of Searchkick 0.9.2. See [how to upgrade](#moving-from-facets).
+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]
@@ -1004,6 +1020,8 @@ And use the `body` option to search:
 products = Product.search body: {match: {name: "milk"}}
 ```
 
+**Note:** This replaces the entire body, so other options are ignored.
+
 View the response with:
 
 ```ruby
@@ -1135,6 +1153,13 @@ Create index without importing
 Product.reindex(import: false)
 ```
 
+Lazy searching
+
+```ruby
+products = Product.search("carrots", execute: false)
+products.each { ... } # search not executed until here
+```
+
 Make fields unsearchable but include in the source
 
 ```ruby

data/lib/searchkick/query.rb

@@ -1,8 +1,12 @@
 module Searchkick
   class Query
+    extend Forwardable
+
     attr_reader :klass, :term, :options
     attr_accessor :body
 
+    def_delegators :execute, :map, :each, :any?, :empty?, :size, :length, :slice, :[], :to_ary
+
     def initialize(klass, term, options = {})
       if term.is_a?(Hash)
         options = term
@@ -11,6 +15,10 @@ module Searchkick
         term = term.to_s
       end
 
+      if options[:emoji]
+        term = EmojiParser.parse_unicode(term) { |e| " #{e.name} " }.strip
+      end
+
       @klass = klass
       @term = term
       @options = options
@@ -480,49 +488,62 @@ module Searchkick
     end
 
     def execute
-      begin
-        response = Searchkick.client.search(params)
-      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"
-        elsif status_code == 500 && (
-            e.message.include?("IllegalArgumentException[minimumSimilarity >= 1]") ||
-            e.message.include?("No query registered for [multi_match]") ||
-            e.message.include?("[match] query does not support [cutoff_frequency]]") ||
-            e.message.include?("No query registered for [function_score]]")
-          )
-
-          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"
+      @execute ||= begin
+        begin
+          response = Searchkick.client.search(params)
+        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"
+          elsif status_code == 500 && (
+              e.message.include?("IllegalArgumentException[minimumSimilarity >= 1]") ||
+              e.message.include?("No query registered for [multi_match]") ||
+              e.message.include?("[match] query does not support [cutoff_frequency]]") ||
+              e.message.include?("No query registered for [function_score]]")
+            )
+
+            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"
+            else
+              raise InvalidQueryError, e.message
+            end
           else
-            raise InvalidQueryError, e.message
+            raise e
           end
-        else
-          raise e
         end
-      end
 
-      # apply facet limit in client due to
-      # https://github.com/elasticsearch/elasticsearch/issues/1305
-      @facet_limits.each do |field, limit|
-        field = field.to_s
-        facet = response["facets"][field]
-        response["facets"][field]["terms"] = facet["terms"].first(limit)
-        response["facets"][field]["other"] = facet["total"] - facet["terms"].sum { |term| term["count"] }
+        # apply facet limit in client due to
+        # https://github.com/elasticsearch/elasticsearch/issues/1305
+        @facet_limits.each do |field, limit|
+          field = field.to_s
+          facet = response["facets"][field]
+          response["facets"][field]["terms"] = facet["terms"].first(limit)
+          response["facets"][field]["other"] = facet["total"] - facet["terms"].sum { |term| term["count"] }
+        end
+
+        opts = {
+          page: @page,
+          per_page: @per_page,
+          padding: @padding,
+          load: @load,
+          includes: options[:include] || options[:includes],
+          json: !options[:json].nil?
+        }
+        Searchkick::Results.new(searchkick_klass, response, opts)
       end
+    end
 
-      opts = {
-        page: @page,
-        per_page: @per_page,
-        padding: @padding,
-        load: @load,
-        includes: options[:include] || options[:includes],
-        json: !options[:json].nil?
-      }
-      Searchkick::Results.new(searchkick_klass, response, opts)
+    def to_curl
+      query = params
+      type = query[:type]
+      index = query[:index].is_a?(Array) ? query[:index].join(",") : query[:index]
+
+      # no easy way to tell which host the client will use
+      host = Searchkick.client.transport.hosts.first
+      credentials = (host[:user] || host[:password]) ? "#{host[:user]}:#{host[:password]}@" : nil
+      "curl #{host[:protocol]}://#{credentials}#{host[:host]}:#{host[:port]}/#{CGI.escape(index)}#{type ? "/#{type.map { |t| CGI.escape(t) }.join(',')}" : ''}/_search?pretty -d '#{query[:body].to_json}'"
     end
 
     private

data/lib/searchkick/results.rb

@@ -75,14 +75,20 @@ module Searchkick
       response["facets"]
     end
 
+    def aggregations
+      response["aggregations"]
+    end
+
     def aggs
       @aggs ||= begin
-        response["aggregations"].dup.each do |field, filtered_agg|
-          buckets = filtered_agg[field]
-          # move the buckets one level above into the field hash
-          if buckets
-            filtered_agg.delete(field)
-            filtered_agg.merge!(buckets)
+        if aggregations
+          aggregations.dup.each do |field, filtered_agg|
+            buckets = filtered_agg[field]
+            # move the buckets one level above into the field hash
+            if buckets
+              filtered_agg.delete(field)
+              filtered_agg.merge!(buckets)
+            end
           end
         end
       end

data/lib/searchkick/version.rb

@@ -1,3 +1,3 @@
 module Searchkick
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/test/aggs_test.rb

@@ -25,6 +25,10 @@ class AggsTest < Minitest::Test
     assert_equal ({1 => 1, 2 => 2}), store_agg({aggs: {store_id_new: {field: "store_id"}}}, "store_id_new")
   end
 
+  def test_no_aggs
+    assert_nil Product.search("*").aggs
+  end
+
   def test_limit
     agg = Product.search("Product", aggs: {store_id: {limit: 1}}).aggs["store_id"]
     assert_equal 1, agg["buckets"].size

data/test/index_test.rb

@@ -107,6 +107,11 @@ class IndexTest < Minitest::Test
       assert_raises(Searchkick::DangerousOperation) { Product.where(id: [1, 2, 3]).reindex }
     end
 
+    def test_dangerous_index_associations
+      Store.create!(name: "Test")
+      assert_raises(Searchkick::DangerousOperation) { Store.first.products.reindex }
+    end
+
     def test_dangerous_reindex_accepted
       store_names ["Product A", "Product B"]
       Product.where(name: "Product A").reindex(accept_danger: true)
@@ -124,7 +129,7 @@ class IndexTest < Minitest::Test
         store_names ["Product A"]
         raise ActiveRecord::Rollback
       end
-      assert_search "product", [], conversions: false
+      assert_search "product", []
     end
   end
 end

data/test/match_test.rb

@@ -197,4 +197,16 @@ class MatchTest < Minitest::Test
     ]
     assert_search "almond", []
   end
+
+  def test_emoji
+    skip unless defined?(EmojiParser)
+    store_names ["Banana"]
+    assert_search "🍌", ["Banana"], emoji: true
+  end
+
+  def test_emoji_multiple
+    skip unless defined?(EmojiParser)
+    store_names ["Ice Cream Cake"]
+    assert_search "🍨🍰", ["Ice Cream Cake"], emoji: true
+  end
 end

data/test/query_test.rb

@@ -7,6 +7,7 @@ class QueryTest < Minitest::Test
     # query.body = {query: {match_all: {}}}
     # query.body = {query: {match: {name: "Apple"}}}
     query.body[:query] = {match_all: {}}
+    assert_equal ["Apple", "Milk"], query.map(&:name).sort
     assert_equal ["Apple", "Milk"], query.execute.map(&:name).sort
   end
 end

data/test/sql_test.rb

@@ -213,12 +213,12 @@ class SqlTest < Minitest::Test
   end
 
   def test_order_ignore_unmapped
-    assert_order "product", [], order: {not_mapped: {ignore_unmapped: true}}, conversions: false
+    assert_order "product", [], order: {not_mapped: {ignore_unmapped: true}}
   end
 
   def test_order_array
     store [{name: "San Francisco", latitude: 37.7833, longitude: -122.4167}]
-    assert_order "francisco", ["San Francisco"], order: [{_geo_distance: {location: "0,0"}}], conversions: false
+    assert_order "francisco", ["San Francisco"], order: [{_geo_distance: {location: "0,0"}}]
   end
 
   def test_partial

data/test/test_helper.rb

@@ -76,6 +76,7 @@ if defined?(Mongoid)
 
   class Store
     include Mongoid::Document
+    has_many :products
 
     field :name
   end
@@ -178,6 +179,7 @@ else
   end
 
   class Store < ActiveRecord::Base
+    has_many :products
   end
 
   class Animal < ActiveRecord::Base
@@ -257,6 +259,7 @@ end
 Product.searchkick_index.delete if Product.searchkick_index.exists?
 Product.reindex
 Product.reindex # run twice for both index paths
+Product.create!(name: "Set mapping")
 
 Store.reindex
 Animal.reindex

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchkick
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-30 00:00:00.000000000 Z
+date: 2015-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel