log_magic 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffd3dcd36465ea32aadfa639ac2960c801c416fd
-  data.tar.gz: c8fed639991e0d91b4e56ebb1880942dc2cedb12
+  metadata.gz: 08cb4da5959a30e03917df67f8b639403bd947bd
+  data.tar.gz: d9ae174c0a9e17c48184cfc0a6237f1cdbe1c5f2
 SHA512:
-  metadata.gz: 5f373d8933c051d153128ef6cd1249ba818d5539f1b0f741c251139eae5ea88038f6454caedf125679c79df1a8531dbc776870d8596bf4bf075c9296c87aaf5e
-  data.tar.gz: 31a927edee1cdd9bc631c04ce2a006400ecd73a9cd46907a5a622189ffe0714f787da5f8bd0fa0039d8e15bb275ecd8cdad266edd1a06fca31593da889228edf
+  metadata.gz: 0b3a8cd289c129accc28b43e016b36db45fe90bdc488af5cc38210f397d36d9d8d6b65daa0238f90a79ae68c24345fea2dbd7fabda222ee949fdffb5a31b829b
+  data.tar.gz: 4dfd8a42fb2e1ad61d50512429eaf0476c4ceeaae744d71f02790a1a30d8ab31bd5180b62f32f796d43f3dc634b09c43e036e405c49370f39739f8dac2820560

data/bin/log_magic

@@ -5,14 +5,22 @@ require 'log_magic'
 begin
   log_magic = LogMagic.new(ARGV[0])
 
-  server = fork do
+  searchkick_server = fork do
     explainer_server = LogMagic::SearchkickExplainer.new
     explainer_server.start
   end
-  Process.detach(server)
+  Process.detach(searchkick_server)
+
+  mysql_server = fork do
+    explainer_server = LogMagic::MySqlExplainer.new
+    explainer_server.start
+  end
+  Process.detach(mysql_server)
 
   log_magic.initialize_listener
   log_magic.start
 ensure
-  `kill -9 #{server}` unless server.nil?
+  [mysql_server, searchkick_server].each do |server|
+    `kill -9 #{server}` unless server.nil?
+  end
 end

data/lib/log_magic.rb

@@ -1,17 +1,9 @@
 require 'file-tail'
 
 class LogMagic
-  attr_reader :persistance_layer
-
   def initialize(log_file_name)
     @log_file_name = log_file_name
-    @refiners = []
-    @persistance_layer = PersistanceLayer.new
-    add_searchkick_refiner
-  end
-
-  def database_name
-    @persistance_layer.database_name
+    reset_refiners
   end
 
   def initialize_listener
@@ -22,8 +14,9 @@ class LogMagic
     @log_listener.listen do |line|
       add_line_to_refiners(line)
       check_for_refiner_match do |refiner|
-        puts refiner.compute(persistance_layer)
+        puts refiner.compute
       end
+      reset_refiners
     end
   end
 
@@ -44,21 +37,47 @@ class LogMagic
   def add_searchkick_refiner
     @refiners << SearchkickRefiner.new
   end
+
+  def add_mysql_refiner
+    @refiners << MySqlRefiner.new
+  end
+
+  def reset_refiners
+    @refiners = []
+    add_searchkick_refiner
+    add_mysql_refiner
+  end
 end
 
+require 'active_support/all'
 
 require 'log_magic/utils/json_utils'
 require 'log_magic/utils/templating_utils'
+
 require 'log_magic/log_listener'
+
+require 'log_magic/refiners/base_refiner'
 require 'log_magic/refiners/searchkick_refiner'
+require 'log_magic/refiners/mysql_refiner'
+
 require 'log_magic/printers/searchkick_printer'
+require 'log_magic/printers/mysql_printer'
 
 require 'log_magic/renderers/hover_renderer'
 
+require 'log_magic/explainers/base_explainer'
 require 'log_magic/explainers/searchkick_explainer'
