pgexplain 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Ramon Salvadó
+
+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,62 @@
+= pgexplain
+
+Authors:: Ramon Salvadó <rsalvado@gnuine.com>
+
+* RubyForge_Project_Page[http://rubyforge.org/projects/pgexplain/]
+* Github Project [http://github.com/marcus-wyatt/pgexplain]
+
+Any questions/comments can be addressed to Ramon Salvadó <rsalvado@gnuine.com>
+
+This Rails plugin shows the output, in your application logs,  of applying "Explain" or "Explain Analyze" to the select queries of your rails application.
+It should be used with a PostgreSQL database.
+
+== Dependencies
+
+Needs to have the pg gem installed:
+
+<code>sudo gem install pg</code>
+
+== Installation
+
+To install as a gem:
+
+<code>sudo gem install pgexplain</code>
+
+To install the plugin:
+
+Github:
+<code>script/plugin install svn://rubyforge.org/var/svn/pgexplain</code>
+
+Original:
+<code>script/plugin install svn://rubyforge.org/var/svn/pgexplain</code>
+
+== Features
+
+- By default works only in development environment and doing just explains.
+- Colors can be turned on off (this is useful if you want to look the logs later from the log file).
+- Instead of doing explains it can be configured to do explain analyze.
+- It can be disabled and enabled (this is useful if you want to turn it off in the console, for example).
+
+== Configuration
+
+- In you environment.rb
+
+ PgExplain::configure :color => false, :analyze = true
+
+- To disable the plugin
+
+ PgExplain::disable
+
+- To enable the plugin
+
+ PgExplain::enable
+
+== Needed things
+
+* PostgreSQL database
+* postgres gem: sudo gem install postgres
+
+== Acknowledgments:
+
+- Bob Silva for his Query Analyzer plugin from which I borrowed some code/concepts.
+- Marcus Wyatt for packaging the into a gem.

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "pgexplain"
+    gem.summary = %Q{Outputs "Explain" or "Explain Analyze" in your developement application log.}
+    gem.description = %Q{The Rails gem shows the output, in your application logs,  of applying "Explain" or "Explain Analyze" to the select queries of your rails application.}
+    gem.email = "marcus.wyatt@visfleet.com, rsalvado@gnuine.com"
+    gem.homepage = "http://github.com/marcus-wyatt/pgexplain"
+    gem.authors = ["Ramon Salvadó", "Marcus Wyatt"]
+    # gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem.add_development_dependency "cucumber", ">= 0"
+    gem.add_dependency 'pg', ">= 0.8.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1,5 @@
+require 'pg_explain'
+require 'adapter_extensions'
+
+PgExplain::configure :color => true, :analyze => false
+PgExplain::enable if Rails.evn == "development" # Get Ready for Rails 3.0 (RAILS_ENV deprecated.)

data/lib/adapter_extensions.rb

@@ -0,0 +1,21 @@
+module ActiveRecord #:nodoc:
+  module ConnectionAdapters #:nodoc:
+    class PostgreSQLAdapter < AbstractAdapter #:nodoc:
+      private
+        alias_method :select_without_analyzer, :select
+    
+        def select(sql, name = nil)
+          query_results = select_without_analyzer(sql, name)
+          if @logger and Pg_explain::enabled? and @logger.level <= Logger::DEBUG
+            @logger.debug(
+              @logger.silence do
+                message = Pg_explain::format(select_without_analyzer("#{Pg_explain::method} #{sql}", name))
+                format_log_entry("#{Pg_explain::method} #{name}\n", message)
+              end
+            ) if sql =~ /^select/i
+          end          
+          query_results
+        end
+    end
+  end
+end

data/lib/pg_explain.rb

@@ -0,0 +1,51 @@
+# This module contains:
+# - Activation/disactivation methods
+# - Configuration methods
+# - Output formatting methods
+module PgExplain
+  mattr_accessor :color
+  mattr_accessor :analyze
+  
+  @@color   = false
+  @@analyze = false
+  @@enable  = false
+  
+  # Activates the plugin
+  def self.enable
+    @@enable = true
+  end
+  
+  # Disables the plugin
+  def self.disable
+    @@enable = false
+  end
+  
+  # Check if the plugin is enabled
+  def self.enabled?
+    @@enable
+  end
+  
+  # To setup the configuration options
+  def self.configure(options = {})
+    @@color   ||= options[:color]
+    @@analyze ||= options[:analyze]
+  end
+  
+  # Returns "Explain" or "Explain Analyze"
+  def self.method
+    ("Explain Analyze" if analyze) || "Explain"
+  end
+  
+  # Formats the results of the explain query
+  def self.format(message)
+    formatted_message = "\n" + message.collect { |line| "  " + colorize(line["QUERY PLAN"]) }.join("\n") + "\n"
+    color ? "\033[01;30m#{formatted_message}\033[00m" : formatted_message
+  end
+  
+  private
+  
+  # Colorizes sequential scans
+  def self.colorize(line)
+    color ? line.gsub("Seq Scan", "\033[01;31mSeq Scan\033[01;30m") : line
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: pgexplain
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Ramon Salvad\xC3\xB3"
+- Marcus Wyatt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-08 00:00:00 +13:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: pg
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.0
+    version: 
+description: The Rails gem shows the output, in your application logs,  of applying "Explain" or "Explain Analyze" to the select queries of your rails application.
+email: marcus.wyatt@visfleet.com, rsalvado@gnuine.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/adapter_extensions.rb
+- lib/pg_explain.rb
+has_rdoc: true
+homepage: http://github.com/marcus-wyatt/pgexplain
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Outputs "Explain" or "Explain Analyze" in your developement application log.
+test_files: []
+