g00k-explain-query 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-07-16
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/explain-query.rb
+lib/explain-query/explain-query.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_explain-query.rb

data/README.rdoc

@@ -0,0 +1,65 @@
+== DESCRIPTION:
+
+The explain-query gem allows you to 'EXPLAIN' your ActiveRecord::Base#find calls from the safety of your Rails console.
+
+== FEATURES/PROBLEMS:
+
+The library adds the #explain method to ActiveRecord::Base (ie. all your models.)
+
+== SYNOPSIS:
+
+Here's a quick sample:
+
+  >> Post.explain do
+  ?> Post.first
+  >> end
+  SELECT * FROM `posts`  LIMIT 1
+   select_type | key_len | table | id | possible_keys | type | Extra | rows | ref | key
+   ------------------------------------------------------------------------------------
+   SIMPLE      |         | posts | 1  |               | ALL  |       | 6    |     |
+
+  => #<Post id: 2, title: "First Post", content: "some content\r\n", created_at: "2009-07-07 09:19:46", updated_at: "2009-07-17 14:15:01", permalink: "first-post">
+
+== REQUIREMENTS:
+
+This library obviously requires the ActiveRecord library.
+
+== INSTALL:
+
+To install, simply run:
+
+  sudo gem install explain-query
+
+and then require it from your Rails console:
+
+  $ ./script/console
+  >> require 'explain-query'
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME full name
+
+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.
+
+== CREDITS:
+
+This gem is pretty much just a gemified version of Bob Silva's (http://nfectio.us/) query-analyzer Rails plugin, with the addition of the block syntax instead of writing output to the logfile. Thanks!

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/explain-query'
+
+Hoe.plugin :newgem
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'explain-query' do
+  self.developer 'Gustav Paul', 'gustav@rails.co.za'
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }

data/lib/explain-query.rb

@@ -0,0 +1,13 @@
+$:.unshift File.dirname(__FILE__)
+
+module ExplainQuery
+  VERSION = '0.0.1'
+end
+
+if defined?(ActiveRecord::ConnectionAdapters::MysqlAdapter)
+  require 'explain-query/explain-query' 
+
+  Array.send                                           :include, ExplainQuery::ArrayExt
+  ActiveRecord::ConnectionAdapters::MysqlAdapter.send  :include, ExplainQuery::MysqlAdapterExt
+  ActiveRecord::Base.send                              :extend,  ExplainQuery::Watcher
+end

data/lib/explain-query/explain-query.rb

@@ -0,0 +1,63 @@
+module ExplainQuery
+  module ArrayExt
+    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
+
+  module Watcher
+    def explain
+      raise(ArgumentError, "No block given") if !block_given?
+      begin
+        ActiveRecord::ConnectionAdapters::MysqlAdapter.send(:alias_method, :select_without_explain, :select)
+        ActiveRecord::ConnectionAdapters::MysqlAdapter.send(:alias_method, :select, :select_with_explain)
+        result = yield
+      ensure
+        ActiveRecord::ConnectionAdapters::MysqlAdapter.send(:alias_method, :select_with_explain, :select)
+        ActiveRecord::ConnectionAdapters::MysqlAdapter.send(:alias_method, :select, :select_without_explain)
+      end
+
+      result
+    end
+  end
+
+  module MysqlAdapterExt
+    private
+
+    def select_with_explain(sql, name = nil)
+      query_results = select_without_explain(sql, name)
+
+      if sql =~ /^select/i
+        output = ActiveRecord::Base.silence do  
+          explain_results = select_without_explain("explain #{sql}", name)
+          format_log_entry("\033[1;34m#{sql} \033[0m\n", "#{explain_results.qa_columnized}\n")
+        end
+        puts output
+      end
+
+      query_results
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/explain-query.rb'}"
+puts "Loading explain-query gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_explain-query.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestExplainQuery < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/explain-query'

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: g00k-explain-query
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Gustav Paul
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-18 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.15"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: diff-lcs
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.2
+    version: 
+description: ExplainQuery let's you see the output of Mysql's EXPLAIN command from your Rails console.
+email: gustav@rails.co.za
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- History.txt
+- README.rdoc
+- Rakefile
+- Manifest.txt
+- lib/explain-query.rb
+- lib/explain-query/explain-query.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_explain-query.rb
+has_rdoc: false
+homepage: http://github.com/g00k/explain-query
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: explain-query
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: ExplainQuery let's you see the output of Mysql's EXPLAIN command from your Rails console.
+test_files: []
+