explain_parser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57f9288b3203db28348942495a9ae6f64d8985a5
+  data.tar.gz: ceb1de9f91b1003f1b1749bd3949f1a2130429ac
+SHA512:
+  metadata.gz: 9cb28810513094751613be8eca502687d988992d58a8b1f3c35d92500935109df20d8124ea078de34aaac5d7e3df4770b03dc080cdb5825eb29d5726e6d68de5
+  data.tar.gz: a93c89ec17ae94f65c924dd016c3e7191f0ccf1afd4828bd6be765d6e3addc83dcb633c7c176288172267ee72240d816da5c2380f241117fdbc6deec784dba5a

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 ainame
+
+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 @@
+# ExplainParser
+
+Parser for result of EXPLAIN of MySQL(inspired from http://search.cpan.org/~moznion/MySQL-Explain-Parser-0.02/lib/MySQL/Explain/Parser.pm)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'explain_parser'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install explain_parser
+
+## Usage
+
+```ruby
+input <<-EOS
++----+-------------+-------+------+---------------+------+---------+------+------+----------------------------------------------------------+
+| id | select_type | table | type | possible_keys | key  | key_len | ref  | rows | Extra                                                    |
++----+-------------+-------+------+---------------+------+---------+------+------+----------------------------------------------------------+
+|  1 | SIMPLE      | users | ALL  | NULL          | NULL | NULL    | NULL |  155 | Using where; Using index Using temporary; Using filesort |
++----+-------------+-------+------+---------------+------+---------+------+------+----------------------------------------------------------+
+1 row in set (0.00 sec)
+EOS
+
+parser = ExplainParser.new(input)
+explains = parser.parse
+explain = explains.first
+
+explain.id #=> 1
+explain.select_type #=> 'SIMPLE'
+
+...
+
+explain.rows #=> 155
+explain.extra #=> 'Using where; Using index Using temporary; Using filesort'
+explain.using_filesort? #=> true
+explain.using_where? #=> true
+explain.using_temporary? #=> true
+explain.using_index? #=> true
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/explain_parser/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/explain_parser.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'explain_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "explain_parser"
+  spec.version       = ExplainParser::VERSION
+  spec.authors       = ["ainame"]
+  spec.email         = ["s.namai.09@gmail.com"]
+  spec.summary       = %q{Parser for result of EXPLAIN of MySQL}
+  spec.description   = %q{Parser for result of EXPLAIN of MySQL
+see: https://github.com/ainame/explain_parser
+}
+  spec.homepage      = "https://github.com/ainame/explain_parser"
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/explain_parser/version.rb

@@ -0,0 +1,3 @@
+class ExplainParser
+  VERSION = "0.0.1"
+end

data/lib/explain_parser.rb

@@ -0,0 +1,87 @@
+require "explain_parser/version"
+
+class ExplainParser
+
+  class Explain
+    COLUMNS = [
+      :id, :select_type, :table, :type, :possible_keys, :key, :key_len, :len, :ref, :rows, :filtered, :extra
+    ].freeze
+
+    def initialize(params)
+      raise ArgumentError unless params
+      @params = params
+    end
+
+    COLUMNS.each do |column|
+      method_name = column.to_s
+      if [:id, :rows].include?(column)
+        define_method(column) do
+          @params[method_name].to_i
+        end
+      else
+        define_method(column) do
+          @params[method_name]
+        end
+      end
+    end
+
+    def using_filesort?
+      !!(extra =~ /Using filesort/)
+    end
+
+    def using_temporary?
+      !!(extra =~ /Using temporary/)
+    end
+
+    def using_where?
+      !!(extra =~ /Using where/)
+    end
+
+    def using_index?
+      !!(extra =~ /Using index/)
+    end
+  end
+
+  def initialize(explain)
+    raise ArgumentError unless explain
+    @explain = explain
+  end
+
+  def self.call(explain)
+    new(explain).call
+  end
+
+  def call
+    return unless rows && !rows.empty?
+    build
+  end
+
+  def lines
+    @explain.each_line.to_a
+  end
+
+  def rows
+    @rows ||= lines.select{|line| line =~ /\w+/ && line !~ /\d+ row in set/ }
+  end
+
+  def keys()
+    @keys ||= rows[0].chomp.split('|').compact.map(&:strip).reject(&:empty?).map(&:downcase)
+  end
+
+  def values_list()
+    rows[1..-1].map{|row| cleanup_values(row.chomp.split('|').compact) }
+  end
+
+  def cleanup_values(dirty_values)
+    dirty_values.map(&:strip).reject(&:empty?).map {|val| val == 'NULL' ? nil : val }
+  end
+
+  def build
+    values_list.reduce([]) do |explains, values|
+      params = keys.zip(values).inject({}) { |h, (k, v)| h[k] = v; h }
+      explains << ExplainParser::Explain.new(params)
+      explains
+    end
+  end
+
+end

data/spec/lib/explain_parser_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+describe ExplainParser do
+  context 'given explain string' do
+    let(:input) do
+      <<-EOS
++----+-------------+-------+------+---------------+------+---------+------+------+-------+
+| id | select_type | table | type | possible_keys | key  | key_len | ref  | rows | Extra |
++----+-------------+-------+------+---------------+------+---------+------+------+-------+
+|  1 | SIMPLE      | users | ALL  | NULL          | NULL | NULL    | NULL |  155 | NULL  |
++----+-------------+-------+------+---------------+------+---------+------+------+-------+
+1 row in set (0.00 sec)
+    EOS
+    end
+    subject { ExplainParser.new(input) }
+
+    describe '.new' do
+      it { is_expected.to be_kind_of(ExplainParser)}
+    end
+
+    describe '#call' do
+      it 'should ExplainParser::Explain' do
+        expect(subject.call).to be_kind_of(Array)
+        expect(subject.call[0]).to be_kind_of(ExplainParser::Explain)
+      end
+
+      it 'should ExplainParser::Explain' do
+        explain = subject.call[0]
+        expect(explain.id).to eq 1
+        expect(explain.select_type).to eq 'SIMPLE'
+        expect(explain.table).to eq 'users'
+        expect(explain.type).to eq 'ALL'
+        expect(explain.possible_keys).to eq nil
+        expect(explain.key).to eq nil
+        expect(explain.key_len).to eq nil
+        expect(explain.ref).to eq nil
+        expect(explain.rows).to eq 155
+        expect(explain.extra).to eq nil
+        expect(explain.using_filesort?).to be false
+        expect(explain.using_where?).to be false
+        expect(explain.using_temporary?).to be false
+        expect(explain.using_index?).to be false
+      end
+    end
+  end
+
+  context 'given explain string with extra' do
+    let(:input) do
+      <<-EOS
++----+-------------+-------+--------+----------------------------------------------------------+
+| id | select_type | table | type   | Extra                                                    |
++----+-------------+-------+--------+----------------------------------------------------------+
+|  1 | SIMPLE      | tc    | ref    | Using where; Using index Using temporary; Using filesort |
++----+-------------+-------+--------+----------------------------------------------------------+
+1 row in set (0.00 sec)
+    EOS
+    end
+    subject { ExplainParser.new(input) }
+
+    describe '#call' do
+      it 'should ExplainParser::Explain' do
+        explain = subject.call[0]
+        expect(explain.extra).to be_truthy
+        expect(explain.using_filesort?).to be true
+        expect(explain.using_where?).to be true
+        expect(explain.using_temporary?).to be true
+        expect(explain.using_index?).to be true
+      end
+    end
+  end
+
+  context 'given explain string with multi line' do
+    let(:input) do
+      <<-EOS
++----+-------------+-------+--------+----------------------------------------------------------+
+| id | select_type | table | type   | Extra                                                    |
++----+-------------+-------+--------+----------------------------------------------------------+
+|  1 | SIMPLE      | tc    | ref    | Using where; Using index Using temporary; Using filesort |
+|  2 | SIMPLE      | tc    | ref    | Using where; Using index Using temporary; Using filesort |
+|  3 | SIMPLE      | tc    | ref    | NULL                                                     |
++----+-------------+-------+--------+----------------------------------------------------------+
+2 row in set (0.00 sec)
+    EOS
+    end
+    subject { ExplainParser.new(input) }
+
+    describe '#call' do
+      it 'should ExplainParser::Explain' do
+        explains = subject.call
+        expect(explains.size).to be 3
+      end
+    end
+  end
+
+  context 'given explain string with multi line' do
+    let(:input) do
+      <<-EOS
++----+-------------+-------+--------+----------------------------------------------------------+
+| id | select_type | table | type   | Extra                                                    |
++----+-------------+-------+--------+----------------------------------------------------------+
+|  1 | SIMPLE      | tc    | ref    | Using where; Using index Using temporary; Using filesort |
+|  2 | SIMPLE      | tc    | ref    | Using where; Using index Using temporary; Using filesort |
+|  3 | SIMPLE      | tc    | ref    | NULL                                                     |
++----+-------------+-------+--------+----------------------------------------------------------+
+2 row in set (0.00 sec)
+    EOS
+    end
+
+    describe '.call' do
+      it 'should ExplainParser::Explain' do
+        explains = ExplainParser.call(input)
+        expect(explains.size).to be 3
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+require 'explain_parser'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: explain_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ainame
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: |
+  Parser for result of EXPLAIN of MySQL
+  see: https://github.com/ainame/explain_parser
+email:
+- s.namai.09@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- explain_parser.gemspec
+- lib/explain_parser.rb
+- lib/explain_parser/version.rb
+- spec/lib/explain_parser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ainame/explain_parser
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Parser for result of EXPLAIN of MySQL
+test_files:
+- spec/lib/explain_parser_spec.rb
+- spec/spec_helper.rb