elasticsearch-explain-response 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d639bb65ed9cab1fce5676ce77a1299c520cb23
-  data.tar.gz: 9f08ce5d4454956564f71d944d2b0dba419216c1
+  metadata.gz: 781deba8c0a09a57fbf21df20918be1f577bfb7c
+  data.tar.gz: 808cd8bd921f1a514cafd1a47457a0575bce6a74
 SHA512:
-  metadata.gz: e39644ace8131f609212befdebb14376a1e493b6af6e876fa4a132f465b2a637a7a0380a5f4c2372c33125cc3cdc67fcdfb3b772b45040fda303d4a11570a744
-  data.tar.gz: 69b68ad4f1266afa383d2b6e1e9ec56942790ca6ac0f498309b3405121789a13e43f13d1fe79e694e0dc277ce3586e6bafa3786b09e3e6d0c0b701666c7993ae
+  metadata.gz: 5af238a2068fa0aa82b168b830726674c44f0447c406220907c785f98752c23b11e68dfd6e4032859cf4bcac0683157dcdd2a8610db79f2c6d0764dd75898c8e
+  data.tar.gz: df4a958713b444e87804f7a7d40a1bb09814e00f562d4a0f14f948bcd0bfe76fc432aa3b2e42a7263f64eb5ff50e5687a0235dcf7071a956c3daf2b628968be2

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.1"
+  spec.version       = "0.2.0"
   spec.authors       = ["Tomoya Hirano"]
   spec.email         = ["hiranotomoya@gmail.com"]
   spec.summary       = %q{Parser for Elasticserach Explain response}

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

@@ -1,10 +1,10 @@
-require "elasticsearch/api/response/string_helper"
+require "elasticsearch/api/response/helpers/string_helper"
 
 module Elasticsearch
   module API
     module Response
       class ExplainParser
-        include StringHelper
+        include Helpers::StringHelper
 
         def parse(explain_tree)
           root = create_node(explain_tree, level: 0)
@@ -14,116 +14,116 @@ module Elasticsearch
 
         private
 
-        def create_node(detail, level:)
-          ExplainNode.new(
-            score: detail["value"] || 0.0,
-            description: parse_description(detail["description"]),
-            details: detail["details"] || [],
-            level: level
-          )
-        end
-
-        def parse_details(node)
-          node.details.each do |detail|
-            child = create_node(detail, level: node.level.succ)
-            node.children << child
-            parse_details(child)
+          def create_node(detail, level:)
+            ExplainNode.new(
+              score: detail["value"] || 0.0,
+              description: parse_description(detail["description"]),
+              details: detail["details"] || [],
+              level: level
+            )
           end
-        end
 
