active_record_json_explain 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: edb1f284ede6aaa6bcb2b0e879125cbc55ec4deacad65968c2aa7821fc315e24
+  data.tar.gz: e6684d5f22de628426a19350988aede20352da0b933133ad1c973ea9d2e2deac
+SHA512:
+  metadata.gz: 757c8c11dd1663b8aeefe9bc3195d94f2b34701f9cf6616928d075b0ce1b2f3b08e476c21fccf062de39332cffff6b36f418fd38766ffcd7c65567ca71029ea5
+  data.tar.gz: 6e68e87df83116b0b5a19adc140d790a3c1fded56a0796e9fbe26b8feb90f7637de7b923830b4b9e4d4a5668d921436db59f348769b01cbffaa9da6ca307a927

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,33 @@
+AllCops:
+  TargetRubyVersion: 2.7.0
+  Exclude:
+    - './active_record_json_explain.gemspec'
+    - 'vendor/**/*'
+
+Metrics/ClassLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Layout/LineLength:
+  Max: 100
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,20 @@
+---
+  language: ruby
+  cache: bundler
+  services:
+    - mysql
+    - postgresql
+  rvm:
+    - 2.7.0
+    - 2.6.5
+  os:
+    - linux
+  before_install:
+    - gem install bundler -v 2.1.2
+  gemfile:
+    - gemfiles/active_record5.gemfile
+    - gemfiles/active_record6.gemfile
+  before_script:
+    - psql -c "CREATE USER sample WITH PASSWORD 'password';" -U postgres
+    - psql -c "CREATE DATABASE sample;" -U postgres
+    - bin/db_setup

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at 17684091+Madogiwa0124@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_record_scope_analyzer.gemspec
+gemspec
+
+gem 'mysql2'
+gem 'pg'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop'

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    active_record_json_explain (0.1.0)
+      activerecord (>= 5.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activerecord (6.0.2.2)
+      activemodel (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    ast (2.4.0)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    minitest (5.14.0)
+    mysql2 (0.5.3)
+    parallel (1.19.1)
+    parser (2.7.0.5)
+      ast (~> 2.4.0)
+    pg (1.2.3)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.80.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_record_json_explain!
+  mysql2
+  pg
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Madogiwa
+
+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,187 @@
+# ActiveRecordJsonExplain
+[![Build Status](https://travis-ci.com/Madogiwa0124/active_record_json_explain.svg?branch=master)](https://travis-ci.com/Madogiwa0124/active_record_json_explain)
+
+This gem extends `ActiveRecord::Relation#explain` to make it possible to get EXPLAIN in JSON format.(Only supported MySQL and Postgresql)
+
+Supports ActiveRecord 5 latest and 6 latest.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_json_explain', require: false
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install active_record_json_explain
+
+## Usage
+
+If you use this gem, you can get the result in JSON format by `explain(json: true)`.
+
+``` ruby
+# NOTE:
+# if use postgresql adapter, Rails run `require 'activerecord/lib/active_record/connection_adapters/postgresql/database_statement'` when establish_connection runs.
+# So run `require 'active_record_json_explain'` after `establish_connection`.
+require 'active_record_json_explain'
+
+class Sample < ActiveRecord::Base
+  scope :with_title, -> { where(title: 'hoge') }
+end
+
+# --- MySql ---
+Sample.with_title.explain
+=> EXPLAIN for: SELECT `samples`.* FROM `samples` WHERE `samples`.`title` = 'hoge'
++----+-------------+---------+------------+------+---------------+------+---------+------+------+----------+-------------+
+| id | select_type | table   | partitions | type | possible_keys | key  | key_len | ref  | rows | filtered | Extra       |
++----+-------------+---------+------------+------+---------------+------+---------+------+------+----------+-------------+
+|  1 | SIMPLE      | samples | NULL       | ALL  | NULL          | NULL | NULL    | NULL |    1 |    100.0 | Using where |
++----+-------------+---------+------------+------+---------------+------+---------+------+------+----------+-------------+
+1 row in set (0.00 sec)
+
+Sample.with_title.explain(json: true)
+=> EXPLAIN for: SELECT `samples`.* FROM `samples` WHERE `samples`.`title` = 'hoge'
++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| EXPLAIN                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| {
+  "query_block": {
+    "select_id": 1,
+    "cost_info": {
+      "query_cost": "0.35"
+    },
+    "table": {
+      "table_name": "samples",
+      "access_type": "ALL",
+      "rows_examined_per_scan": 1,
+      "rows_produced_per_join": 1,
+      "filtered": "100.00",
+      "cost_info": {
+        "read_cost": "0.25",
+        "eval_cost": "0.10",
+        "prefix_cost": "0.35",
+        "data_read_per_join": "1K"
+      },
+      "used_columns": [
+        "id",
+        "category",
+        "title",
+        "body"
+      ],
+      "attached_condition": "(`sample`.`samples`.`title` = 'hoge')"
+    }
+  }
+} |
++------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+1 row in set (0.00 sec)
+
+#--- Postgresql ---
+Sample.with_title.explain
+=> EXPLAIN for: SELECT "samples".* FROM "samples" WHERE "samples"."title" = $1 [["title", "hoge"]]
+                        QUERY PLAN
+----------------------------------------------------------
+Seq Scan on samples  (cost=0.00..11.62 rows=1 width=556)
+  Filter: ((title)::text = 'hoge'::text)
+(2 rows)
+
+Sample.with_title.explain(json: true)
+=> EXPLAIN for: SELECT "samples".* FROM "samples" WHERE "samples"."title" = $1 [["title", "hoge"]]
+                                                                                                                                                    QUERY PLAN
+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+[
+  {
+    "Plan": {
+      "Node Type": "Seq Scan",
+      "Parallel Aware": false,
+      "Relation Name": "samples",
+      "Alias": "samples",
+      "Startup Cost": 0.00,
+      "Total Cost": 11.62,
+      "Plan Rows": 1,
+      "Plan Width": 556,
+      "Filter": "((title)::text = 'hoge'::text)"
+    }
+  }
+]
+(1 row)
+```
+
+## Development
+
+Use docker-compose to build mysql and postgres containers for development.
+
+```
+$ docker-compose up -d
+Creating active_record_json_explain_mysql_1    ... done
+Creating active_record_json_explain_postgres_1 ... done
+
+$ docker-compose ps
+                Name                               Command              State                 Ports
+-----------------------------------------------------------------------------------------------------------------
+active_record_json_explain_mysql_1      docker-entrypoint.sh mysqld     Up      0.0.0.0:3306->3306/tcp, 33060/tcp
+active_record_json_explain_postgres_1   docker-entrypoint.sh postgres   Up      0.0.0.0:5432->5432/tcp
+```
+
+run `bin/db_setup` and create sample database and table for MySQL, Postgresql.
+
+```
+$ bin/db_setup
+=== START DB SETUP ====
+= MySQL START =
++--------------------+
+| Database           |
++--------------------+
+| information_schema |
+| mysql              |
+| performance_schema |
+| root               |
+| sample             |
+| sys                |
++--------------------+
++------------------+
+| Tables_in_sample |
++------------------+
+| samples          |
++------------------+
+= MySQL END =
+= Postgresql START =
+CREATE TABLE
+         List of relations
+ Schema |  Name   | Type  | Owner
+--------+---------+-------+--------
+ public | samples | table | sample
+(1 row)
+
+= Postgresql END =
+=== END DB SETUP ====
+```
+
+Run require sample model and gem code.
+
+``` ruby
+irb(main):001:0> require_relative './spec/sample/mysql/model/sample'
+=> true
+irb(main):002:0> require 'active_record_json_explain'
+=> true
+irb(main):003:0> Mysql::Sample.with_title.explain(json: true)
+=> EXPLAIN for: SELECT `samples`.* FROM `samples` WHERE `samples`.`title` = 'hoge'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Madogiwa0124/active_record_json_explain. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Madogiwa0124/active_record_json_explain/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveRecordJsonExplain project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Madogiwa0124/active_record_json_explain/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/active_record_json_explain.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'lib/active_record_json_explain/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_record_json_explain'
+  spec.version       = ActiveRecordJsonExplain::VERSION
+  spec.authors       = ['Madogiwa']
+  spec.email         = ['madogiwa0124@gmail.com']
+
+  spec.summary       = 'Possible to get EXPLAIN in JSON format.'
+  spec.description   = 'This gem extends `ActiveRecord::Relation#explain` to make it possible to get EXPLAIN in JSON format.'
+  spec.homepage      = 'https://github.com/Madogiwa0124/active_record_json_explain'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_runtime_dependency 'activerecord', '>= 5.2'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'active_record_json_explain'
+
+# 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/db_setup

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+echo "=== START DB SETUP ===="
+
+echo "= MySQL START ="
+mysql -u root -h 0.0.0.0 < 'spec/sample/mysql/db/migrate/0000_create_sample_schema.sql'
+mysql -u root -h 0.0.0.0 -e 'SHOW DATABASES;'
+mysql -u root -h 0.0.0.0 -e 'USE sample; SHOW TABLES;'
+echo "= MySQL END ="
+
+echo "= Postgresql START ="
+PGPASSWORD=password psql -U sample -h 0.0.0.0 -f 'spec/sample/postgresql/db/migrate/0000_create_sample_schema.sql'
+PGPASSWORD=password psql -U sample -h 0.0.0.0 -c '\d'
+echo "= Postgresql END ="
+
+echo "=== END DB SETUP ===="

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/docker-compose.yml

@@ -0,0 +1,14 @@
+mysql:
+  image: mysql
+  ports:
+    - 3306:3306
+  environment:
+    - MYSQL_DATABASE=root
+    - MYSQL_ALLOW_EMPTY_PASSWORD=yes
+postgres:
+  image: postgres
+  ports:
+    - 5432:5432
+  environment:
+    - POSTGRES_USER=sample
+    - POSTGRES_PASSWORD=password

data/gemfiles/active_record5.gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_record_scope_analyzer.gemspec
+gemspec :path => '../'
+
+gem 'activerecord', '~> 5.2'
+gem 'mysql2'
+gem 'pg'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop'

data/gemfiles/active_record6.gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_record_scope_analyzer.gemspec
+gemspec :path => '../'
+
+gem 'activerecord', '~> 6.0'
+gem 'mysql2'
+gem 'pg'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop'

data/lib/active_record_json_explain.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'active_record_json_explain/version'
+
+module ActiveRecordJsonExplain
+  class Error < StandardError; end
+  # Your code goes here...
+end
+
+# rubocop:disable all
+# Usage
+# ``` ruby
+# # NOTE:
+# # if use postgresql adapter, Rails run `require 'activerecord/lib/active_record/connection_adapters/postgresql/database_statement'` when establish_connection runs.
+# # So run `require 'active_record_scope_analyzer/json_explain'` after `establish_connection`.
+# require 'active_record_scope_analyzer/json_explain'
+# class Sample < ActiveRecord::Base
+#   scope :with_title, -> { where(title: 'hoge') }
+# end
+#
+# --- MySql ---
+# Sample.with_title.explain
+# => EXPLAIN for: SELECT `samples`.* FROM `samples` WHERE `samples`.`title` = 'hoge'
+# +----+-------------+---------+------------+------+---------------+------+---------+------+------+----------+-------------+
+# | id | select_type | table   | partitions | type | possible_keys | key  | key_len | ref  | rows | filtered | Extra       |
+# +----+-------------+---------+------------+------+---------------+------+---------+------+------+----------+-------------+
+# |  1 | SIMPLE      | samples | NULL       | ALL  | NULL          | NULL | NULL    | NULL |    1 |    100.0 | Using where |
+# +----+-------------+---------+------------+------+---------------+------+---------+------+------+----------+-------------+
+# 1 row in set (0.00 sec)
+#
+# Sample.with_title.explain(json: true)
+# => EXPLAIN for: SELECT `samples`.* FROM `samples` WHERE `samples`.`title` = 'hoge'
+# +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+# | EXPLAIN                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+# +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+# | {
+#   "query_block": {
+#     "select_id": 1,
+#     "cost_info": {
+#       "query_cost": "0.35"
+#     },
+#     "table": {
+#       "table_name": "samples",
+#       "access_type": "ALL",
+#       "rows_examined_per_scan": 1,
+#       "rows_produced_per_join": 1,
+#       "filtered": "100.00",
+#       "cost_info": {
+#         "read_cost": "0.25",
+#         "eval_cost": "0.10",
+#         "prefix_cost": "0.35",
+#         "data_read_per_join": "1K"
+#       },
+#       "used_columns": [
+#         "id",
+#         "category",
+#         "title",
+#         "body"
+#       ],
+#       "attached_condition": "(`sample`.`samples`.`title` = 'hoge')"
+#     }
+#   }
+# } |
+# +------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+# 1 row in set (0.00 sec)
+#
+# --- Postgresql ---
+# Sample.with_title.explain
+# => EXPLAIN for: SELECT "samples".* FROM "samples" WHERE "samples"."title" = $1 [["title", "hoge"]]
+#                         QUERY PLAN
+# ----------------------------------------------------------
+#  Seq Scan on samples  (cost=0.00..11.62 rows=1 width=556)
+#    Filter: ((title)::text = 'hoge'::text)
+# (2 rows)
+#
+# Sample.with_title.explain(json: true)
+# => EXPLAIN for: SELECT "samples".* FROM "samples" WHERE "samples"."title" = $1 [["title", "hoge"]]
+#                                                                                                                                                     QUERY PLAN
+# ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+#  [
+#   {
+#     "Plan": {
+#       "Node Type": "Seq Scan",
+#       "Parallel Aware": false,
+#       "Relation Name": "samples",
+#       "Alias": "samples",
+#       "Startup Cost": 0.00,
+#       "Total Cost": 11.62,
+#       "Plan Rows": 1,
+#       "Plan Width": 556,
+#       "Filter": "((title)::text = 'hoge'::text)"
+#     }
+#   }
+# ]
+# (1 row)
+# ```
+# rubocop:enable all
+
+# NOTE
+# Depending on the timing, it may be overwritten by ActiveRecord after `require` is executed and the monkey patch may not work,
+# so it is loaded.
+load 'active_record_json_explain/activerecord/monkey_patches/json_explain.rb'

data/lib/active_record_json_explain/activerecord/monkey_patches/json_explain.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_record'
+
+# NOTE:
+# This monkey patch add argument(json) for ActiveRecord::Relation#explain.
+# Argument json is default false. Therefore, it does not affect the default behavior.
+# Only MySql and Postgresql are supported.
+
+# rubocop:disable all
+module ActiveRecord
+  class Relation
+    # NOTE: https://github.com/rails/rails/blob/master/activerecord/lib/active_record/relation.rb#L239-L241
+    def explain(json: false) # NOTE: add arg json
+      exec_explain(collecting_queries_for_explain { exec_queries }, json: json) # NOTE: add arg json
+    end
+  end
+
+  module Explain
+    # NOTE: https://github.com/rails/rails/blob/master/activerecord/lib/active_record/explain.rb#L19-L36
+    def exec_explain(queries, json: false) # NOTE: add arg json
+      str = queries.map do |sql, binds|
+        msg = +"EXPLAIN for: #{sql}"
+        unless binds.empty?
+          msg << " "
+          msg << binds.map { |attr| render_bind(attr) }.inspect
+        end
+        msg << "\n"
+        msg << connection.explain(sql, binds, json: json) # NOTE: add arg json
+      end.join("\n")
+
+      # Overriding inspect to be more human readable, especially in the console.
+      def str.inspect
+        self
+      end
+
+      str
+    end
+  end
+
+  module ConnectionAdapters
+    module PostgreSQL
+      module DatabaseStatements
+        # NOTE: https://github.com/rails/rails/blob/master/activerecord/lib/active_record/connection_adapters/mysql/database_statements.rb#L31-L38
+        def explain(arel, binds = [], json: false) # NOTE: add arg json
+          format_option = "(FORMAT JSON)" if json # NOTE: get format option
+          sql = "EXPLAIN #{format_option} #{to_sql(arel, binds)}" # NOTE: set format option
+          PostgreSQL::ExplainPrettyPrinter.new.pp(exec_query(sql, "EXPLAIN", binds))
+        end
+      end
+    end
+
+    module MySQL
+      module DatabaseStatements
+        # NOTE: https://github.com/rails/rails/blob/master/activerecord/lib/active_record/connection_adapters/postgresql/database_statements.rb#L7-L10
+        def explain(arel, binds = [], json: false) # NOTE: add arg json
+          format_option = "FORMAT=JSON" if json # NOTE: get format option
+          sql     = "EXPLAIN #{format_option} #{to_sql(arel, binds)}" # NOTE: set format option
+          start   = Concurrent.monotonic_time
+          result  = exec_query(sql, "EXPLAIN", binds)
+          elapsed = Concurrent.monotonic_time - start
+
+          MySQL::ExplainPrettyPrinter.new.pp(result, elapsed)
+        end
+      end
+    end
+  end
+end
+
+# rubocop:enable all

data/lib/active_record_json_explain/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveRecordJsonExplain
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: active_record_json_explain
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Madogiwa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-30 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'
+description: This gem extends `ActiveRecord::Relation#explain` to make it possible
+  to get EXPLAIN in JSON format.
+email:
+- madogiwa0124@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record_json_explain.gemspec
+- bin/console
+- bin/db_setup
+- bin/setup
+- docker-compose.yml
+- gemfiles/active_record5.gemfile
+- gemfiles/active_record6.gemfile
+- lib/active_record_json_explain.rb
+- lib/active_record_json_explain/activerecord/monkey_patches/json_explain.rb
+- lib/active_record_json_explain/version.rb
+homepage: https://github.com/Madogiwa0124/active_record_json_explain
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Madogiwa0124/active_record_json_explain
+  source_code_uri: https://github.com/Madogiwa0124/active_record_json_explain
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Possible to get EXPLAIN in JSON format.
+test_files: []