search_flip 3.0.0.beta1 → 3.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ed1af68a35f862ad7a429b646afeab420d78161b29e8833daf3a2e37048cb26
-  data.tar.gz: 499dfeffd4abd5b21fc966b6d04b61130fe6bf1ffb771b3d97f92e4473592701
+  metadata.gz: 8594c0c22592c2dfa8fb54097151a87db3746221586b8c28e4c6c3c5c02dff6c
+  data.tar.gz: 55b27e4f8e3bc04c4420280d1dccafbf66e5f7e53cf6914c16f5e5dd3cb5ae10
 SHA512:
-  metadata.gz: 0c1a401732c4ee47aa7e23e750496afa445e274c7fed20f28c27dbf136e2f795123cb805bc9f3513c26be1f2330ed6a0f82da145a4110e8c35858c951d3a8297
-  data.tar.gz: 61ffd4396bb2e3c4372fd5389ffdff0b695dbc80a74c1439855cb7e8fb7f8fe4c6d1aab127d22bc789485427d43f5dad0835c8325c575c295d82a4de5235893d
+  metadata.gz: d54c4c22ba4637573d590288cf1a2407d0ff066e9c4505e3ee851a431ff6ebdc318424ea3af63b2c4d426f74521e27a1800c361feb97dec37c7d1159328dc819
+  data.tar.gz: 1b1bd5e46c5edfc2f1c7d3674564b1bb5627956aee05e16d06e1bdbf1107a70cdd1114bc530cb380db40cc16f383481bafc573c63e1ac3e26b218df97f0d65ed

data/CHANGELOG.md

@@ -20,6 +20,7 @@
 * `Connection#cat_indices/get_indices` now accepts additional parameters
 * `Connection#freeze_index`, `Connection#unfreeze_index`, `Index#freeze_index`
    and `Index#unfreeze_index` added
+* Added `SearchFlip::Result.from_hit`
 
 ## v2.3.1
 

data/lib/search_flip/response.rb

@@ -166,15 +166,7 @@ module SearchFlip
     # @return [Array] An array of results
 
     def results
-      @results ||= hits["hits"].map do |hit|
-        raw_result = hit["_source"]
-
-        raw_result["_hit"] = hit.each_with_object({}) do |(key, value), hash|
-          hash[key] = value if key != "_source"
-        end
-
-        Result.new(raw_result)
-      end
+      @results ||= hits["hits"].map { |hit| Result.from_hit(hit) }
     end
 
     # Returns the named sugggetion, if a name is specified or alle suggestions.

data/lib/search_flip/result.rb

@@ -6,5 +6,24 @@ module SearchFlip
     def self.disable_warnings?(*args)
       true
     end
+
+    # Creates a SearchFlip::Result object from a raw hit. Useful for e.g.
+    # top hits aggregations.
+    #
+    # @example
+    #   query = ProductIndex.aggregate(top_sales: { top_hits: "..." })
+    #   top_sales_hits = query.aggregations(:top_sales).top_hits.hits.hits
+    #
+    #   SearchFlip::Result.from_hit(top_sales_hits.first)
+
+    def self.from_hit(hit)
+      raw_result = hit["_source"].dup
+
+      raw_result["_hit"] = hit.each_with_object({}) do |(key, value), hash|
+        hash[key] = value if key != "_source"
+      end
+
+      new(raw_result)
+    end
   end
 end

data/lib/search_flip/version.rb

@@ -1,3 +1,3 @@
 module SearchFlip
-  VERSION = "3.0.0.beta1"
+  VERSION = "3.0.0.beta2"
 end

data/spec/search_flip/result_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path("../spec_helper", __dir__)
+
+RSpec.describe SearchFlip::Result do
+  describe ".from_hit" do
+    it "adds a _hit key into _source and merges the hit keys into it" do
+      result = SearchFlip::Result.from_hit("_score" => 1.0, "_source" => { "name" => "Some name" })
+
+      expect(result).to eq("name" => "Some name", "_hit" => { "_score" => 1.0 })
+    end
+
+    it "allows deep method access" do
+      result = SearchFlip::Result.from_hit("_source" => { "key1" => [{ "key2" => "value" }] })
+
+      expect(result.key1[0].key2).to eq("value")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: search_flip
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta1
+  version: 3.0.0.beta2
 platform: ruby
 authors:
 - Benjamin Vetter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-13 00:00:00.000000000 Z
+date: 2020-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -224,6 +224,7 @@ files:
 - spec/search_flip/index_spec.rb
 - spec/search_flip/model_spec.rb
 - spec/search_flip/response_spec.rb
+- spec/search_flip/result_spec.rb
 - spec/search_flip/to_json_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/mrkamel/search_flip
@@ -248,8 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Full-Featured Elasticsearch Ruby Client with a Chainable DSL
@@ -263,5 +263,6 @@ test_files:
 - spec/search_flip/index_spec.rb
 - spec/search_flip/model_spec.rb
 - spec/search_flip/response_spec.rb
+- spec/search_flip/result_spec.rb
 - spec/search_flip/to_json_spec.rb
 - spec/spec_helper.rb