elasticsearch-explain-response 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a45d429446a768356511e49f49519a4b59c82bb1
-  data.tar.gz: cae5a22110b309224a5ad2ae74c4f1e8a0616852
+  metadata.gz: 5d639bb65ed9cab1fce5676ce77a1299c520cb23
+  data.tar.gz: 9f08ce5d4454956564f71d944d2b0dba419216c1
 SHA512:
-  metadata.gz: 37cdde1a62667643d3e0d137457e8890251e727ba51865ac8eaf97af61ac203d66cb5c646569557e9f16eb4c784a1dc0a4297340e4327ef605f0f0904f1d927d
-  data.tar.gz: 085fa522790f416383bed3f13c699c8c38f2f640d81a02b8948d0e022f7c2d067e052c301a20b5b72835473fa606790bb55a29c53dc317789fa1862723fd2242
+  metadata.gz: e39644ace8131f609212befdebb14376a1e493b6af6e876fa4a132f465b2a637a7a0380a5f4c2372c33125cc3cdc67fcdfb3b772b45040fda303d4a11570a744
+  data.tar.gz: 69b68ad4f1266afa383d2b6e1e9ec56942790ca6ac0f498309b3405121789a13e43f13d1fe79e694e0dc277ce3586e6bafa3786b09e3e6d0c0b701666c7993ae

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.1.0"
+  spec.version       = "0.1.1"
   spec.authors       = ["Tomoya Hirano"]
   spec.email         = ["hiranotomoya@gmail.com"]
   spec.summary       = %q{Parser for Elasticserach Explain response}
@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~>3.2"
+  spec.add_development_dependency "rspec"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "elasticsearch", "~> 1.0.0"
-  spec.add_development_dependency "ansi", "~> 1.5.0"
+  spec.add_development_dependency "ansi"
 end

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

@@ -12,6 +12,16 @@ module Elasticsearch
           @field = field
           @value = value
         end
+
+        def as_json
+          {
+            type: type,
+            operator: operator,
+            operation: operation,
+            field: field,
+            value: value
+          }.delete_if { |k, v| v.nil? }
+        end
       end
     end
   end

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

@@ -2,9 +2,13 @@ module Elasticsearch
   module API
     module Response
       class ExplainNode
+        extend Forwardable
+
         attr_reader :score, :description, :details, :level
         attr_accessor :children
 
+        def_delegators :@description, :type, :operator, :operation, :field, :value
+
         def initialize(score:, description:, details: [], level: 0)
           @score = score
           @description = description
@@ -13,12 +17,12 @@ module Elasticsearch
           @children = []
         end
 
-        def operator
-          description.operator
+        def score_one?
+          score == 1.0
         end
 
-        def type
-          description.type
+        def min?
+          type == "min"
         end
 
         def func?
@@ -30,7 +34,7 @@ module Elasticsearch
         end
 
         def match_all?
-          type == "match" && description.field == "*" && description.value == "*"
+          type == "match" && field == "*" && value == "*"
         end
 
         def boost?
@@ -40,6 +44,26 @@ module Elasticsearch
         def max_boost?
           type == "maxBoost"
         end
+
+        def func_score?
+          type == "func score"
+        end
+
+        def query_boost?
+          type == "queryBoost"
+        end
+
+        def script?
+          type == "script"
+        end
+
+        def has_children?
+          children.any?
+        end
+
+        def as_json
+          { score: score }.merge(description.as_json)
+        end
       end
     end
   end

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

@@ -77,6 +77,9 @@ module Elasticsearch
             /\Afunction score\, score mode \[multiply\]\z/
             type = "func score"
             operator = "x"
+          when /\Afunction score\, score mode \[sum\]\z/
+            type = "func score"
+            operator = "+"
           when /\Ascript score function\, computed with script:\"(?<s>.+)\"\s*(?:and parameters:\s*(?<p>.+))?/m
             type = "script"
             operation = "script"