-        def parse_description(description)
-          case description
-          when /\Aweight\((\w+)\:(\w+)\s+in\s+\d+\)\s+\[\w+\]\, result of\:\z/
-            type = "weight"
-            operation = "weight"
-            operator = "x"
-            field = $1
-            value = $2
-          when /\Aidf\(docFreq\=(\d+)\, maxDocs\=(\d+)\)\z/
-            type = "idf"
-            operation = "idf(#{$1}/#{$2})"
-          when /\Atf\(freq\=([\d.]+)\)\, with freq of\:\z/
-            type = "tf"
-            operation = "tf(#{$1})"
-          when /\Ascore\(doc\=\d+\,freq=[\d\.]+\)\, product of\:\z/
-            type =  "score"
-            operation = "score"
-            operator = "x"
-          when /\Amatch filter\: (?:cache\()?(?:(?<op>[\w]+)\()*(?<c>.+)\)*\z/
-            type = "match"
-            operation = "match"
-            operation += ".#{$~[:op]}" if $~[:op] && !%w[QueryWrapperFilter].include?($~[:op])
-            content = $~[:c]
-            content = content[0..-2] if content.end_with?(')')
-            hash = tokenize_contents(content)
-            field = hash.keys.join(", ")
-            value = hash.values.join(", ")
-          when /\AFunction for field ([\w\_]+)\:\z/
-            type = "func"
-            operation = "func"
-            field = $1
-          when /\AqueryWeight\, product of\:\z/
-            type = "queryWeight"
-            operation = "queryWeight"
-            operator = "x"
-          when /\AfieldWeight in \d+\, product of\:\z/
-            type = "fieldWeight"
-            operation = "fieldWeight"
-            operator = "x"
-          when /\AqueryNorm/
-            type = "queryNorm"
-            operation = "queryNorm"
-          when /\Afunction score\, product of\:\z/,
-            /\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"
-            script, param = $~[:s], $~[:p]
-            script = script.gsub("\n", '')
-            script = "\"#{script}\""
-            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"
-          when "product of:", "[multiply]"
-            type = "product"
-            operation = "product"
-            operator = "x"
-          when "Math.min of"
-            type = "min"
-            operator = "min"
-          when "Math.max of"
-            type = "max"
-            operator = "max"
-          when "sum of:"
-            type = "sum"
-            operator = "+"
-          when "maxBoost"
-            type = "maxBoost"
-          else
-            type = description
-            operation = description
+          def parse_details(node)
+            node.details.each do |detail|
+              child = create_node(detail, level: node.level.succ)
+              node.children << child
+              parse_details(child)
+            end
           end
 
-          Description.new(
-            raw: description,
-            type: type,
-            operator: operator,
-            operation: operation,
-            field: field,
-            value: value,
-          )
-        end
+          def parse_description(description)
+            case description
+            when /\Aweight\((\w+)\:(\w+)\s+in\s+\d+\)\s+\[\w+\]\, result of\:\z/
+              type = "weight"
+              operation = "weight"
+              operator = "x"
+              field = $1
+              value = $2
+            when /\Aidf\(docFreq\=(\d+)\, maxDocs\=(\d+)\)\z/
+              type = "idf"
+              operation = "idf(#{$1}/#{$2})"
+            when /\Atf\(freq\=([\d.]+)\)\, with freq of\:\z/
+              type = "tf"
+              operation = "tf(#{$1})"
+            when /\Ascore\(doc\=\d+\,freq=[\d\.]+\)\, product of\:\z/
+              type =  "score"
+              operation = "score"
+              operator = "x"
+            when /\Amatch filter\: (?:cache\()?(?:(?<op>[\w]+)\()*(?<c>.+)\)*\z/
+              type = "match"
+              operation = "match"
+              operation += ".#{$~[:op]}" if $~[:op] && !%w[QueryWrapperFilter].include?($~[:op])
+              content = $~[:c]
+              content = content[0..-2] if content.end_with?(')')
+              hash = tokenize_contents(content)
+              field = hash.keys.join(", ")
+              value = hash.values.join(", ")
+            when /\AFunction for field ([\w\_]+)\:\z/
+              type = "func"
+              operation = "func"
+              field = $1
+            when /\AqueryWeight\, product of\:\z/
+              type = "queryWeight"
+              operation = "queryWeight"
+              operator = "x"
+            when /\AfieldWeight in \d+\, product of\:\z/
+              type = "fieldWeight"
+              operation = "fieldWeight"
+              operator = "x"
+            when /\AqueryNorm/
+              type = "queryNorm"
+              operation = "queryNorm"
+            when /\Afunction score\, product of\:\z/,
+              /\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"
+              script, param = $~[:s], $~[:p]
+              script = script.gsub("\n", '')
+              script = "\"#{script}\""
+              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"
+            when /product\sof\:?/, "[multiply]"
+              type = "product"
+              operation = "product"
+              operator = "x"
+            when "Math.min of"
+              type = "min"
+              operator = "min"
+            when "Math.max of"
+              type = "max"
+              operator = "max"
+            when /sum of\:?/
+              type = "sum"
+              operator = "+"
+            when "maxBoost"
+              type = "maxBoost"
+            else
+              type = description
+              operation = description
+            end
+
+            Description.new(
+              raw: description,
+              type: type,
+              operator: operator,
+              operation: operation,
+              field: field,
+              value: value,
+            )
+          end
       end
     end
   end

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

@@ -33,108 +33,17 @@ module Elasticsearch
 
         private
 
-        def render_result(node)
-          @buffer << " " * node.level * 2 + [render_score(node.score), "=", render_details(node)].flatten.join(" ")
-        end
-
-        def render_score(score)
-          value = if !@plain_score && score > 1_000
-            sprintf("%1.2g", score.round(2))
-          else
-            score.round(2).to_s
-          end
-          ansi(value, :magenta, :bright)
-        end
-
-        def render_details(node)
-          case node.type
-          when "func score"
-            render_boost_match_details(node)
-          else
-            render_node_details(node)
-          end
-        end
-
-        def render_node_details(node)
-          node.children.map do |child|
-            check_node = block_given? ? yield(child) : true
-            check_node && render_node(child) || nil
-          end.compact.join(" #{node.operator} ")
-        end
-
-        def render_boost_match_details(node)
-          match = node.children.find {|c| c.type == "match" }
-          boost = node.children.find {|c| c.type == "boost" }
-          if match && boost
-            [boost.score, render_node(match)].join(" x ")
-          else
-            render_node_details(node) {|n| !n.match_all? }
+          def render_result(node)
+            @buffer << " " * node.level * 2 + [render_score(node.score), "=", render_details(node)].flatten.join(" ")
           end
-        end
 
-        def recursive_render_details(node)
-          details = node.children.map do |child|
-            if child.children.any? && child.level <= @max
-              if child.func?
-                render_node(child)
-              elsif child.children[0].match? && child.children[1].boost?
-                match = child.children[0]
-                boost = child.children[1]
-                "#{render_score(boost.score)}(#{render_description(match.description)})"
-              else
-                recursive_render_details(child)
-              end
+          def render_details(node)
+            if node.has_children?
+              node.children.map(&method(:render_node)).compact.join(" #{node.operator} ")
             else
-              if !child.match_all?
-                render_node(child)
-              end
+              render_node(node)
             end
-          end.compact
-
-          if details.size > 1
-            wrap_paren(details.join(" #{node.operator} "))
-          else
-            details[0]
           end
-        end
-
-        def render_node(node)
-          text = render_score(node.score)
-          desc = render_description(node.description)
-          text = "#{text}(#{desc})" unless desc.empty?
-          text
-        end
-
-        def render_description(description)
-          text = ''
-          text = description.operation if description.operation
-          if description.field && description.value
-            if @show_values
-              text += "(#{field(description.field)}:#{value(description.value)})"
-            else
-              text += "(#{field(description.field)})"
-            end
-          elsif description.field
-            text += "(#{field(description.field)})"
-          end
-          text
-        end
-
-        def field(str)
-          ansi(str, :blue ,:bright)
-        end
-
-        def value(str)
-          ansi(str, :green)
-        end
-
-        def wrap_paren(string)
-          if string.start_with?("(") && string.end_with?(")")
-            string
-          else
-            "(" + string + ")"
-          end
-        end
       end
     end
   end

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

@@ -1,8 +1,10 @@
-require "elasticsearch/api/response/renderers/hash_renderer"
 require "elasticsearch/api/response/explain_node"
 require "elasticsearch/api/response/description"
 require "elasticsearch/api/response/explain_parser"
-require "elasticsearch/api/response/explain_renderer"
+require "elasticsearch/api/response/explain_trimmer"
+require "elasticsearch/api/response/renderers/standard_renderer"
+require "elasticsearch/api/response/renderers/inline_renderer"
+require "elasticsearch/api/response/renderers/hash_renderer"
 
 module Elasticsearch
   module API
@@ -34,35 +36,43 @@ module Elasticsearch
           def render(result, options = {})
             new(result["explanation"], options).render
           end
+
+          def result_as_hash(result, options = {})
+            new(result["explanation"], options).render_as_hash
+          end
         end
 
-        attr_reader :explain
+        attr_reader :explain, :trim, :rendering_options
 
         def initialize(explain, options = {})
           @explain = explain
           @indent = 0
-          @renderer = ExplainRenderer.new({ colorize: true }.merge(options))
+          @trim = options.has_key?(:trim) ? options.delete(:trim) : true
+          @rendering_options = options
+
+          parse_details
         end
 
         def render
-          parse_details
-          @renderer.render(@root)
+          Renderers::StandardRenderer.new({ colorize: true }.merge(rendering_options)).render(@root)
         end
 
         def render_in_line
-          parse_details
-          @renderer.render_in_line(@root)
+          Renderers::InlineRenderer.new({ colorize: true }.merge(rendering_options)).render(@root)
         end
 
         def render_as_hash
-          parse_details
           Renderers::HashRenderer.new.render(@root)
         end
 
         private
 
         def parse_details
-          @root ||= ExplainParser.new.parse(explain)
+          @root ||= begin
+            tree = ExplainParser.new.parse(explain)
+            tree = ExplainTrimmer.new.trim(tree) if trim
+            tree
+          end
         end
       end
     end

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

@@ -0,0 +1,76 @@
+module Elasticsearch
+  module API
+    module Response
+      class ExplainTrimmer
+        def initialize
+        end
+
+        def trim(tree)
+          recursive_trim(tree)
+        end
+
+        def recursive_trim(node)
+          trim_node(node) if node.details.any?
+        end
+
+        private
+
+          def trim_node(node)
+            case
+            when node.func_score?
+              trim_func_score_node(node)
+            when node.min?
+              trim_min_score_node(node)
+            else
+              trim_default_node(node)
+            end
+          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)
+                end
+              end
+            end
+
+            trim_default_node(node)
+          end
+
+          def trim_default_node(node)
+            if node.has_children?
+              node.children = node.children.map(&method(:trim_node)).compact
+            end
+            node
+          end
+
+          # @note show only the node with a minimum score
+          def trim_min_score_node(node)
+            child = node.children.find {|n| n.score == node.score }
+            trim_node(child)
+          end
+
+          def merge_function_score_node(current, entity)
+            ExplainNode.new(
+              score: current.score,
+              level: current.level,
+              details: current.details,
+              description: Description.new(
+                raw: current.description.raw,
+                type: entity.type,
+                operator: entity.operator,
+                operation: entity.operation,
+                field: entity.field,
+                value: entity.value
+              )
+            )
+          end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/response/helpers/color_helper.rb

@@ -0,0 +1,37 @@
+module Elasticsearch
+  module API
+    module Response
+      module Helpers
+        module ColorHelper
+          def colorized?
+            unless @ansi_loaded
+              @colorized = load_ansi
+            else
+              !!@colorized
+            end
+          end
+
+          def disable_colorization
+            @ansi_loaded = true
+            @colorized = false
+          end
+
+          def load_ansi
+            require "ansi/core"
+            true
+          rescue LoadError
+            false
+          end
+
+          def ansi(str, *codes)
+            if colorized?
+              str.to_s.ansi(*codes)
+            else
+              str.to_s
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/api/response/helpers/string_helper.rb

@@ -0,0 +1,23 @@
+module Elasticsearch
+  module API
+    module Response
+      module Helpers
+        module StringHelper
+          WORD = /[\w\.\*]+/
+          WITH_QUOTE = /"[^"]*"/
+          WITH_BRACKET = /\[[^\]]*\]/
+          QUOTE_TOKENIZER = /(?:(?<field>#{WORD})(\:(?<value>(#{WORD}|#{WITH_QUOTE}|#{WITH_BRACKET})))?)+/
+
+          # @return [Hash] field name as a key and values as a value
+          def tokenize_contents(string)
+            string
+              .scan(QUOTE_TOKENIZER)
+              .each_with_object(Hash.new{|h,k| h[k] = []}) { |(field, value), memo|
+                memo[field] << value
+              }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+require "elasticsearch/api/response/helpers/color_helper"
+
+module Elasticsearch
+  module API
+    module Response
+      module Renderers
+        class BaseRenderer
+          include Helpers::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
+
+          private
+
+            def render_score(score)
+              value = if !@plain_score && score > 1_000
+                sprintf("%1.2g", score.round(2))
+              else
+                score.round(2).to_s
+              end
+              ansi(value, :magenta, :bright)
+            end
+
+            def render_node(node)
+              text = render_score(node.score)
+              desc = render_description(node.description)
+              text = "#{text}(#{desc})" unless desc.empty?
+              text
+            end
+
+            def render_description(description)
+              text = ''
+              text = description.operation if description.operation
+              if description.field && description.value
+                if @show_values
+                  text += "(#{field(description.field)}:#{value(description.value)})"
+                else
+                  text += "(#{field(description.field)})"
+                end
+              elsif description.field
+                text += "(#{field(description.field)})"
+              end
+              text
+            end
+
+            def field(str)
+              ansi(str, :blue ,:bright)
+            end
+
+            def value(str)
+              ansi(str, :green)
+            end
+
+            def wrap_paren(string)
+              if string.start_with?("(") && string.end_with?(")")
+                string
+              else
+                "(" + string + ")"
+              end
+            end
+        end
+      end
+    end
+  end
+end

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

@@ -3,8 +3,6 @@ module Elasticsearch
     module Response
       module Renderers
         class HashRenderer
-          def initialize
-          end
 
           def render(tree)
             recursive_render(tree)
@@ -16,24 +14,24 @@ module Elasticsearch
 
           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?
+            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
-          end
 
-          def format_children(node, hash)
-            node.children.map(&method(:format_node)).compact.tap do |children|
-              remove_dup(children, hash)
+            def format_children(node, hash)
+              node.children.map(&method(:format_node)).compact.tap do |children|
+                remove_dup(children, hash)
+              end
             end
-          end
 
-          def remove_dup(collection, target)
-            collection.delete_if {|elm| elm == target }
-          end
+            def remove_dup(collection, target)
+              collection.delete_if {|elm| elm == target }
+            end
         end
       end
     end

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

@@ -0,0 +1,36 @@
+require "elasticsearch/api/response/renderers/base_renderer"
+
+module Elasticsearch
+  module API
+    module Response
+      module Renderers
+        class InlineRenderer < BaseRenderer
+
+          def render(tree)
+            [render_score(tree.score), "=", recursive_render_details(tree)].flatten.join(" ")
+          end
+
+          private
+
+            def recursive_render_details(node)
+              details = node.children.map do |child|
+                if child.children.any? && child.level <= @max
+                  recursive_render_details(child)
+                else
+                  if !child.match_all?
+                    render_node(child)
+                  end
+                end
+              end.compact
+
+              if details.size > 1
+                wrap_paren(details.join(" #{node.operator} "))
+              else
+                details[0]
+              end
+            end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+require "elasticsearch/api/response/renderers/base_renderer"
+
+module Elasticsearch
+  module API
+    module Response
+      module Renderers
+
+        class StandardRenderer < BaseRenderer
+
+          def render(tree)
+            @buffer = []
+            recursive_render(tree)
+            @buffer.join("\n")
+          end
+
+          private
+
+            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
+
+            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
+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})) x 1.0(constant) 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) x 0.5(coord(1/2)) x 1.0(queryBoost)")
       end
 
       context "with fake_response2" do
