log_magic 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9954218d1b500263e589e5db673d289a871ef149
-  data.tar.gz: 1befbd958b7416c9dcfce6c7406900eebd62cd40
+  metadata.gz: 2995ed8296855e2b64a848d1c6be572f21b4c77d
+  data.tar.gz: bb267b3e7f42148109699f6a17ab9eb11e611823
 SHA512:
-  metadata.gz: 61daa1cfd8b646a67ce3aa9d42e841b52b664689dfa1f9bc466367109e9e69b7e1e059dd1b781682c58b89e6f70f31f36e76d3eab41250422b0308698853b10e
-  data.tar.gz: a9ca50d9b56b0cd28280938174de0195e4abf45bed0fda07578785745a9fa7bd8e977f1c43207ca59382b5925ff0c5e85173ac4f0de5c33b8f360c8ab9a20ddc
+  metadata.gz: ab06de5813d616854b69fedc6ffc98c0b138903fb6dfa0b9570ef98c914d2470eb40cc26973e91a56a9ea152f99ab1e532d0adfc8674802c18b1a78b022082a8
+  data.tar.gz: c13f6d63f49e2b393cfa82ed0e08c1772dfc792042cfbf9cab8350dec2f9fc13c330b4710944dc20b3d47a988d57f2d4d03be2e5b2130d3a1b6f81f1c112fd78

data/bin/rebuild

@@ -1,2 +1,2 @@
 gem build log_magic.gemspec
-gem install log_magic-0.0.1.gem
+gem install log_magic-0.0.3.gem

data/lib/log_magic/explainer_templates/boost.haml

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

data/lib/log_magic/explainer_templates/dis_max.haml

@@ -0,0 +1,4 @@
+%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

data/lib/log_magic/explainer_templates/match.haml

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

data/lib/log_magic/explainer_templates/searchkick.haml

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

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

@@ -0,0 +1,19 @@
+class LogMagic::SearchkickExplainer::BoostExplainerSection
+  include ::LogMagic::TemplatingUtils
+
+  def initialize(query_json)
+    @query_json = query_json
+  end
+
+  def matches?
+    @query_json =~ /[^\w]boost[^\w]/
+  end
+
+  def explanation
+    rendered_template
+  end
+
+  def template_name
+    'boost.haml'
+  end
+end

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

@@ -0,0 +1,19 @@
+class LogMagic::SearchkickExplainer::DisMaxExplainerSection
+  include ::LogMagic::TemplatingUtils
+
+  def initialize(query_json)
+    @query_json = query_json
+  end
+
+  def matches?
+    @query_json =~ /[^\w]dis_max[^\w]/
+  end
+
+  def explanation
+    rendered_template
+  end
+
+  def template_name
+    'dis_max.haml'
+  end
+end

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

@@ -0,0 +1,19 @@
+class LogMagic::SearchkickExplainer::MatchExplainerSection
+  include ::LogMagic::TemplatingUtils
+
+  def initialize(query_json)
+    @query_json = query_json
+  end
+
+  def matches?
+    @query_json =~ /[^\w]match[^\w]/
+  end
+
+  def explanation
+    rendered_template
+  end
+
+  def template_name
+    'match.haml'
+  end
+end

data/lib/log_magic/explainers/searchkick_explainer.rb

@@ -4,6 +4,7 @@ require 'haml'
 
 class LogMagic::SearchkickExplainer
   include ::LogMagic::JSONUtils
+  include ::LogMagic::TemplatingUtils
 
   attr_accessor :database_name
 
@@ -15,6 +16,22 @@ class LogMagic::SearchkickExplainer
     @persistance_layer.retrieve_value(@uuid)
   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
+  end
+
   def start
     app = Proc.new do |env|
       @uuid = env['PATH_INFO'][1..-1]
@@ -24,17 +41,10 @@ class LogMagic::SearchkickExplainer
     end
 
     Rack::Handler::WEBrick.run app, Port: 7467,
-                                    Logger: WEBrick::Log::new('/dev/null')
-  end
-
-  def rendered_template
-    engine = Haml::Engine.new(File.read(template_path))
-    engine.render(self)
+                                    Logger: WEBrick::Log::new('/tmp/log_magic.log')
   end
 
-  def template_path
-    File.expand_path(
-      File.join(__FILE__, '..', '..', 'explainer_templates', 'searchkick.haml')
-    )
+  def template_name
+    'searchkick.haml'
   end
 end

data/lib/log_magic/persistance_layer.rb

@@ -8,7 +8,7 @@ class LogMagic::PersistanceLayer
   end
 
   def add_value(value)
-    uuid = SecureRandom.uuid
+    uuid = ::SecureRandom.uuid
 
     @redis.set(uuid, value)
 

data/lib/log_magic/utils/json_utils.rb

@@ -8,4 +8,8 @@ module LogMagic::JSONUtils
   def parse_json(json)
     JSON.parse(json)
   end
+
+  def query_hash
+    JSON.parse(query_json)
+  end
 end

data/lib/log_magic/utils/templating_utils.rb

@@ -0,0 +1,12 @@
+module LogMagic::TemplatingUtils
+  def rendered_template
+    engine = Haml::Engine.new(File.read(template_path))
+    engine.render(self)
+  end
+
+  def template_path
+    File.expand_path(
+      File.join(__FILE__, '..', '..', 'explainer_templates', template_name)
+    )
+  end
+end

data/lib/log_magic.rb

@@ -48,9 +48,12 @@ end
 
 
 require 'log_magic/utils/json_utils'
+require 'log_magic/utils/templating_utils'
 require 'log_magic/log_listener'
 require 'log_magic/refiners/searchkick_refiner'
 require 'log_magic/printers/searchkick_printer'
-
 require 'log_magic/explainers/searchkick_explainer'
+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/persistance_layer'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: log_magic
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Manuel Korfmann
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: "\n  By analysing your development.log,\n  log_magic gives you insights
   about your services.\n  "
 email: manu@korfmann.info
@@ -91,14 +105,21 @@ files:
 - bin/log_magic
 - bin/rebuild
 - lib/log_magic.rb
+- 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/searchkick.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/searchkick_explainer.rb
 - lib/log_magic/log_listener.rb
 - lib/log_magic/persistance_layer.rb
 - lib/log_magic/printers/searchkick_printer.rb
 - lib/log_magic/refiners/searchkick_refiner.rb
 - lib/log_magic/utils/json_utils.rb
-homepage: http://rubygems.org/gems/log_magick
+- lib/log_magic/utils/templating_utils.rb
+homepage: https://github.com/ManuelArno/log_magic
 licenses:
 - MIT
 metadata: {}