@@ -86,6 +89,9 @@ module Elasticsearch
             param.gsub!("\n", '') if param
             field = script.scan(/doc\[\'([\w\.]+)\'\]/).flatten.uniq.compact.join(" ")
             value = [script, param].join(" ")
+          when /\AConstantScore\(.+\), product of\:\z/
+            type = "constant"
+            operation = "constant"
           when "static boost factor", "boostFactor"
             type = "boost"
             operation = "boost"

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

@@ -1,3 +1,4 @@
+require "elasticsearch/api/response/renderers/hash_renderer"
 require "elasticsearch/api/response/explain_node"
 require "elasticsearch/api/response/description"
 require "elasticsearch/api/response/explain_parser"
@@ -53,6 +54,11 @@ module Elasticsearch
           @renderer.render_in_line(@root)
         end
 
+        def render_as_hash
+          parse_details
+          Renderers::HashRenderer.new.render(@root)
+        end
+
         private
 
         def parse_details

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

@@ -0,0 +1,41 @@
+module Elasticsearch
+  module API
+    module Response
+      module Renderers
+        class HashRenderer
+          def initialize
+          end
+
+          def render(tree)
+            recursive_render(tree)
+          end
+
+          def recursive_render(node)
+            format_node(node) if node.details.any?
+          end
+
+          private
+
+          def format_node(node)
+            node.as_json.tap do |hash|
+              if node.has_children?
+                children = format_children(node, hash)
+                hash[:children] = children if children.any?
+              end
+            end
+          end
+
+          def format_children(node, hash)
+            node.children.map(&method(:format_node)).compact.tap do |children|
+              remove_dup(children, hash)
+            end
+          end
+
+          def remove_dup(collection, target)
+            collection.delete_if {|elm| elm == target }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -41,7 +41,7 @@ describe Elasticsearch::API::Response::ExplainResponse do
       end
 
       it "returns summary of explain in line" do
-        expect(subject).to eq("0.05 = ((1.0(idf(2/3)) x 0.43(queryNorm)) x (1.0(tf(1.0)) x 1.0(idf(2/3)) x 0.25(fieldNorm(doc=0))) x 10.0(match(name.raw:smith)) x 0.99(func(updated_at)) x 5.93(script(popularity:\"def val = factor * log(sqrt(doc['popularity'].value) + 1) + 1\" {factor=1.0})) min 3.4e+38) x 0.5(coord(1/2)) x 1.0(queryBoost)")
+        expect(subject).to eq("0.05 = ((1.0(idf(2/3)) x 0.43(queryNorm)) x (1.0(tf(1.0)) x 1.0(idf(2/3)) x 0.25(fieldNorm(doc=0))) x 10.0(match(name.raw:smith)) x 0.99(func(updated_at)) x 5.93(script(popularity:\"def val = factor * log(sqrt(doc['popularity'].value) + 1) + 1\" {factor=1.0})) x 1.0(constant) min 3.4e+38) x 0.5(coord(1/2)) x 1.0(queryBoost)")
       end
 
       context "with fake_response2" do
@@ -61,7 +61,7 @@ describe Elasticsearch::API::Response::ExplainResponse do
       end
 
       it "returns summary of explain in line" do
-        expect(subject).to eq("0.05 = ((1.0(idf(2/3)) x 0.43(queryNorm)) x (1.0(tf(1.0)) x 1.0(idf(2/3)) x 0.25(fieldNorm(doc=0))) x 10.0(match(name.raw)) x 0.99(func(updated_at)) x 5.93(script(popularity)) min 3.4e+38) x 0.5(coord(1/2)) x 1.0(queryBoost)")
+        expect(subject).to eq("0.05 = ((1.0(idf(2/3)) x 0.43(queryNorm)) x (1.0(tf(1.0)) x 1.0(idf(2/3)) x 0.25(fieldNorm(doc=0))) x 10.0(match(name.raw)) x 0.99(func(updated_at)) x 5.93(script(popularity)) x 1.0(constant) min 3.4e+38) x 0.5(coord(1/2)) x 1.0(queryBoost)")
       end
 
       context "with fake_response2" do
@@ -110,7 +110,7 @@ describe Elasticsearch::API::Response::ExplainResponse do
             "  0.11 = 0.11 min 3.4e+38",
             "    0.11 = 0.11(weight(_all:smith))",
             "      0.11 = 0.11(score)",
-            "        0.11 = 0.43(queryWeight) x 0.25(fieldWeight) x 10.0 x 0.99 x 5.93(script(popularity:\"def val = factor * log(sqrt(doc['popularity'].value) + 1) + 1\" {factor=1.0}))",
+            "        0.11 = 0.43(queryWeight) x 0.25(fieldWeight) x 10.0 x 0.99 x 5.93(script(popularity:\"def val = factor * log(sqrt(doc['popularity'].value) + 1) + 1\" {factor=1.0})) x 1.0(constant)",
             "          0.43 = 1.0(idf(2/3)) x 0.43(queryNorm)",
             "          0.25 = 1.0(tf(1.0)) x 1.0(idf(2/3)) x 0.25(fieldNorm(doc=0))",
             "          10.0 = 10.0 x 1.0(match(name.raw:smith))",
@@ -134,6 +134,20 @@ describe Elasticsearch::API::Response::ExplainResponse do
     end
   end
 
+  describe "#render_as_hash" do
+    let(:response) do
+      described_class.new(fake_response["explanation"], colorize: false)
+    end
+
+    subject do
+      response.render_as_hash
+    end
+
+    it "returns the explain response as a hash" do
+      expect(subject).to be_a_kind_of(Hash)
+    end
+  end
+
   describe "colorization" do
     let(:response) do
       described_class.new(fake_response["explanation"])

data/spec/fixtures/response1.yml

@@ -63,6 +63,9 @@ explanation:
             description: "script score function, computed with script:\"def val\
               \ = factor * log(sqrt(doc['popularity'].value)\
               \ + 1) + 1\" and parameters: \n{factor=1.0}"
+          - value: 1.0
+            description: "ConstantScore(BooleanFilter(+BooleanFilter(+QueryWrapperFilter(name.raw:smith\
+                    \ city:smith)) +cache(approved:T))), product of:"
     - value: 3.4028235E+38
       description: "maxBoost"
   - value: 0.5

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-explain-response
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tomoya Hirano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-16 00:00:00.000000000 Z
+date: 2015-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,16 +42,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +84,16 @@ dependencies:
   name: ansi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0'
 description: Parser for Elasticserach Explain response
 email:
 - hiranotomoya@gmail.com
@@ -115,6 +115,7 @@ files:
 - lib/elasticsearch/api/response/explain_parser.rb
 - lib/elasticsearch/api/response/explain_renderer.rb
 - lib/elasticsearch/api/response/explain_response.rb
+- lib/elasticsearch/api/response/renderers/hash_renderer.rb
 - lib/elasticsearch/api/response/string_helper.rb
 - spec/elasticsearch/api/response/explain_response_spec.rb
 - spec/fixtures/response1.yml