+require 'log_magic/explainers/mysql_explainer'
+
 
-Dir.glob("lib/log_magic/explainers/**/*.rb").each do |explainer|
-  require explainer.gsub('lib/', '')
+['searchkick', 'mysql'].each do |explainer_type|
+  explainer_files = \
+  File.expand_path(File.join(__FILE__, '..', "/log_magic/explainers/#{explainer_type}/"))
+
+  Dir.foreach(explainer_files).each do |explainer|
+    next if explainer == '.' || explainer == '..'
+    require File.join('log_magic', 'explainers', explainer_type, explainer)
+  end
 end
 
 require 'log_magic/persistance_layer'

data/lib/log_magic/explainer_templates/mysql.haml

@@ -0,0 +1,35 @@
+%head
+  %script{ src:"https://code.jquery.com/jquery-3.1.1.min.js", integrity:"sha256-hVVnYaiADRTO2PzUGmuLJr8BLUSjGIZsDYGmIJLv2b8=", crossorigin:"anonymous" }
+
+  :javascript
+    $(document).ready(function() {
+      $('span.hover-key').mouseover(function(e) {
+        $(this).find('.hover-value').css('top', e.pageY);
+        $(this).find('.hover-value').css('left', e.pageX);
+        $(this).find('.hover-value').show();
+      });
+
+      $('span.hover-key').mouseout(function(e) {
+        $(this).find('span.hover-value').hide();
+      });
+    });
+
+  :css
+    .hover-value {
+      display: none;
+      position: absolute;
+      top: 20px;
+      left: 20px;
+      background-color: lightyellow;
+      color: purple;
+      padding: 20px;
+      border: purple 1px solid;
+    }
+
+    .hover-key {
+      cursor: pointer;
+    }
+
+%body
+  %h2 Mysql
+  = explained_query.explanation

data/lib/log_magic/explainer_templates/mysql/WHERE.haml

@@ -0,0 +1,2 @@
+%a{href: 'http://www.w3schools.com/sql/sql_where.asp'}
+  WHERE

data/lib/log_magic/explainer_templates/mysql/query.haml

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

data/lib/log_magic/explainer_templates/searchkick.haml

@@ -26,6 +26,10 @@
       border: purple 1px solid;
     }
 
+    .hover-key {
+      cursor: pointer;
+    }
+
 %body
   %h2 Query
   %p

data/lib/log_magic/explainers/base_explainer.rb

@@ -0,0 +1,21 @@
+class LogMagic::BaseExplainer
+  include ::LogMagic::JSONUtils
+  include ::LogMagic::TemplatingUtils
+
+  def initialize
+    @persistance_layer = ::LogMagic::PersistanceLayer.new
+  end
+
+
+  def start
+    app = Proc.new do |env|
+      @uuid = env['PATH_INFO'][1..-1]
+      body = rendered_template
+
+      ['200', {'Content-Type' => 'text/html', 'Content-Length' => body.length.to_s}, [body]]
+    end
+
+    Rack::Handler::WEBrick.run app, Port: self.class.port_number,
+                                    Logger: WEBrick::Log::new('/tmp/log_magic.log')
+  end
+end

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

