query-analyzer 0.1.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/CHANGELOG.rdoc

@@ -0,0 +1,10 @@
+= Changelog
+
+== Version 0.1.1
+
+* using jeweler for managing and releasing query-analyzer
+
+== Version 0.1.0
+
+* Turned it in to a gem. 
+* Changed the selection logic such that it shows all queries again. 

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ludwig Bratke
+
+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.rdoc

@@ -0,0 +1,108 @@
+= Query Analyzer Plugin for MySQL on Rails
+
+A gem version of the Query Analyzer plugin. Modified by Todd Tyree.
+
+MODIFIED by John Eberly originally take from http://svn.nfectio.us
+
+The Query Analyzer plugin will expand the usability of your log files
+by providing query analysis using the MySQL query execution plan. Each SQL
+select query will be 'EXPLAIN'ed and added to the log files right below
+the original query.
+
+Using this plugin and a good understanding of the results, you will be 
+able to analyze and optimize the queries your application is making.
+
+Refer to http://www.mysql.org/doc/refman/5.0/en/explain.html for more
+information on understanding the results. 
+
+= Compatibility 
+
+It only works with MySQL at the moment. 
+
+= Installation
+
+  sudo gem install git://github.com/tatyree/query-analyzer.git
+  
+In your environment.rb, *after* the Rails::Initializer block:
+
+  require 'query_analyzer'
+  
+Please <b>note the underscore!</b> <tt>require 'query-analyzer'</tt> won't find it. 
+
+= Example Use
+
+Here is a real life usage of the plugin that detected the omission of indexes on
+a table. In this case, it was a join table and the keys didn't have indexes (silly me!).
+Names have been changed to protect the innocent (and make it fit 80 columns)
+
+  # development.log
+
+  P Load (0.008669)
+   => SELECT p.* FROM p INNER JOIN d ON p.id = d.p_id WHERE (d.p_id = 2 AND ((d.type = 'P'))) 
+
+  Analyzing P Load
+   
+  select_type | key_len | type   | Extra       | id | possible_keys | rows | table  | ref    | key    
+  ----------------------------------------------------------------------------------------------------
+  SIMPLE      |         | ALL    | Using where | 1  |               | 74   |    d   |        |        
+  SIMPLE      | 4       | eq_ref | Using where | 1  | PRIMARY       | 1    |    p   | d.p_id | PRIMARY
+
+
+= Analyze the results
+
+Looking at the results of the execution plan, we can see that the lookup in
+the d table is missing an index (possible_keys=null) and performed a full 
+table scan (type=ALL) to satisfy the WHERE condition. In this case, there was only one 
+row that matched the condition in the table, but MySQL still had to search all 74 rows 
+in the table to find it, a key indicator of a missing
+or malformed index(es). Once it has pulled all the records to satisfy the WHERE, it then
+starts the p table join. This time, it was able to match d.p_id to p.id using
+the PRIMARY key on the p table. The type=eq_ref indicates a 1 to 1 match against a primary 
+or unique column.
+
+Lets add some indexes to the join table and see if we can cut that full table scan down in the
+number of rows it needs to search.
+
+  #> script/generate Migration AddIndexesToD
+
+  # file: 005_add_indexes_to_d
+  class AddIndexesToD < ActiveRecord::Migration
+    def self.up
+      add_index :d, [ :p_id, :type ]
+      add_index :d, :type
+    end
+
+    def self.remove
+      remove_index :d, [ :p_id, :type ]
+      remove_index :d, :type  
+    end
+  end
+
+
+Now that we have an index on the foreign_key column and type, lets re-run the query and
+see if we got rid of that full table scan.
+
+  # development.log
+
+  P Load (0.009011)   
+   => SELECT p.* FROM p INNER JOIN d ON p.id = d.p_id WHERE (d.p_id = 2 AND ((d.type = 'P'))) 
+
+  Analyzing P Load
+   
+  select_type | key_len | type   | Extra       | id | possible_keys                  | rows | table | ref    | key                             
+  ------------------------------------------------------------------------------------------------------------------------------
+  SIMPLE      | 255     | ref    | Using where | 1  | d_p_id_type_index,d_type_index | 1    |   d   | const  | d_p_id_type_index
+  SIMPLE      | 4       | eq_ref | Using where | 1  | PRIMARY                        | 1    |   p   | d.p_id | PRIMARY                         
+
+Okay. Now MySQL is using an index satisfy the WHERE condition. Using the index, it was able to
+find the single row that matched, preventing the full table scan.
+
+
+Credits:
+The extension of the Array class for printing the columnized records was originally
+written by Peter Cooper who adapted it from Courtenay from #caboose.
+
+http://www.rubyinside.com/columnized-text-datasets-in-rails-71.html
+http://habtm.com/articles/2006/06/10/pretty-tables-for-ruby-objects
+
+Released under the MIT license (download your own if you need it)

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "query-analyzer"
+  gem.homepage = "http://github.com/eecnee/query-analyzer"
+  gem.license = "MIT"
+  gem.summary = %q{Run explain on all the sql queries rails generates.}
+  gem.description = %q{Run explain on all the sql queries rails generates.}
+  gem.email = %q{todd@snappl.co.uk}
+  gem.authors = ["John Eberly and Todd Tyree"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "query-analyzer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/query_analyzer.rb

@@ -0,0 +1,56 @@
+class Array
+  protected
+    def qa_columnized_row(fields, sized)
+      row = []
+      fields.each_with_index do |f, i|
+        row << sprintf("%0-#{sized[i]}s", f.to_s)
+      end
+      row.join(' | ')
+    end
+
+  public
+
+  def qa_columnized
+    sized = {}
+    self.each do |row|
+      row.values.each_with_index do |value, i|
+        sized[i] = [sized[i].to_i, row.keys[i].length, value.to_s.length].max
+      end
+    end
+
+    table = []
+    table << qa_columnized_row(self.first.keys, sized)
+    table << '-' * table.first.length
+    self.each { |row| table << qa_columnized_row(row.values, sized) }
+    table.join("\n   ") # Spaces added to work with format_log_entry
+  end
+end
+
+
+# TODO: Postgres? Oracle? Firebird? 
+module ActiveRecord
+  module ConnectionAdapters
+    class MysqlAdapter < AbstractAdapter
+      private
+        alias_method :select_without_analyzer, :select
+        
+        def select(sql, name = nil)
+          query_results = select_without_analyzer(sql, name)
+          
+          # I went back to showing all queries.  This makes for a heavy log file, but you pick up 
+          # things like filesorts (which the latest plugin wouldn't have caught).
+          
+          if @logger and @logger.level == Logger::DEBUG
+            @logger.debug(
+              ActiveRecord::Base.silence do
+                format_log_entry("\033[1;34mAnalyzing #{name}  \033[0m\n\n",
+                  "\033[1;34m#{select_without_analyzer("explain #{sql}", name).qa_columnized}  \033[0m\n\n"
+                ) 
+              end
+            ) if sql =~ /^select/i
+          end          
+          query_results
+        end
+    end
+  end
+end

data/query-analyzer.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{query-analyzer}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Eberly and Todd Tyree"]
+  s.date = %q{2011-04-02}
+  s.description = %q{Run explain on all the sql queries rails generates.}
+  s.email = %q{todd@snappl.co.uk}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "CHANGELOG.rdoc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/query_analyzer.rb",
+    "query-analyzer.gemspec",
+    "test/helper.rb",
+    "test/test_query-analyzer.rb"
+  ]
+  s.homepage = %q{http://github.com/eecnee/query-analyzer}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Run explain on all the sql queries rails generates.}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_query-analyzer.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'query-analyzer'
+
+class Test::Unit::TestCase
+end

data/test/test_query-analyzer.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestQueryAnalyzer < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: query-analyzer
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- John Eberly and Todd Tyree
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-02 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: shoulda
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id004
+  prerelease: false
+description: Run explain on all the sql queries rails generates.
+email: todd@snappl.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- CHANGELOG.rdoc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/query_analyzer.rb
+- query-analyzer.gemspec
+- test/helper.rb
+- test/test_query-analyzer.rb
+has_rdoc: true
+homepage: http://github.com/eecnee/query-analyzer
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Run explain on all the sql queries rails generates.
+test_files: 
+- test/helper.rb
+- test/test_query-analyzer.rb