@@ -50,7 +50,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]))) min 3.4e+38) 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]))) x 1.0(queryBoost)")
         end
       end
     end
@@ -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)) x 1.0(constant) 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) x 0.5(coord(1/2)) x 1.0(queryBoost)")
       end
 
       context "with fake_response2" do
@@ -70,7 +70,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))) min 3.4e+38) 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))) x 1.0(queryBoost)")
         end
       end
     end
@@ -95,7 +95,6 @@ describe Elasticsearch::API::Response::ExplainResponse do
       it "returns summary of explain in lines" do
         expect(subject).to match_array [
           "0.05 = 0.11 x 0.5(coord(1/2)) x 1.0(queryBoost)",
-          "  0.11 = 0.11 min 3.4e+38",
           "    0.11 = 0.11(weight(_all:smith))",
           "      0.11 = 0.11(score)"
         ]
@@ -107,13 +106,12 @@ describe Elasticsearch::API::Response::ExplainResponse do
         it "returns summary of explain in lines" do
           expect(subject).to match_array([
             "0.05 = 0.11 x 0.5(coord(1/2)) x 1.0(queryBoost)",
-            "  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})) x 1.0(constant)",
+            "        0.11 = 0.43(queryWeight) x 0.25(fieldWeight) 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)",
             "          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))",
+            "          10.0 = 10.0(match(name.raw:smith))",
             "          0.99 = 0.99(func(updated_at))"
           ])
         end
