mysql2_query_filter-plugin-casual_log 0.0.5 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 151fb6a5ddaf5e389c61faa4950b6ae678cbde29
-  data.tar.gz: 9f24794cd590e62a6f61ffdc3f8cc1cbd109eae3
+  metadata.gz: 8c9a11dd7e3e1c153515f7a4856d9bf10ab836e8
+  data.tar.gz: 92ad092a5a754b212ea682bbbf45aa2bacd0f66f
 SHA512:
-  metadata.gz: ab55ede1d3793d0f932f2a6b2900f6b35479da107a83c8373dadcdb26a9729f689fb605882d5430558896dcf1ebbfaf6932699db5c94c4987e7c099bf38eb149
-  data.tar.gz: bdcea2c6c5c6ca2a4571e660447042dbd25e458224f510c3baca6712e5958b50ef3f9ca50b15ef96bbbe757754e7aef02d72b87e2f87ca3f32a39b552057e57e
+  metadata.gz: 97a27c7ff048ff3fb148a05b33d03fad26f2676cc78d20c133b3308aeb74fd029550a4d1f69d7cb0309b2a6fe5308d76c775eadfa123075abff8f688c31a2cff
+  data.tar.gz: 1823dd345272de64cc1db24302c9cac952c71565454001777ae5a49159c8a156eda3c5fbcae3d99e1b3f5461dc986f371106ef39d5179921a7ce92483c5bde7a

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.1
+script:
+  - bundle install
+  - bundle exec rake

data/README.md

