elasticsearch-explain-response 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 781deba8c0a09a57fbf21df20918be1f577bfb7c
-  data.tar.gz: 808cd8bd921f1a514cafd1a47457a0575bce6a74
+  metadata.gz: 8ea1238650fd2756ec6248ac4b08de91c29dd353
+  data.tar.gz: 413adb252c2a14172f19429ab32ec8813c1ec920
 SHA512:
-  metadata.gz: 5af238a2068fa0aa82b168b830726674c44f0447c406220907c785f98752c23b11e68dfd6e4032859cf4bcac0683157dcdd2a8610db79f2c6d0764dd75898c8e
-  data.tar.gz: df4a958713b444e87804f7a7d40a1bb09814e00f562d4a0f14f948bcd0bfe76fc432aa3b2e42a7263f64eb5ff50e5687a0235dcf7071a956c3daf2b628968be2
+  metadata.gz: 720dfd516b2d11b1f74121106a17f159e72018032dc19539651e3d83e829fd1aaf6870f4cd9766aa704672e4ecf6146fed96cd7bc017909b3b37bb41ace3cdb8
+  data.tar.gz: a4f2fcbf13b033977a2bd731700c658fb641baee8e2943807f6439e8ac25708f424ee5c3c62180dfd0bfd5125886cf0cb67b7a9ce9fc88b4a519eacc709d1029

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.0"
+  spec.version       = "0.2.1"
   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

@@ -1,7 +1,10 @@
+require "elasticsearch/api/response/renderable"
+
 module Elasticsearch
   module API
     module Response
       class ExplainNode
+        include Renderable
         extend Forwardable
 
         attr_reader :score, :description, :details, :level

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

@@ -22,8 +22,8 @@ module Elasticsearch
           # Show scoring as a simple math formula
           # @example
           #    "1.0 = (1.0(termFreq=1.0)) x 1.0(idf(2/3)) x 1.0(fieldNorm)"
-          def render_in_line(result, options = {})
-            new(result["explanation"], options).render_in_line
+          def render_in_line(result, options = {}, &block)
+            new(result["explanation"], options).render_in_line(&block)
           end
 
           # Show scoring with indents
@@ -33,8 +33,8 @@ module Elasticsearch
           #       3.35 = 0.2 + 0.93 + 1.29 + 0.93
           #     54.3 = 54.3 min 3.4028234999999995e+38(maxBoost)
           #       54.3 = 2.0 x 10.0 x 3.0 x 0.91
-          def render(result, options = {})
-            new(result["explanation"], options).render
+          def render(result, options = {}, &block)
+            new(result["explanation"], options).render(&block)
           end
 
           def result_as_hash(result, options = {})
@@ -53,16 +53,16 @@ module Elasticsearch
           parse_details
         end
 
-        def render
-          Renderers::StandardRenderer.new({ colorize: true }.merge(rendering_options)).render(@root)
+        def render(&block)
+          @root.render(rendering_options, &block)
         end
 
-        def render_in_line
-          Renderers::InlineRenderer.new({ colorize: true }.merge(rendering_options)).render(@root)
+        def render_in_line(&block)
+          @root.render_in_line(rendering_options, &block)
         end
 
-        def render_as_hash
-          Renderers::HashRenderer.new.render(@root)
+        def render_as_hash(&block)
+          @root.render_as_hash(rendering_options, &block)
         end
 
         private

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

@@ -0,0 +1,22 @@
+module Elasticsearch
+  module API
+    module Response
+      module Renderable
+        def render(rendering_options = {})
+          tree = block_given? ? yield(self) : self
+          Renderers::StandardRenderer.new({ colorize: true }.merge(rendering_options)).render(tree)
+        end
+
+        def render_in_line(rendering_options = {})
+          tree = block_given? ? yield(self) : self
+          Renderers::InlineRenderer.new({ colorize: true }.merge(rendering_options)).render(tree)
+        end
+
+        def render_as_hash(rendering_options = {})
+          tree = block_given? ? yield(self) : self
+          Renderers::HashRenderer.new.render(tree)
+        end
+      end
+    end
+  end
+end

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

@@ -14,6 +14,19 @@ describe Elasticsearch::API::Response::ExplainResponse do
     it "returns summary" do
       expect(subject).not_to be_empty
     end
+
+    context "with block" do
+      subject do
+        described_class.render_in_line(fake_response, colorize: false) do |tree|
+          tree.children = tree.children[0..1]
+          tree
+        end
+      end
+
+      it "changes the tree before rendering" do
+        expect(subject).to eq("0.05 = (0.11(score) x 0.5(coord(1/2)))")
+      end
+    end
   end
 
   describe '.render' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-explain-response
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Tomoya Hirano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-17 00:00:00.000000000 Z
+date: 2015-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,11 +112,11 @@ files:
 - lib/elasticsearch/api/response/description.rb
 - lib/elasticsearch/api/response/explain_node.rb
 - 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/explain_trimmer.rb
 - lib/elasticsearch/api/response/helpers/color_helper.rb
 - lib/elasticsearch/api/response/helpers/string_helper.rb
+- lib/elasticsearch/api/response/renderable.rb
 - lib/elasticsearch/api/response/renderers/base_renderer.rb
 - lib/elasticsearch/api/response/renderers/hash_renderer.rb
 - lib/elasticsearch/api/response/renderers/inline_renderer.rb

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

@@ -1,50 +0,0 @@
-require "elasticsearch/api/response/color_helper"
-
-module Elasticsearch
-  module API
-    module Response
-      class ExplainRenderer
-        include ColorHelper
-
-        def initialize(options = {})
-          disable_colorization if options[:colorize] == false
-          @max = options[:max] || 3
-          @plain_score = options[:plain_score] == true
-          @show_values = options[:show_values] == true
-        end
-
-        def render(tree)
-          @buffer = []
-          recursive_render(tree)
-          @buffer.join("\n")
-        end
-
-        def render_in_line(tree)
-          [render_score(tree.score), "=", recursive_render_details(tree)].flatten.join(" ")
-        end
-
-        def recursive_render(node)
-          return if node.level > @max
-          render_result(node) if node.details.any?
-          node.children.each do |child|
-            recursive_render(child)
-          end
-        end
-
-        private
-
-          def render_result(node)
-            @buffer << " " * node.level * 2 + [render_score(node.score), "=", render_details(node)].flatten.join(" ")
-          end
-
-          def render_details(node)
-            if node.has_children?
-              node.children.map(&method(:render_node)).compact.join(" #{node.operator} ")
-            else
-              render_node(node)
-            end
-          end
-      end
-    end
-  end
-end