@@ -125,7 +123,6 @@ describe Elasticsearch::API::Response::ExplainResponse do
         it "returns summary of explain in lines" do
           expect(subject).to match_array([
             "0.05 = 0.11 x 0.5(coord(1/2)) x 1.0(queryBoost)",
-            "  0.11 = 0.11 min 3.4028235e+38",
             "    0.11 = 0.11(weight(_all:smith))",
             "      0.11 = 0.11(score)"
           ])

data/spec/fixtures/response2.yml

@@ -33,7 +33,7 @@ explanation:
           details:
           - value: 10.0
             description: "boostFactor"
-      - value: 1.0
+      - value: 0.7
         description: "function score, product of:"
         details:
         - value: 1.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elasticsearch-explain-response
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Tomoya Hirano
@@ -109,14 +109,18 @@ files:
 - circle.yml
 - elasticsearch-explain-response.gemspec
 - lib/elasticsearch-explain-response.rb
-- lib/elasticsearch/api/response/color_helper.rb
 - 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/renderers/base_renderer.rb
 - lib/elasticsearch/api/response/renderers/hash_renderer.rb
-- lib/elasticsearch/api/response/string_helper.rb
+- 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/fixtures/response1.yml
 - spec/fixtures/response2.yml

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

@@ -1,35 +0,0 @@
-module Elasticsearch
-  module API
-    module Response
-      module ColorHelper
-        def colorized?
-          unless @ansi_loaded
-            @colorized = load_ansi
-          else
-            !!@colorized
-          end
-        end
-
-        def disable_colorization
-          @ansi_loaded = true
-          @colorized = false
-        end
-
-        def load_ansi
-          require "ansi/core"
-          true
-        rescue LoadError
-          false
-        end
-
-        def ansi(str, *codes)
-          if colorized?
-            str.to_s.ansi(*codes)
-          else
-            str.to_s
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-module Elasticsearch
-  module API
-    module Response
-      module StringHelper
-        WORD = /[\w\.\*]+/
-        WITH_QUOTE = /"[^"]*"/
-        WITH_BRACKET = /\[[^\]]*\]/
-        QUOTE_TOKENIZER = /(?:(?<field>#{WORD})(\:(?<value>(#{WORD}|#{WITH_QUOTE}|#{WITH_BRACKET})))?)+/
-
-        # @return [Hash] field name as a key and values as a value
-        def tokenize_contents(string)
-          string
-            .scan(QUOTE_TOKENIZER)
-            .each_with_object(Hash.new{|h,k| h[k] = []}) { |(field, value), memo|
-              memo[field] << value
-            }
-        end
-      end
-    end
-  end
-end