activerecord-explainer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e63c897891645df93cbd00ad44dad995b6cf7ee1420c815959eefefcc91a861
+  data.tar.gz: 3f9578671205fa47e3f3eb7ed12ca61dcfbd67843610c162f87240f8799e2ce1
+SHA512:
+  metadata.gz: b9370f82fdfab38ddfcab8de3464fed927801af45fca0c93ca274cc115212c8abe7afb3f7a7a67aff19a6ec26acd747ba32629c8c7747fa9cb0ba1346bf3c400
+  data.tar.gz: 47aa0283bf3f5ed443c681dd28085b20b3eb50473751c0fde419cd01ab37490b9680849078dfbaa47bf96f1635e44b8279fe4920a7e2d607b3a84d957f8b5a86

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+AllCops:
+  TargetRubyVersion: 2.2
+
+Metrics:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    activerecord-explainer (0.1.0)
+      activerecord (>= 5.2)
+      activesupport (>= 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    ast (2.4.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    minitest (5.11.3)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.68.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-explainer!
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Yoshiyuki Hirano
+
+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,38 @@
+# ActiveRecord::Explainer
+
+activerecord-explainer puts `SQL EXPLAIN` of every queries to **development** log.
+
+You can check every SQL EXPLAIN from development log, without :hand: executions.
+
+## Usage
+
+It's no configuration, and you can puts SQL EXPLAIN of every queries to logs.
+
+![](https://github.com/yhirano55/activerecord-explainer/blob/master/images/capture.png?raw=true)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-explainer', group: :development
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-explainer
+
+## How it work?
+
+- This gem subscribes `sql.active_record` event provided by the [Active Support instrumentation API](https://guides.rubyonrails.org/active_support_instrumentation.html).
+- Subscriber handles payload, and execute EXPLAIN from `ActiveRecord::Base`.
+
+Please check the [implementation](https://github.com/yhirano55/activerecord-explainer/blob/master/lib/activerecord/explainer/subscriber.rb), if you interested in.
+
+## License
+
+[MIT License](https://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/activerecord-explainer.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('./lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/explainer/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'activerecord-explainer'
+  s.version       = ActiveRecord::Explainer::VERSION
+  s.authors       = ['Yoshiyuki Hirano']
+  s.email         = ['yhirano@me.com']
+  s.homepage      = 'https://github.com/yhirano55/activerecord-explainer'
+  s.summary       = %(activerecord-explainer puts SQL EXPLAIN of every queries to development log)
+  s.description   = s.summary
+  s.license       = 'MIT'
+  s.files         = Dir.chdir(File.expand_path('.', __dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features|images)/})
+    end
+  end
+
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 2.2.2'
+  s.required_rubygems_version = '>= 1.8.11'
+
+  s.add_dependency 'activerecord', '>= 5.2'
+  s.add_dependency 'activesupport', '>= 5.2'
+
+  s.add_development_dependency 'bundler', '~> 2.0'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'activerecord/explainer'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/activerecord-explainer.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'activerecord/explainer'

data/lib/activerecord/explainer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+require_relative 'explainer/config'
+require_relative 'explainer/version'
+
+begin
+  require 'rails'
+  require_relative 'explainer/railtie'
+rescue LoadError
+  nil
+end
+
+module ActiveRecord
+  module Explainer # :nodoc:
+    def self.configure
+      yield config
+    end
+
+    def self.config
+      @config ||= Config.new
+    end
+  end
+end

data/lib/activerecord/explainer/config.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module ActiveRecord
+  module Explainer
+    class Config # :nodoc:
+      attr_accessor :logger
+
+      def initialize
+        @logger = Logger.new(STDOUT)
+      end
+    end
+  end
+end

data/lib/activerecord/explainer/railtie.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Explainer
+    class Railtie < ::Rails::Railtie # :nodoc:
+      config.after_initialize do
+        ActiveSupport.on_load :active_record do
+          require_relative 'subscriber'
+
+          ActiveRecord::Explainer.config.logger = Rails.logger
+          ActiveRecord::Explainer::Subscriber.attach_to :active_record
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/explainer/subscriber.rb

@@ -0,0 +1,51 @@
+require 'active_support/subscriber'
+
+module ActiveRecord
+  module Explainer
+    class Subscriber < ActiveSupport::Subscriber # :nodoc:
+      def sql(event)
+        payload = event.payload
+        return if ignore_payload?(payload) || !ActiveRecord::Base.connection.supports_explain?
+
+        logger.debug exec_explain(sql: payload[:sql], binds: payload[:binds])
+      end
+
+      private
+
+      IGNORED_PAYLOADS = %w[SCHEMA EXPLAIN].freeze
+      EXPLAINED_SQLS = /\A\s*(with|select|update|delete|insert)\b/i.freeze
+
+      def ignore_payload?(payload)
+        payload[:cached] ||
+          IGNORED_PAYLOADS.include?(payload[:name]) ||
+          payload[:sql] !~ EXPLAINED_SQLS
+      end
+
+      def exec_explain(sql:, binds:)
+        msg = +"EXPLAIN for: #{sql}"
+        unless binds.empty?
+          msg << ' '
+          msg << binds.map { |attr| render_bind(attr) }.inspect
+        end
+        msg << "\n"
+        msg << ActiveRecord::Base.connection.explain(sql, binds)
+        msg
+      end
+
+      def render_bind(attr)
+        value =
+          if attr.type.binary? && attr.value
+            "<#{attr.value_for_database.to_s.bytesize} bytes of binary data>"
+          else
+            ActiveRecord::Base.connection.type_cast(attr.value_for_database)
+          end
+
+        [attr.name, value]
+      end
+
+      def logger
+        ActiveRecord::Explainer.config.logger
+      end
+    end
+  end
+end

data/lib/activerecord/explainer/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Explainer
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-explainer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshiyuki Hirano
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: activerecord-explainer puts SQL EXPLAIN of every queries to development
+  log
+email:
+- yhirano@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-explainer.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord-explainer.rb
+- lib/activerecord/explainer.rb
+- lib/activerecord/explainer/config.rb
+- lib/activerecord/explainer/railtie.rb
+- lib/activerecord/explainer/subscriber.rb
+- lib/activerecord/explainer/version.rb
+homepage: https://github.com/yhirano55/activerecord-explainer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.11
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: activerecord-explainer puts SQL EXPLAIN of every queries to development log
+test_files: []