@@ -0,0 +1,31 @@
+class LogMagic::MySqlExplainer::QueryExplainerSection
+  include ::LogMagic::TemplatingUtils
+  attr_reader :mysql_query
+
+  def initialize(query_json)
+    @mysql_query = mysql_query
+    enriche_mysql_query
+  end
+
+  def explanation
+    rendered_template
+  end
+
+  def template_name
+    'query.haml'
+  end
+
+  def explainer_section_classes
+    [
+      ::LogMagic::MySqlExplainer::WhereExplainerSection
+    ]
+  end
+
+  def enriche_mysql_query
+    explainer_section_classes.map do |explainer_section_class|
+      explainer_section_class.new(mysql_query)
+    end.each do |explainer_section|
+      explainer_section.enriche
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+class LogMagic::MySqlExplainer::QueryExplainerSection
+  include ::LogMagic::TemplatingUtils
+  attr_reader :mysql_query
+
+  def initialize(mysql_query)
+    @mysql_query = mysql_query
+    enriche_mysql_query
+  end
+
+  def explanation
+    rendered_template
+  end
+
+  def template_name
+    'query.haml'
+  end
+
+  def explainer_section_classes
+    [
+      ::LogMagic::MySqlExplainer::WhereExplainerSection
+    ]
+  end
+
+  def enriche_mysql_query
+    explainer_section_classes.map do |explainer_section_class|
+      explainer_section_class.new(mysql_query)
+    end.each do |explainer_section|
+      explainer_section.enriche
+    end
+  end
+end

data/lib/log_magic/explainers/mysql/where_explainer.rb

@@ -0,0 +1,7 @@
+class LogMagic::MySqlExplainer::WhereExplainerSection
+  include ::LogMagic::TemplatingUtils
+
+  def term_name
+    'WHERE'
+  end
+end

data/lib/log_magic/explainers/mysql_explainer.rb

@@ -0,0 +1,26 @@
+require 'rack'
+require 'byebug'
+require 'haml'
+
+class LogMagic::MySqlExplainer < LogMagic::BaseExplainer
+  def self.port_number
+    7469
+  end
+
+  def mysql_query
+    # TODO: find root issue for why chomping \e[0m is necessary
+    mysql_query = @persistance_layer.retrieve_value(@uuid, 'mysql_query').chomp('[0m')
+    mysql_query = mysql_query[0..-2]
+    mysql_query
+  end
+
+  def explained_query
+    @query_explainer = QueryExplainerSection.new(mysql_query)
+    @query_explainer.enriche_mysql_query
+    @query_explainer
+  end
+
+  def template_name
+    'mysql.haml'
+  end
+end

data/lib/log_magic/explainers/searchkick/analyzer_explainer.rb

@@ -0,0 +1,7 @@
+class LogMagic::SearchkickExplainer::AnalyzerExplainerSection
+  include ::LogMagic::TemplatingUtils
+
+  def term_name
+    'analyzer'
+  end
+end

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

@@ -0,0 +1,7 @@
+class LogMagic::SearchkickExplainer::BoostExplainerSection
+  include ::LogMagic::TemplatingUtils
+
+  def term_name
+    'boost'
+  end
+end

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

@@ -0,0 +1,7 @@
+class LogMagic::SearchkickExplainer::DisMaxExplainerSection
+  include ::LogMagic::TemplatingUtils
+  
+  def term_name
+    'dis_max'
+  end
+end

data/lib/log_magic/explainers/searchkick/fuzzy_transpositions_explainer.rb

@@ -0,0 +1,7 @@
+class LogMagic::SearchkickExplainer::FuzzyTranspositionsSection
+  include ::LogMagic::TemplatingUtils
+
+  def term_name
+    'fuzzy_transpositions'
+  end
+end

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

@@ -0,0 +1,7 @@
+class LogMagic::SearchkickExplainer::MatchExplainerSection
+  include ::LogMagic::TemplatingUtils
+
+  def term_name
+    'match'
+  end
+end

data/lib/log_magic/explainers/searchkick_explainer.rb

@@ -2,12 +2,9 @@ require 'rack'
 require 'byebug'
 require 'haml'
 
-class LogMagic::SearchkickExplainer
-  include ::LogMagic::JSONUtils
-  include ::LogMagic::TemplatingUtils
-
-  def initialize
-    @persistance_layer = ::LogMagic::PersistanceLayer.new
+class LogMagic::SearchkickExplainer < LogMagic::BaseExplainer
+  def self.port_number
+    7467
   end
 
   def query_json