@@ -1,8 +1,12 @@
 # Mysql2QueryFilter::Plugin::CasualLog
 
 Plug-in that colorize the bad query for [Mysql2QueryFilter](https://github.com/winebarrel/mysql2_query_filter).
+It is porting of [MySQLCasualLog.pm](https://gist.github.com/kamipo/839e8a5b6d12bddba539).
 
-Porting of [MySQLCasualLog.pm](https://gist.github.com/kamipo/839e8a5b6d12bddba539).
+see http://kamipo.github.io/talks/20140711-mysqlcasual6
+
+[![Gem Version](https://badge.fury.io/rb/mysql2_query_filter-plugin-casual_log.svg)](http://badge.fury.io/rb/mysql2_query_filter-plugin-casual_log)
+[![Build Status](https://travis-ci.org/winebarrel/mysql2_query_filter-plugin-casual_log.svg?branch=master)](https://travis-ci.org/winebarrel/mysql2_query_filter-plugin-casual_log)
 
 ## Installation
 
@@ -26,10 +30,10 @@ Or install it yourself as:
 require 'mysql2_query_filter'
 
 Mysql2QueryFilter.configure do |filter|
-  filter.plugin :casual_log, database: 'mysql'
+  filter.plugin :casual_log #, client: Mysql2::Client.new(...)
 end
 
-Mysql2QueryFilter.enable
+Mysql2QueryFilter.enable!
 
 client = Mysql2::Client.new(host: 'localhost', username: 'root', database: 'mysql')
 client.query('SELECT * FROM user')
@@ -48,7 +52,3 @@ client.query('SELECT * FROM user')
 ```
 
 ![](http://i.gyazo.com/66a769f30eab5ff56655977d42a30f4d.png)
-
-## Retated links
-
-* http://kamipo.github.io/talks/20140711-mysqlcasual6

data/Rakefile

@@ -1 +1,5 @@
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/lib/mysql2_query_filter/plugin/casual_log.rb

@@ -3,7 +3,7 @@ require 'mysql2_query_filter'
 require 'term/ansicolor'
 
 module Mysql2QueryFilter::Plugin
-  class CasualLog < Filter
+  class CasualLog < Mysql2QueryFilter::Base
     Mysql2QueryFilter::Plugin.register(:casual_log, self)
 
     REGEXPS = {
@@ -31,33 +31,46 @@ module Mysql2QueryFilter::Plugin
 
     def initialize(options)
       super
-      @out = @options.delete(:out) || $stderr
-      @matcher = @options.delete(:match) || proc {|sql, query_options| true }
-      @client = Mysql2::Client.new(@options)
+      @out = @options[:out] || $stderr
+      @matcher = @options[:match] || proc {|sql, client| true }
+      @client = @options[:client]
     end
 
-    def filter(sql, query_options)
-      if sql =~ /\A\s*SELECT\b/i and @matcher.call(sql, query_options)
+    def filter(sql, client)
+      if sql =~ /\A\s*SELECT\b/i and @matcher.call(sql, client)
+        conn = @client || client
+        badquery = false
         explains = []
 
-        @client.query("EXPLAIN #{sql}").each do |result|
-          badquery = colorize_explain(result)
-          explains << format_explain(sql, result) if badquery
+        conn.query("EXPLAIN #{sql}", :as => :hash).each_with_index do |result, i|
+          colorize_explain(result).tap {|bq| badquery ||= bq }
+          explains << format_explain(result, i + 1)
         end
 
-        unless explains.empty?
-          @out << "# #{sql}\n" + explains.join("\n") + "\n"
+        if badquery
+          query_options = conn.query_options.dup
+          query_options.delete(:password)
+
+          @out << <<-EOS
+# Time: #{Time.now.strftime("%Y-%m-%d %H:%M:%S")}
+# Query options: #{query_options.inspect}
+# Query: #{sql}
+#{explains.join("\n")}
+          EOS
         end
       end
+    rescue => e
+      $stderr.puts colored([e.message, e.backtrace.first].join("\n"))
     end
 
     private
 
-    def colorize_explain(explain)
+    def colorize_explain(explain_result)
       badquery = false
 
       REGEXPS.each do |key, regexp|
-        value = explain[key] || ''
+        value = explain_result[key] ||= 'NULL'
+        value = value.to_s
 
         value.gsub!(regexp) do |m|
           badquery = true
@@ -72,15 +85,15 @@ module Mysql2QueryFilter::Plugin
       Term::ANSIColor.red(Term::ANSIColor.bold(str))
     end
 
-    def format_explain(sql, explain)
-      message = "---\n"
+    def format_explain(explain, i)
+      message = "*************************** #{i}. row ***************************\n"
       max_key_length = explain.keys.map(&:length).max
 
       explain.each do |key, value|
         message << "%*s: %s\n" % [max_key_length, key, value]
       end
 
-      message
+      message.chomp
     end
-  end
-end
+  end # CasualLog
+end # Mysql2QueryFilter::Plugin

data/mysql2_query_filter-plugin-casual_log.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = 'mysql2_query_filter-plugin-casual_log'
-  spec.version       = '0.0.5'
+  spec.version       = '0.1.1'
   spec.authors       = ['Genki Sugawara']
   spec.email         = ['sgwr_dts@yahoo.co.jp']
   spec.summary       = %q{Plug-in that colorize the bad query for Mysql2QueryFilter.}
@@ -14,8 +14,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'mysql2_query_filter'
+  spec.add_dependency 'mysql2_query_filter', '>= 0.1.1'
   spec.add_dependency 'term-ansicolor'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 3.0.0'
+  spec.add_development_dependency "timecop"
 end

data/spec/mysql2_query_filter-plugin-casual_log_spec.rb

@@ -0,0 +1,47 @@
+describe Mysql2QueryFilter::Plugin::CasualLog do
+  let(:client) { Mysql2::Client.new(host: "localhost", username: "root", database: "mysql") }
+  let(:today) { Time.parse("2015-05-15 20:15:55 +0000") }
+  let(:out) { StringIO.new }
+
+  before do
+    Mysql2QueryFilter.configure do |filter|
+      filter.plugin :casual_log, out: out
+    end
+
+    Timecop.freeze(today) do
+      client.query(sql)
+    end
+  end
+
+  subject { out.string.sub(/Query options:.*/, "Query options:").sub(/rows: \d+/, "rows:") }
+
+  context "when bad query" do
+    let(:sql) { "select * from user" }
+
+    let(:explain) do
+      <<-EOS
+# Time: 2015-05-15 20:15:55
+# Query options:
+# Query: select * from user
+*************************** 1. row ***************************
+           id: 1
+  select_type: SIMPLE
+        table: user
+         type: #{red bold "ALL"}
+possible_keys: #{red bold "NULL"}
+          key: #{red bold "NULL"}
+      key_len:\s
+          ref:\s
+         rows:
+        Extra:\s
+      EOS
+    end
+
+    it { is_expected.to eq explain }
+  end
+
+  context "when good query" do
+    let(:sql) { "select 1 from user where Host = 'localhost'" }
+    it { is_expected.to eq "" }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'mysql2_query_filter/plugin/casual_log'
+require 'stringio'
+require "time"
+require "timecop"
+
+ENV["TZ"] = "UTC"
+include Term::ANSIColor
+
+RSpec.configure do |config|
+  config.before(:all) do
+    Mysql2QueryFilter.enable!
+  end
+
+  config.before(:each) do
+    Mysql2QueryFilter.clear!
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mysql2_query_filter-plugin-casual_log
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.1
 platform: ruby
 authors:
 - Genki Sugawara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-09 00:00:00.000000000 Z
+date: 2015-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2_query_filter
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: Plug-in that colorize the bad query for Mysql2QueryFilter.
 email:
 - sgwr_dts@yahoo.co.jp
@@ -74,12 +102,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/mysql2_query_filter/plugin/casual_log.rb
 - mysql2_query_filter-plugin-casual_log.gemspec
+- spec/mysql2_query_filter-plugin-casual_log_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/winebarrel/mysql2_query_filter-plugin-casual_log
 licenses:
 - MIT
@@ -104,4 +136,6 @@ rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Plug-in that colorize the bad query for Mysql2QueryFilter.
-test_files: []
+test_files:
+- spec/mysql2_query_filter-plugin-casual_log_spec.rb
+- spec/spec_helper.rb