mysql2_query_filter-plugin-casual_log 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7deeddc1b117319fe5c95c760314bee02b69c5b7
+  data.tar.gz: ab110e16e8da18ef0127373eac9dbe3820fa0bf6
+SHA512:
+  metadata.gz: f5f74d16993aced999182cf6ec4f242f099c02e2e5b9c46a8f84a63a29a830f3ad7131166e07b64439759a065fefd31158575c93787dd0e8301cef276673f8cb
+  data.tar.gz: 7c17a7148e4af433c41c5341476ab16cbccd6e5f6b01fb524e729f6f1a1889c3f6a2f07afffeacbcd0d67aeb5899f7b6d105f981acdebc73df178927f3400b90

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+test.rb

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mysql2_query_filter-plugin-casual_log.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Genki Sugawara
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# Mysql2QueryFilter::Plugin::CasualLog
+
+Plug-in that colorize the bad query for [Mysql2QueryFilter](https://github.com/winebarrel/mysql2_query_filter).
+
+Porting of [MySQLCasualLog.pm](https://gist.github.com/kamipo/839e8a5b6d12bddba539).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mysql2_query_filter-plugin-casual_log'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mysql2_query_filter-plugin-casual_log
+
+## Usage
+
+```ruby
+require 'mysql2_query_filter'
+
+Mysql2QueryFilter.configure do |filter|
+  filter.plugin :casual_log , database: 'mysql'
+end
+
+Mysql2QueryFilter.enable
+
+client = Mysql2::Client.new(host: 'localhost', username: 'root', database: 'mysql')
+client.query('SELECT * FROM user')
+# => # SELECT * FROM user
+#    ---
+#               id: 1
+#      select_type: SIMPLE
+#            table: user
+#             type: ALL # <- red/bold
+#    possible_keys:
+#              key:
+#          key_len:
+#              ref:
+#             rows: 4
+#            Extra:
+```
+
+![](http://i.gyazo.com/66a769f30eab5ff56655977d42a30f4d.png)
+
+## Retated links
+
+* http://kamipo.github.io/talks/20140711-mysqlcasual6

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/mysql2_query_filter/plugin/casual_log.rb

@@ -0,0 +1,77 @@
+require 'yaml'
+require 'mysql2_query_filter'
+require 'term/ansicolor'
+
+module Mysql2QueryFilter::Plugin
+  class CasualLog < Filter
+    Mysql2QueryFilter.register(:casual_log, self)
+
+    REGEXPS = {
+      'select_type' => Regexp.union(
+        /DEPENDENT\sUNION/,
+        /DEPENDENT\sSUBQUERY/,
+        /UNCACHEABLE\sUNION/,
+        /UNCACHEABLE\sSUBQUERY/
+      ),
+      'type' =>  Regexp.union(
+        /index/,
+        /ALL/
+      ),
+      'possible_keys' => Regexp.union(
+        /NULL/
+      ),
+      'key' => Regexp.union(
+        /NULL/
+      ),
+      'Extra' => Regexp.union(
+        /Using\sfilesort/,
+        /Using\stemporary/
+      )
+    }
+
+    def initialize(options)
+      super
+      @out = @options.delete(:out) || $stderr
+      @client = Mysql2::Client.new(@options)
+    end
+
+    def filter(sql)
+      if sql =~ /\Aselect\b/i
+        result = @client.query("EXPLAIN #{sql}").first
+        badquery = colorize_explain(result)
+
+        if badquery
+          @out.puts "# #{sql}\n---"
+          max_key_length = result.keys.map(&:length).max
+
+          result.each do |key, value|
+            @out.puts "%*s: %s" % [max_key_length, key, value]
+          end
+
+          @out.puts
+        end
+      end
+    end
+
+    private
+
+    def colorize_explain(explain)
+      badquery = false
+
+      REGEXPS.each do |key, regexp|
+        value = explain[key] || ''
+
+        value.gsub!(regexp) do |m|
+          badquery = true
+          colored(m)
+        end
+      end
+
+      badquery
+    end
+
+    def colored(str)
+      Term::ANSIColor.red(Term::ANSIColor.bold(str))
+    end
+  end
+end

data/mysql2_query_filter-plugin-casual_log.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = 'mysql2_query_filter-plugin-casual_log'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Genki Sugawara']
+  spec.email         = ['sgwr_dts@yahoo.co.jp']
+  spec.summary       = %q{Plug-in that colorize the bad query for Mysql2QueryFilter.}
+  spec.description   = %q{Plug-in that colorize the bad query for Mysql2QueryFilter.}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'mysql2_query_filter'
+  spec.add_dependency 'term-ansicolor'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: mysql2_query_filter-plugin-casual_log
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Genki Sugawara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mysql2_query_filter
+  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: term-ansicolor
+  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: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mysql2_query_filter/plugin/casual_log.rb
+- mysql2_query_filter-plugin-casual_log.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Plug-in that colorize the bad query for Mysql2QueryFilter.
+test_files: []