@@ -28,18 +25,6 @@ class LogMagic::SearchkickExplainer
     @query_explainer
   end
 
-  def start
-    app = Proc.new do |env|
-      @uuid = env['PATH_INFO'][1..-1]
-      body = rendered_template
-
-      ['200', {'Content-Type' => 'text/html', 'Content-Length' => body.length.to_s}, [body]]
-    end
-
-    Rack::Handler::WEBrick.run app, Port: 7467,
-                                    Logger: WEBrick::Log::new('/tmp/log_magic.log')
-  end
-
   def template_name
     'searchkick.haml'
   end

data/lib/log_magic/persistance_layer.rb

@@ -10,7 +10,7 @@ class LogMagic::PersistanceLayer
   end
 
   def add_value(key, value)
-    @redis.hset(@uuid, key, value)
+    @redis.hset(uuid, key, value)
   end
 
   def retrieve_value(uuid, key)

data/lib/log_magic/printers/mysql_printer.rb

@@ -0,0 +1,17 @@
+class LogMagic::MySqlPrinter
+  def initialize(mysql_query, uuid)
+    @mysql_query = mysql_query
+    @uuid = uuid
+  end
+
+  def print
+    """
+    MySQL query generated by Rails
+    ----
+    #{@mysql_query}
+    ----
+    Copy and view in browser: http://localhost:#{::LogMagic::MySqlExplainer.port_number}/#{@uuid}
+    <------------------------------------------>
+    """
+  end
+end

data/lib/log_magic/printers/searchkick_printer.rb

@@ -9,7 +9,7 @@ class LogMagic::SearchkickPrinter
   def print
     """
     ElasticSearch query generated by Searchkick explained
-    Copy and view in browser: http://localhost:7467/#{@uuid}
+    Copy and view in browser: http://localhost:#{::LogMagic::SearchkickExplainer.port_number}/#{@uuid}
     <------------------------------------------>
     """
   end

data/lib/log_magic/refiners/base_refiner.rb

@@ -0,0 +1,15 @@
+class LogMagic::BaseRefiner
+  attr_accessor :lines
+
+  def initialize
+    @lines = []
+  end
+
+  def matches?
+    lines.last =~ line_match_regex
+  end
+
+  def persistance_layer
+    @persistance_layer ||= ::LogMagic::PersistanceLayer.new
+  end
+end

data/lib/log_magic/refiners/mysql_refiner.rb

@@ -0,0 +1,28 @@
+class LogMagic::MySqlRefiner < LogMagic::BaseRefiner
+  def line_match_regex
+    /\w*\sLoad/
+  end
+
+  def compute
+    mysql_query = extract_mysql_query
+    persist_mysql_query(mysql_query)
+    output(mysql_query, persistance_layer.uuid)
+  end
+
+  def output(mysql_query, uuid)
+    mysql_printer = ::LogMagic::MySqlPrinter.new(mysql_query, uuid)
+    mysql_printer.print
+  end
+
+  def extract_mysql_query
+    @lines.last.match(load_sql_regex)[1]
+  end
+
+  def persist_mysql_query(mysql_query)
+    persistance_layer.add_value('mysql_query', mysql_query)
+  end
+
+  def load_sql_regex
+    /Load \([\d\.]+ms\)[^S]*(.*)/
+  end
+end

data/lib/log_magic/refiners/searchkick_refiner.rb

@@ -1,20 +1,14 @@
-class LogMagic::SearchkickRefiner
-  attr_accessor :lines
-
-  def initialize
-    @lines = []
-  end
-
-  def matches?
-    lines.last =~ /Search[^c]*curl/
+class LogMagic::SearchkickRefiner < LogMagic::BaseRefiner
+  def line_match_regex
+    /Search[^c]*curl/
   end
 
-  def compute(persistance_layer)
+  def compute
     elasticsearch_url = extract_elasticsearch_url
