log_magic 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 733121449aea416c67e1d0e5ab5d22c131465637
-  data.tar.gz: a9f0223530f33b7c4e978105de1287f9c8603250
+  metadata.gz: 86b235416d827dc6a190d2098a617b72cbafb3bf
+  data.tar.gz: b3ff933f789f7bb66a8331181b75589fd4452d3c
 SHA512:
-  metadata.gz: ed64f68737ca9ca07819d6848ab8bd056ee79add352fbbf3915f5e74e21607f24f5be99535109542275b542e2388d039968a4ad3bbd8f516676f551e8c4a43eb
-  data.tar.gz: cbd911866995b70530d3d39bc43bb150fd95441798e0bc5c24edcdc46787f4dc754edd8d7335ff399c9991b4e5e08a1aa1ad40157793faa8e1a3adb276e1e39f
+  metadata.gz: 2ff908f15c4906c78f1b2436e62f4e2dbe24b26436c6acf6e514f95fc856bccc7cfc922730fdda0c269627210b44484a2f7ce75540a6fd306a1c2ab4184bdc47
+  data.tar.gz: 3ec53d4f8b0e60c98900a96f3608dc0a2e6f8fad2b95d50e2da4a0261361532452455611462eb230f0f276717f6542d9fccdb400259947afad2fe30ffba021b1

data/lib/log_magic/explainer_templates/boost.haml

@@ -1,4 +1,2 @@
-%h2
-  This query contains a
-  %a{href: 'https://www.elastic.co/guide/en/elasticsearch/guide/current/_boosting_query_clauses.html'}
-    Boost Query Clause
+%a{href: 'https://www.elastic.co/guide/en/elasticsearch/guide/current/_boosting_query_clauses.html'}
+  'boost'

data/lib/log_magic/explainer_templates/dis_max.haml

@@ -1,4 +1,2 @@
-%h2
-  This query contains a
-  %a{href: 'https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-dis-max-query.html'}
-    Dis Max Query
+%a{href: 'https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-dis-max-query.html'}
+  'dis_max'

data/lib/log_magic/explainer_templates/match.haml

@@ -1,4 +1,2 @@
-%h2
-  This query contains a
-  %a{href: 'https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html'}
-    Match query
+%a{href: 'https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html'}
+  'match'

data/lib/log_magic/explainer_templates/query.haml

@@ -0,0 +1,2 @@
+%p
+  = query_json

data/lib/log_magic/explainer_templates/searchkick.haml

@@ -1,8 +1,5 @@
-- explainer_sections.each do |explainer_section|
-  = explainer_section.explanation
-
-= settings_explainer_section.explanation
-
 %h2 Query
 %p
-  = pretty_print_json(query_json)
+  = explained_query.explanation
+
+= settings_explainer_section.explanation

data/lib/log_magic/explainers/explainer_sections/boost_explainer.rb

@@ -5,12 +5,8 @@ class LogMagic::SearchkickExplainer::BoostExplainerSection
     @query_json = query_json
   end
 
-  def matches?
-    @query_json =~ /[^\w]boost[^\w]/
-  end
-
-  def explanation
-    rendered_template
+  def match_regex
+     /[^\w]boost[^\w]/
   end
 
   def template_name

data/lib/log_magic/explainers/explainer_sections/dis_max_explainer.rb

@@ -5,12 +5,8 @@ class LogMagic::SearchkickExplainer::DisMaxExplainerSection
     @query_json = query_json
   end
 
-  def matches?
-    @query_json =~ /[^\w]dis_max[^\w]/
-  end
-
-  def explanation
-    rendered_template
+  def match_regex
+    /[^\w]dis_max[^\w]/
   end
 
   def template_name

data/lib/log_magic/explainers/explainer_sections/match_explainer.rb

@@ -5,12 +5,8 @@ class LogMagic::SearchkickExplainer::MatchExplainerSection
     @query_json = query_json
   end
 
