activerecord-simple_explain 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/vendor
+*~

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 wtnabe
+
+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,68 @@
+# ActiveRecord::SimpleExplain
+
+## Implemented
+
+`ActiveRecord::Relation.explain()` method for ActiveRecord 3.0.x and 3.1.x and 3.2.x with SQLite
+
+## Not Implemented
+
+auto explain
+
+## Supported Versions
+
+ * Ruby 1.8.7+
+ * ActiveRecord 3.0.x - 3.2.x
+
+## Supported Adapters
+
+ * SQLite
+ * MySQL
+ * PostgreSQL
+
+## Depending
+
+ * [cldwalker/hirb](https://github.com/cldwalker/hirb)
+ * [miaout17/hirb-unicode](https://github.com/miaout17/hirb-unicode)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-simple_explain'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-simple_explain
+
+## Usage
+
+just call ActiveRecord::Relation.explain()
+
+ex)
+
+    Blog.joins(:comments).explain
+
+on Rails console ( Rails 3.2 + SQLite Adapter )
+
+    development(main):001:0> Blog.joins(:comments).explain
+       (0.1ms)  explain query plan SELECT "blogs".* FROM "blogs" INNER JOIN "comments" ON "comments"."blog_id" = "blogs"."id"
+    +------------------------------------------------------------------+------+-------+----------+
+    | detail                                                           | from | order | selectid |
+    +------------------------------------------------------------------+------+-------+----------+
+    | SCAN TABLE comments (~1000000 rows)                              | 1    | 0     | 0        |
+    | SEARCH TABLE blogs USING INTEGER PRIMARY KEY (rowid=?) (~1 rows) | 0    | 1     | 0        |
+    +------------------------------------------------------------------+------+-------+----------+
+    2 rows in set
+    => nil
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/activerecord-simple_explain.gemspec

@@ -0,0 +1,28 @@
+# -*- mode: ruby; coding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/simple_explain/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-simple_explain"
+  spec.version       = ActiveRecord::SimpleExplain::VERSION
+  spec.authors       = ["wtnabe"]
+  spec.email         = ["wtnabe@gmail.com"]
+  spec.description   = %q{explain method for ActiveRecord 3.0.x and 3.1.x}
+  spec.summary       = ""
+  spec.homepage      = "https://github.com/wtnabe/activerecord-simple_explain"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.required_ruby_version = ">= 1.8.7"
+
+  spec.add_runtime_dependency "activerecord", "< 4.0", ">= 3.0"
+  spec.add_runtime_dependency "hirb-unicode"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/active_record/simple_explain.rb

@@ -0,0 +1,61 @@
+require 'hirb-unicode'
+
+module ActiveRecord
+  class SimpleExplain
+    #
+    # [param] String adapter
+    #
+    def initialize(adapter, sql)
+      #
+      # {class => filename}
+      #
+      @adapters = {}
+      init_adapters
+
+      @sql      = sql
+      load_adapter(adapter)
+    end
+    attr_reader :sql
+
+    def init_adapters
+      %w(SQLite3Adapter sqlite3_adapter
+         PostgreSQLAdapter postgresql_adapter).each_cons(2) { |k, v|
+        add_adapter(k, v)
+      }
+    end
+
+    def add_adapter(klass, filename)
+      @adapters[klass] = filename
+    end
+
+    def load_adapter(adapter)
+      require File.expand_path(File.dirname(__FILE__) + "/simple_explain/connection_adapters/#{filename(adapter)}")
+      self.class_eval {
+        include ActiveRecord::SimpleExplain.const_get(adapter)
+      }
+    end
+
+    def filename(adapter)
+      if @adapters.has_key? adapter
+        @adapters[adapter]
+      else
+        adapter.underscore
+      end
+    end
+
+    def display
+      puts format(result)
+    end
+
+    #
+    # [return] Object ( Adapter::Result or Array )
+    #
+    def result
+      ActiveRecord::Base.connection.execute("#{statement} #{sql}")
+    end
+  end
+end
+
+Dir.glob(File.dirname(__FILE__) + '/simple_explain/*.rb').each {|f|
+  require f.sub(/\.rb/, '')
+}

data/lib/active_record/simple_explain/connection_adapters/adapter_interface.rb

@@ -0,0 +1,15 @@
+module ActiveRecord
+  class SimpleExplain
+    module AdapterInterface
+      class NotImplememted < StandardError; end
+
+      def format(result)
+        raise NotImplememted
+      end
+
+      def statement
+        raise NotImplememted
+      end
+    end
+  end
+end

data/lib/active_record/simple_explain/connection_adapters/mysql_adapter.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/adapter_interface')
+
+module ActiveRecord
+  class SimpleExplain
+    module MysqlAdapter
+      include AdapterInterface
+
+      #
+      # [param]  Object
+      # [return] String
+      #
+      def format(result)
+        Hirb::Helpers::AutoTable.render(pre_format(result))
+      end
+
+      #
+      # [param]  Object
+      # [return] Array
+      #
+      def pre_format(result)
+        result.to_a.map {|r|
+          Hash[*result.fields.zip(r).flatten]
+        }
+      end
+
+      #
+      # [return] String
+      #
+      def statement
+        'explain'
+      end
+    end
+  end
+end
+

data/lib/active_record/simple_explain/connection_adapters/postgresql_adapter.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/adapter_interface')
+
+module ActiveRecord
+  class SimpleExplain
+    module PostgreSQLAdapter
+      include AdapterInterface
+
+      #
+      # [param]  Object
+      # [return] String
+      #
+      def format(result)
+        result.values.join("\n")
+      end
+
+      #
+      # [return] String
+      #
+      def statement
+        'explain'
+      end
+    end
+  end
+end

data/lib/active_record/simple_explain/connection_adapters/sqlite3_adapter.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/adapter_interface')
+
+module ActiveRecord
+  class SimpleExplain
+    module SQLite3Adapter
+      include AdapterInterface
+
+      #
+      # [param] Array
+      # [return] String
+      #
+      def format(result)
+        Hirb::Helpers::AutoTable.render(pre_format(result))
+      end
+
+      #
+      # [param] Array
+      # [return] Hash
+      #
+      def pre_format(result)
+        result.map {|e|
+          Hash[*e.select {|k, v|
+                 k.is_a? String
+               }.flatten]
+        }
+      end
+
+      #
+      # [return] String
+      #
+      def statement
+        'explain query plan'
+      end
+    end
+  end
+end

data/lib/active_record/simple_explain/relation.rb

@@ -0,0 +1,25 @@
+module ActiveRecord
+  eager_autoload do
+    autoload :Relation
+  end
+
+  class Relation
+    alias_method :explain_org, :explain if method_defined? :explain
+
+    def explain
+      adapter = ActiveRecord::Base.connection.class.to_s.split(/::/).last
+
+      exp = proc { SimpleExplain.new(adapter, to_sql).display }
+
+      if method_defined? :explain_org
+        if adapter == 'sqlite3'
+          exp.call
+        else
+          explain_org
+        end
+      else
+        exp.call
+      end
+    end
+  end
+end

data/lib/active_record/simple_explain/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  class SimpleExplain
+    VERSION = "0.0.1"
+  end
+end

data/lib/activerecord-simple_explain.rb

@@ -0,0 +1 @@
+require "active_record/simple_explain"

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-simple_explain
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- wtnabe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: hirb-unicode
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: explain method for ActiveRecord 3.0.x and 3.1.x
+email:
+- wtnabe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-simple_explain.gemspec
+- lib/active_record/simple_explain.rb
+- lib/active_record/simple_explain/connection_adapters/adapter_interface.rb
+- lib/active_record/simple_explain/connection_adapters/mysql_adapter.rb
+- lib/active_record/simple_explain/connection_adapters/postgresql_adapter.rb
+- lib/active_record/simple_explain/connection_adapters/sqlite3_adapter.rb
+- lib/active_record/simple_explain/relation.rb
+- lib/active_record/simple_explain/version.rb
+- lib/activerecord-simple_explain.rb
+homepage: https://github.com/wtnabe/activerecord-simple_explain
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1464302755730536436
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ''
+test_files: []