-    persist_elasticsearch_url(persistance_layer, elasticsearch_url)
+    persist_elasticsearch_url(elasticsearch_url)
 
     query_json = extract_query_json
-    persist_query_json(persistance_layer, query_json)
+    persist_query_json(query_json)
 
     output(query_json, persistance_layer.uuid)
   end
@@ -32,11 +26,11 @@ class LogMagic::SearchkickRefiner
     @lines.last.match(/https?:\/\/[^\/]*\/[^\/]*/)[0]
   end
 
-  def persist_query_json(persistance_layer, query_json)
+  def persist_query_json(query_json)
     persistance_layer.add_value('query_json', query_json)
   end
 
-  def persist_elasticsearch_url(persistance_layer, elasticsearch_url)
+  def persist_elasticsearch_url(elasticsearch_url)
     persistance_layer.add_value('elasticsearch_url', elasticsearch_url)
   end
 end

data/lib/log_magic/utils/templating_utils.rb

@@ -9,9 +9,11 @@ module LogMagic::TemplatingUtils
   end
 
   def template_path
-    File.expand_path(
-      File.join(__FILE__, '..', '..', template_dir, template_name)
+    file_name = File.expand_path(
+      file_name = File.join(__FILE__, '..', '..', template_dir, template_name)
     )
+    fail("No template found for #{self.class.name}") unless File.exist?(file_name)
+    return file_name
   end
 
   def enriche
@@ -27,6 +29,14 @@ module LogMagic::TemplatingUtils
   end
 
   def template_dir
-    'explainer_templates'
+    if self.class.name =~ /\w*::\w*::\w*/
+      if self.class.name =~ /LogMagic::SearchkickExplainer/
+        'explainer_templates/searchkick'
+      elsif self.class.name =~ /LogMagic::MySqlExplainer/
+        'explainer_templates/mysql'
+      end
+    else
+      'explainer_templates'
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: log_magic
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Manuel Korfmann
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -119,30 +133,41 @@ files:
 - bin/log_magic
 - bin/rebuild
 - lib/log_magic.rb
-- lib/log_magic/explainer_templates/_all.haml
-- lib/log_magic/explainer_templates/analyzer.haml
-- lib/log_magic/explainer_templates/boost.haml
-- lib/log_magic/explainer_templates/dis_max.haml
-- lib/log_magic/explainer_templates/fuzzy_transpositions.haml
-- lib/log_magic/explainer_templates/match.haml
-- lib/log_magic/explainer_templates/max_expansions.haml
-- lib/log_magic/explainer_templates/query.haml
+- lib/log_magic/explainer_templates/mysql.haml
+- lib/log_magic/explainer_templates/mysql/WHERE.haml
+- lib/log_magic/explainer_templates/mysql/query.haml
 - lib/log_magic/explainer_templates/searchkick.haml
-- lib/log_magic/explainer_templates/settings.haml
-- lib/log_magic/explainers/explainer_sections/_all_explainer.rb
-- lib/log_magic/explainers/explainer_sections/analyzer_explainer.rb
-- lib/log_magic/explainers/explainer_sections/boost_explainer.rb
-- lib/log_magic/explainers/explainer_sections/custom_analyzer_hover.rb
-- lib/log_magic/explainers/explainer_sections/dis_max_explainer.rb
-- lib/log_magic/explainers/explainer_sections/fuzzy_transpositions_explainer.rb
-- lib/log_magic/explainers/explainer_sections/match_explainer.rb
-- lib/log_magic/explainers/explainer_sections/max_expansions_section.rb
-- lib/log_magic/explainers/explainer_sections/query_explainer.rb
-- lib/log_magic/explainers/explainer_sections/settings_explainer.rb
+- lib/log_magic/explainer_templates/searchkick/_all.haml
+- lib/log_magic/explainer_templates/searchkick/analyzer.haml
+- lib/log_magic/explainer_templates/searchkick/boost.haml
+- lib/log_magic/explainer_templates/searchkick/dis_max.haml
+- lib/log_magic/explainer_templates/searchkick/fuzzy_transpositions.haml
+- lib/log_magic/explainer_templates/searchkick/match.haml
+- lib/log_magic/explainer_templates/searchkick/max_expansions.haml
+- lib/log_magic/explainer_templates/searchkick/query.haml
+- lib/log_magic/explainer_templates/searchkick/settings.haml
+- lib/log_magic/explainers/base_explainer.rb
+- lib/log_magic/explainers/msyql/query_explainer.rb
+- lib/log_magic/explainers/mysql/query_explainer.rb
+- lib/log_magic/explainers/mysql/where_explainer.rb
+- lib/log_magic/explainers/mysql_explainer.rb
+- lib/log_magic/explainers/searchkick/_all_explainer.rb
+- lib/log_magic/explainers/searchkick/analyzer_explainer.rb
+- lib/log_magic/explainers/searchkick/boost_explainer.rb
+- lib/log_magic/explainers/searchkick/custom_analyzer_hover.rb
+- lib/log_magic/explainers/searchkick/dis_max_explainer.rb
+- lib/log_magic/explainers/searchkick/fuzzy_transpositions_explainer.rb
+- lib/log_magic/explainers/searchkick/match_explainer.rb
+- lib/log_magic/explainers/searchkick/max_expansions_section.rb
+- lib/log_magic/explainers/searchkick/query_explainer.rb
+- lib/log_magic/explainers/searchkick/settings_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/mysql_printer.rb
 - lib/log_magic/printers/searchkick_printer.rb
+- lib/log_magic/refiners/base_refiner.rb
+- lib/log_magic/refiners/mysql_refiner.rb
 - lib/log_magic/refiners/searchkick_refiner.rb
 - lib/log_magic/renderers/hover_renderer.rb
 - lib/log_magic/util_templates/hovering.haml

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

@@ -1,15 +0,0 @@
-class LogMagic::SearchkickExplainer::AnalyzerExplainerSection
-  include ::LogMagic::TemplatingUtils
-
-  def initialize(query_json)
-    @query_json = query_json
-  end
-
-  def match_regex
-    /[^\w]analyzer[^\w]/
-  end
-
-  def template_name
-    'analyzer.haml'
-  end
-end

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

@@ -1,15 +0,0 @@
-class LogMagic::SearchkickExplainer::BoostExplainerSection
-  include ::LogMagic::TemplatingUtils
-
-  def initialize(query_json)
-    @query_json = query_json
-  end
-
-  def match_regex
-     /[^\w]boost[^\w]/
-  end
-
-  def template_name
-    'boost.haml'
-  end
-end

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

@@ -1,15 +0,0 @@
-class LogMagic::SearchkickExplainer::DisMaxExplainerSection
-  include ::LogMagic::TemplatingUtils
-
-  def initialize(query_json)
-    @query_json = query_json
-  end
-
-  def match_regex
-    /[^\w]dis_max[^\w]/
-  end
-
-  def template_name
-    'dis_max.haml'
-  end
-end

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

@@ -1,15 +0,0 @@
-class LogMagic::SearchkickExplainer::FuzzyTranspositionsSection
-  include ::LogMagic::TemplatingUtils
-
-  def initialize(query_json)
-    @query_json = query_json
-  end
-
-  def match_regex
-    /[^\w]fuzzy_transpositions[^\w]/
-  end
-
-  def template_name
-    'fuzzy_transpositions.haml'
-  end
-end

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

@@ -1,15 +0,0 @@
-class LogMagic::SearchkickExplainer::MatchExplainerSection
-  include ::LogMagic::TemplatingUtils
-
-  def initialize(query_json)
-    @query_json = query_json
-  end
-
-  def match_regex
-    /[^\w]match[^\w]/
-  end
-
-  def template_name
-    'match.haml'
-  end
-end