-  def matches?
-    @query_json =~ /[^\w]match[^\w]/
-  end
-
-  def explanation
-    rendered_template
+  def match_regex
+    /[^\w]match[^\w]/
   end
 
   def template_name

data/lib/log_magic/explainers/explainer_sections/query_explainer.rb

@@ -0,0 +1,34 @@
+class LogMagic::SearchkickExplainer::QueryExplainerSection
+  include ::LogMagic::TemplatingUtils
+  include ::LogMagic::JSONUtils
+  attr_reader :query_json
+
+  def initialize(query_json)
+    @query_json = pretty_print_json(query_json)
+    enriche_query_json
+  end
+
+  def explanation
+    rendered_template
+  end
+
+  def template_name
+    'query.haml'
+  end
+
+  def explainer_section_classes
+    [
+      ::LogMagic::SearchkickExplainer::DisMaxExplainerSection,
+      ::LogMagic::SearchkickExplainer::BoostExplainerSection,
+      ::LogMagic::SearchkickExplainer::MatchExplainerSection
+    ]
+  end
+
+  def enriche_query_json
+    explainer_section_classes.map do |explainer_section_class|
+      explainer_section_class.new(query_json)
+    end.select do |explainer_section|
+      explainer_section.enriche
+    end
+  end
+end

data/lib/log_magic/explainers/searchkick_explainer.rb

@@ -5,8 +5,8 @@ require 'haml'
 class LogMagic::SearchkickExplainer
   include ::LogMagic::JSONUtils
   include ::LogMagic::TemplatingUtils
-  
-  def initialize()
+
+  def initialize
     @persistance_layer = ::LogMagic::PersistanceLayer.new
   end
 
@@ -22,20 +22,8 @@ class LogMagic::SearchkickExplainer
     SettingsExplainerSection.new(elasticsearch_url)
   end
 
-  def explainer_section_classes
-    [
-      DisMaxExplainerSection,
-      BoostExplainerSection,
-      MatchExplainerSection
-    ]
-  end
-
-  def explainer_sections
-    explainer_section_classes.map do |explainer_section_class|
-      explainer_section_class.new(query_json)
-    end.select do |explainer_section|
-      explainer_section.matches?
-    end
+  def explained_query
+    QueryExplainerSection.new(query_json)
   end
 
   def start

data/lib/log_magic/utils/templating_utils.rb

@@ -9,4 +9,8 @@ module LogMagic::TemplatingUtils
       File.join(__FILE__, '..', '..', 'explainer_templates', template_name)
     )
   end
+
+  def enriche
+    @query_json.gsub!(match_regex, rendered_template)
+  end
 end

data/lib/log_magic.rb

@@ -57,4 +57,5 @@ require 'log_magic/explainers/explainer_sections/dis_max_explainer'
 require 'log_magic/explainers/explainer_sections/match_explainer'
 require 'log_magic/explainers/explainer_sections/boost_explainer'
 require 'log_magic/explainers/explainer_sections/settings_explainer'
+require 'log_magic/explainers/explainer_sections/query_explainer'
 require 'log_magic/persistance_layer'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: log_magic
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Manuel Korfmann
@@ -108,11 +108,13 @@ files:
 - lib/log_magic/explainer_templates/boost.haml
 - lib/log_magic/explainer_templates/dis_max.haml
 - lib/log_magic/explainer_templates/match.haml
+- lib/log_magic/explainer_templates/query.haml
 - lib/log_magic/explainer_templates/searchkick.haml
 - lib/log_magic/explainer_templates/settings.haml
 - lib/log_magic/explainers/explainer_sections/boost_explainer.rb
 - lib/log_magic/explainers/explainer_sections/dis_max_explainer.rb
 - lib/log_magic/explainers/explainer_sections/match_explainer.rb
+- lib/log_magic/explainers/explainer_sections/query_explainer.rb
 - lib/log_magic/explainers/explainer_sections/settings_explainer.rb
 - lib/log_magic/explainers/searchkick_explainer.rb
 - lib/log_magic/log_listener.rb