elasticsearch-explain-response 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df103068b5f7a7ecbb4aedc891170f4694de2306
-  data.tar.gz: a12e87ba1be8f777d975797f0e7a48719696f555
+  metadata.gz: 207cf81ab8713811ce0491a545acd8a0784212b2
+  data.tar.gz: c940afb7c7e8a8e3345bd7b8b5dfa3de9eae1159
 SHA512:
-  metadata.gz: 02147c8d3dfbcf889dc90daac3c2820e343dcf53421a095f2ff46e2eecc1b1040fb420f6d7b0df7b9643621c0c0d32569073d511766d27df6910224183daf143
-  data.tar.gz: c77fb47e745a90012425c93c03abb1014926705c85ae954f4aa0bb8eb1b32517d991e68fa8c318175e550589647b21b3c746f1ac8f6ac37eaace8e9752425c7c
+  metadata.gz: 2d1f222854366f2583042dd7321b9384ef5d271845e8e802ba5eabba91d63327dbeac5bcc319b42729567b83ccf77cb325bd8415ffc5fe4193478a6ee3c0a3b5
+  data.tar.gz: 536938ce0c1df8bc814e7dae4814a218619cb00c884a0834ca52b0574c9ec5b2634d625c5ed4ed644e2ab19279210e81703e72017acd7af656d41559332f9986

data/elasticsearch-explain-response.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "elasticsearch-explain-response"
-  spec.version       = "0.2.3"
+  spec.version       = "0.2.4"
   spec.authors       = ["Tomoya Hirano"]
   spec.email         = ["hiranotomoya@gmail.com"]
   spec.summary       = %q{Parser for Elasticserach Explain response}

data/lib/elasticsearch/api/response/explain_node.rb

@@ -35,6 +35,10 @@ module Elasticsearch
           score == 1.0
         end
 
+        def score?
+          type == "score"
+        end
+
         def min?
           type == "min"
         end
@@ -43,6 +47,14 @@ module Elasticsearch
           type == "func"
         end
 
+        def product?
+          type == "product"
+        end
+
+        def constant?
+          type == "constant"
+        end
+
         def match?
           type == "match"
         end

data/lib/elasticsearch/api/response/explain_parser.rb

@@ -92,6 +92,9 @@ module Elasticsearch
             when /\AConstantScore\(.+\), product of\:\z/
               type = "constant"
               operation = "constant"
+            when /\Aconstant score/
+              type = "constant"
+              operation = "constant"
             when "static boost factor", "boostFactor"
               type = "boost"
               operation = "boost"
@@ -110,6 +113,9 @@ module Elasticsearch
               operator = "+"
             when "maxBoost"
               type = "maxBoost"
+            when /_score\:\s*/
+              type = "score"
+              operation = "score"
             else
               type = description
               operation = description

data/lib/elasticsearch/api/response/explain_trimmer.rb

@@ -13,6 +13,12 @@ module Elasticsearch
 
           def trim_node(node)
             case
+            when node.product?
+              trim_product_node(node)
+            when node.score?
+              trim_score_node(node)
+            when node.func?, node.boost?
+              trim_children_node(node)
             when node.func_score?
               trim_func_score_node(node)
             when node.min?
@@ -22,15 +28,51 @@ module Elasticsearch
             end
           end
 
+          def trim_score_node(node)
+            case node.children.size
+            when 1
+              return trim_node(node.children.first)
+            else
+              trim_default_node(node)
+            end
+          end
+
+          def trim_children_node(node)
+            case node.children.size
+            when 1
+              node.children = []
+              trim_node(node)
+            else
+              trim_default_node(node)
+            end
+          end
+
+          def trim_product_node(node)
+            case node.children.size
+            when 2
+              constant = node.children.find { |n| n.constant? }
+              if constant
+                other = (node.children - [constant])[0]
+                if constant.score_one? && other.score == node.score
+                  return trim_node(other)
+                end
+              end
+            end
+
+            trim_default_node(node)
+          end
+
           def trim_func_score_node(node)
             case node.children.size
             when 2
-              match = node.children.find(&:match?)
-              if match
-                other = (node.children - [match])[0]
-                if match.score_one? && other.score == node.score
-                  entity = match.field == "*" ? other : match
-                  return merge_function_score_node(node, entity)
+              boost = node.children.find { |n| n.match? || n.query_boost? }
+              if boost
+                other = (node.children - [boost])[0]
+                if boost.score_one? && other.score == node.score
+                  other = trim_node(other) if other.has_children?
+                  new_node = merge_function_score_node(node, boost, other)
+                  new_node.children = other.children
+                  return trim_node(new_node)
                 end
               end
             end
@@ -51,7 +93,9 @@ module Elasticsearch
             trim_node(child)
           end
 
-          def merge_function_score_node(current, entity)
+          def merge_function_score_node(current, boost, target)
+            entity = boost.field == "*" || boost.field.nil? ? target : boost
+
             ExplainNode.new(
               score: current.score,
               level: current.level,

data/lib/elasticsearch/api/response/renderers/inline_renderer.rb

@@ -13,7 +13,7 @@ module Elasticsearch
           private
 
             def recursive_render_details(node)
-              details = node.children.map do |child|
+              details = node.children.map { |child|
                 if child.children.any? && child.level <= @max
                   recursive_render_details(child)
                 else
@@ -21,7 +21,7 @@ module Elasticsearch
                     render_node(child)
                   end
                 end
-              end.compact
+              }.compact
 
               if details.size > 1
                 wrap_paren(details.join(" #{node.operator} "))

data/spec/elasticsearch/api/response/explain_response_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require "pry"
 
 describe Elasticsearch::API::Response::ExplainResponse do
   let(:fake_response) do
@@ -66,7 +65,7 @@ describe Elasticsearch::API::Response::ExplainResponse do
         end
 
         it "returns summary of explain in line" do
-          expect(subject).to eq("887.19 = (10.0(match(name:hawaii)) x 10.0(match(name:guam)) x 0.7(match(name:\"new caledonia\", new, nueva, caledonia)) x 3.0(match(with_beach:T)) x 0.99(func(updated_at)) x 3.0(match(region_id:[3 TO 3]))) x 1.0(queryBoost)")
+          expect(subject).to eq("887.19 = (10.0(match(name:hawaii)) x 10.0(match(name:guam)) x 0.7(match(name:\"new caledonia\", new, nueva, caledonia)) x 3.0(match(with_beach:T)) x 0.99(func(updated_at)) x 3.0(match(region_id:[3 TO 3])))")
         end
       end
     end
@@ -86,7 +85,7 @@ describe Elasticsearch::API::Response::ExplainResponse do
         end
 
         it "returns summary of explain in line" do
-          expect(subject).to eq("887.19 = (10.0(match(name)) x 10.0(match(name)) x 0.7(match(name)) x 3.0(match(with_beach)) x 0.99(func(updated_at)) x 3.0(match(region_id))) x 1.0(queryBoost)")
+          expect(subject).to eq("887.19 = (10.0(match(name)) x 10.0(match(name)) x 0.7(match(name)) x 3.0(match(with_beach)) x 0.99(func(updated_at)) x 3.0(match(region_id)))")
         end
       end
     end

data/spec/elasticsearch/api/response/explain_trimmer_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+describe Elasticsearch::API::Response::ExplainTrimmer do
+  describe "#trim" do
+    context "with function score node" do
+      let(:json) do
+        {"value"=>100.0,
+        "description"=>"function score, product of:",
+        "details"=>
+         [{"value"=>1.0,
+           "description"=> "match filter: QueryWrapperFilter(title:paris)"},
+          {"value"=>100.0,
+           "description"=>"product of:",
+           "details"=>[
+             {"value"=>1.0, "description"=>"constant score 1.0 - no function provided"},
+             {"value"=>100.0, "description"=>"weight"}
+            ]}
+          ]
+         }
+      end
+
+      it "trims function score node" do
+        tree = Elasticsearch::API::Response::ExplainParser.new.parse(json)
+        result = Elasticsearch::API::Response::ExplainTrimmer.new.trim(tree)
+        expect(result.render_as_hash).to eq(
+          score: 100.0,
+          type: "match",
+          operation: "match",
+          field: "title",
+          value: "paris"
+        )
+      end
+    end
+
+    context "with boost node" do
+      let(:json) do
+        { "value" => 10,
+          "description"=>"function score, product of:",
+          "details"=> [
+            { "value"=>1, "description"=>"match filter: QueryWrapperFilter(name.raw:smith)"},
+            { "value"=>10, "description"=>"static boost factor",
+              "details"=>[
+                {"value"=>10, "description"=>"boostFactor"}
+              ]
+            }
+          ]
+        }
+      end
+
+      it "trims boost node" do
+        tree = Elasticsearch::API::Response::ExplainParser.new.parse(json)
+        result = Elasticsearch::API::Response::ExplainTrimmer.new.trim(tree)
+        expect(result.render_as_hash).to eq(
+          score: 10,
+          type: "match",
+          operation: "match",
+          field: "name.raw",
+          value: "smith"
+        )
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require "elasticsearch-explain-response"
+require "pry"
 
 Dir[ File.expand_path('../support/**/*.rb', __FILE__) ].each { |f| require f }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-explain-response
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Tomoya Hirano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-18 00:00:00.000000000 Z
+date: 2016-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,7 @@ files:
 - lib/elasticsearch/api/response/renderers/inline_renderer.rb
 - lib/elasticsearch/api/response/renderers/standard_renderer.rb
 - spec/elasticsearch/api/response/explain_response_spec.rb
+- spec/elasticsearch/api/response/explain_trimmer_spec.rb
 - spec/fixtures/response1.yml
 - spec/fixtures/response2.yml
 - spec/spec_helper.rb
@@ -152,7 +153,9 @@ specification_version: 4
 summary: Parser for Elasticserach Explain response
 test_files:
 - spec/elasticsearch/api/response/explain_response_spec.rb
+- spec/elasticsearch/api/response/explain_trimmer_spec.rb
 - spec/fixtures/response1.yml
 - spec/fixtures/response2.yml
 - spec/spec_helper.rb
 - spec/support/fixture_helper.rb
+has_rdoc: