awesome_explain 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d14b9a43988b0efc8466fe97d9965a54a7282212
+  data.tar.gz: 9a7238a42460d51e72cf15fffdec97439de8adcd
+SHA512:
+  metadata.gz: 8a2204580bbf2207f3cec4b922b8cd91f066d847a64f018a83df469ac599dd7a3121048e2629a75f3fb9e6025b59742371d254d0a01154dc14a41bfa8ad944cc
+  data.tar.gz: c3650a11afcb33eb926e77ccbf6e4be5e9776719235f3352e08ac2f9eb56da428043e7c9be875a8aeaf3db37d6d940b15bc05338d6077ecfd29c80a32ca9db14

data/.codeclimate.yml

@@ -0,0 +1,20 @@
+version: "2"
+plugins:
+  flog:
+    enabled: true
+    config:
+      score_threshold: 20.0
+  rubocop:
+    enabled: true
+  reek:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+        ruby:
+          mass_threshold: 35
+exclude_patterns:
+  - coverage/
+  - docs/
+  - spec/

data/.gitignore

@@ -0,0 +1,204 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+
+# Created by https://www.gitignore.io/api/vim,osx,windows,rubymine,sublimetext,visualstudiocode
+
+### OSX ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### RubyMine ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+### RubyMine Patch ###
+# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
+
+# *.iml
+# modules.xml
+# .idea/misc.xml
+# *.ipr
+
+# Sonarlint plugin
+.idea/sonarlint
+
+### SublimeText ###
+# Cache files for Sublime Text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# Workspace files are user-specific
+*.sublime-workspace
+
+# Project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using Sublime Text
+# *.sublime-project
+
+# SFTP configuration file
+sftp-config.json
+
+# Package control specific files
+Package Control.last-run
+Package Control.ca-list
+Package Control.ca-bundle
+Package Control.system-ca-bundle
+Package Control.cache/
+Package Control.ca-certs/
+Package Control.merged-ca-bundle
+Package Control.user-ca-bundle
+oscrypto-ca-bundle.crt
+bh_unicode_properties.cache
+
+# Sublime-github package stores a github token in this file
+# https://packagecontrol.io/packages/sublime-github
+GitHub.sublime-settings
+
+### Vim ###
+# Swap
+[._]*.s[a-v][a-z]
+[._]*.sw[a-p]
+[._]s[a-rt-v][a-z]
+[._]ss[a-gi-z]
+[._]sw[a-p]
+
+# Session
+Session.vim
+
+# Temporary
+.netrwhist
+*~
+# Auto-generated tag files
+tags
+# Persistent undo
+[._]*.un~
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+
+# End of https://www.gitignore.io/api/vim,osx,windows,rubymine,sublimetext,visualstudiocode

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,19 @@
+addons:
+  code_climate:
+    repo_token:
+      secure: "iLix2/7jYzbxfOe4hGvikPIfDL/xhIz5h0z6h0aZg1UMagnAue5UStYcvk5u1UtyTBW/aAW8WIgGVZG09a4J2Ker6+PaLskt94FytqTwQzAN6jONAdIlpreCdfFM5KbFVA7v9VszfkEcuYmAde4n1GbN4Hle84WeHAGI9dPd9sgvrbmIwAxcYSlYrDhqnMCzi0Z4Fqpbw0pLP6ZYWgoV1DywlFvCKjOcWaY1M0QoPZnJT/AGA9BGiJk42KfXCwY3b80VnixGFXtIgRqfFU1b0ZGptdtjETnDNeG2CA63sQoyAxOAStKxpTRKXRG/sI8fxuDdLDeqMOdrSpc19zqbr4hvUCn2+ukJMe3r4iKt5m4VjffcJVEXI8h7e16bbsBFvsgLQcxjBWcH5p9vOAl8aEHttUnaGvjtwza5MGTg2yI1CnIG+zMgb/MaR04zhI6YbKiZ88E5QXlyKBfA7DaT8ojRlpIIBFWhF7WpXBgCIxMB6afG8DaUTCCyFsa3xmvU+DR31xbgvKIYsv7etcCOqqmpbx+sQDIXUK6t4iF+d+ZWzj+CL1DtSw0I4Qkfmvj4nl4Zy3MRNZdr8vJbJf39bf2JTGqjd1qfCW/q1XV+2Bqtjp4wIOP/LWGlmcQYVnZ2q+13mP7wKyE6JVzX8khqkiggvtK255C8ETXc1BVBx6E="
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.16.0
+notifications: false
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build -t simplecov -p /home/travis/build/sandboxws/awesome_explain

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 aelhussaini@gmail.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in awesome_explain.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    awesome_explain (0.3.0)
+      awesome_print (~> 1.0)
+      terminal-table (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ansi (1.5.0)
+    awesome_print (1.8.0)
+    bson (4.3.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    hirb (0.7.3)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    minitest (5.11.3)
+    mongo (2.6.2)
+      bson (>= 4.3.0, < 5.0.0)
+    mongoid (7.0.1)
+      activemodel (>= 5.1, < 6.0.0)
+      mongo (>= 2.5.1, < 3.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_explain!
+  bundler (~> 1.16)
+  mongoid (>= 5)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov (~> 0.16.1)
+  simplecov-console (~> 0.4.2)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ahmed El.Hussaini
+
+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,74 @@
+# AwesomeExplain
+
+Awesome explain is a simple global method that provides quick insights into mongodb's query plan and execution stats.
+Currently the explain functionality only supports `Mongo::Collection::View::Aggregation` & ``Mongoid::Criteria`.
+
+[![Build Status](https://travis-ci.com/sandboxws/awesome_explain.svg?branch=master)](https://travis-ci.com/sandboxws/awesome_explain)
+[![Maintainability](https://api.codeclimate.com/v1/badges/75e1a5cb4b6a5c1ba4c8/maintainability)](https://codeclimate.com/github/sandboxws/awesome_explain/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/75e1a5cb4b6a5c1ba4c8/test_coverage)](https://codeclimate.com/github/sandboxws/awesome_explain/test_coverage)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Installation
+
+Add the following line to your application's Gemfile:
+
+`gem 'awesome_explain', require: true`
+
+## Usage
+
+`ae Article.where(author_id: '5b9ec484d5cc2e697189d7c9')`
+
+```
++--------------------+-----------------------------+
+| Winning Plan       | FETCH (7 / 7) -> IXSCAN (7) |
++--------------------+-----------------------------+
+| Used Indexes       | author_id_1 (forward)       |
++--------------------+-----------------------------+
+| Rejected Plans     | 0                           |
++--------------------+-----------------------------+
+| Documents Returned | 7                           |
++--------------------+-----------------------------+
+| Documents Examined | 7                           |
++--------------------+-----------------------------+
+| Keys Examined      | 7                           |
++--------------------+-----------------------------+
+| Execution time(ms) | 0                           |
++--------------------+-----------------------------+
+| Execution time(s)  | 0.0                         |
++--------------------+-----------------------------+
+```
+
+`ae Article.or([{author_id: '5b9ec484d5cc2e697189d7c9', state: 'published'}, {created_at: 3.days.ago}])`
+
+```
+
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| Winning Plan       | SORT (20) -> SORT_KEY_GENERATOR (20) -> FETCH (24 / 20) -> OR (24) -> [  FETCH (24 / 24) -> IXSCAN (24) ,  FETCH (0 / 0) -> IXSCAN (0) ]  |
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| Used Indexes       | state_1 (forward), author_id_1 (forward)                                                                                                  |
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| Rejected Plans     | 18                                                                                                                                        |
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| Documents Returned | 20                                                                                                                                        |
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| Documents Examined | 48                                                                                                                                        |
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| Keys Examined      | 24                                                                                                                                        |
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| Execution time(ms) | 37                                                                                                                                        |
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+| Execution time(s)  | 0.037                                                                                                                                     |
++--------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
+```
+
+## Winning Plan Examples
+
+`FETCH (7 / 7) -> IXSCAN (7)`
+
+Below is a breakdown of the above winning plan:
+
+- First stage is a `FETCH` stage. 7 documents were examined, and 7 were returned.
+- Second stage was an `IXSCAN` stage were 7 documents were returned.
+
+For information about MongoDB's explain output, please refer to the official MongoDB Explain documentation:
+https://docs.mongodb.com/manual/reference/explain-results/

data/Rakefile

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

data/awesome_explain.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'awesome_explain/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'awesome_explain'
+  spec.version       = AwesomeExplain::VERSION
+  spec.authors       = ['Ahmed El.Hussaini']
+  spec.email         = ['aelhussaini@gmail.com']
+
+  spec.summary       = 'Awesome and simple approach to explain Mongoid queries'
+  spec.description   = 'An awesome and simple approach to explain Mongoid queries that provides winning plan stages and overall statistics'
+  spec.homepage      = 'https://github.com/sandboxws/awesome_explain'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'awesome_print', '~> 1.0'
+  spec.add_dependency 'terminal-table', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'mongoid', '>= 5'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov-console', '~> 0.4.2'
+  spec.add_development_dependency 'simplecov', '~> 0.16.1'
+end

data/lib/awesome_explain.rb

@@ -0,0 +1,7 @@
+require 'awesome_explain/version'
+require 'terminal-table'
+require 'awesome_explain/renderers/mongoid'
+require 'awesome_explain/kernel'
+
+module AwesomeExplain
+end

data/lib/awesome_explain/kernel.rb

@@ -0,0 +1,14 @@
+module Kernel
+  def ae(query)
+    return AwesomeExplain::Renderers::Mongoid.new(query).print if mongoid_query?(query)
+    query
+  end
+
+  private
+
+  def mongoid_query?(query)
+    defined?(Mongo::Collection::View::Aggregation) &&
+      defined?(Mongoid::Criteria) &&
+      (query.is_a?(Mongo::Collection::View::Aggregation) || query.is_a?(Mongoid::Criteria))
+  end
+end

data/lib/awesome_explain/renderers/mongoid.rb

@@ -0,0 +1,135 @@
+module AwesomeExplain
+  module Renderers
+    class Mongoid
+      attr_reader :result, :query
+
+      COLOR_ESCAPES = {
+        none: 0, bright: 1, black: 30,
+        red: 31, green: 32, yellow: 33,
+        blue: 34, magenta: 35, cyan: 36,
+        white: 37, default: 39
+      }
+
+      def initialize(query)
+        @query = query
+      end
+
+      def print
+        @result = query.explain
+
+        print_general_info
+      end
+
+      # Text foreground color
+      def fg_color(clr, text = nil)
+        "\x1B[" + (COLOR_ESCAPES[clr] || 0).to_s + 'm' + (text ? text + "\x1B[0m" : '')
+      end
+
+      # Text background color
+      def bg_color(clr, text = nil)
+        "\x1B[" + ((COLOR_ESCAPES[clr] || 0) + 10).to_s + 'm' + (text ?  text + "\x1B[0m" : '')
+      end
+
+      def print_general_info
+        ap result, indent: -2
+        table = Terminal::Table.new do |t|
+          winning_plan_label = 'Winning Plan'
+          plan_data = winning_plan_data
+          winning_plan_str = plan_data[0]
+          used_indexes = plan_data[1]
+          winning_plan_label = fg_color :red, winning_plan_label if winning_plan_str =~ /COLLSCAN/
+          t << [winning_plan_label, winning_plan_str]
+          t << :separator
+          t << ['Used Indexes', used_indexes.join(', ')]
+          if execution_stats
+            t << :separator
+            t << ['Rejected Plans', rejected_plans.size]
+            t << :separator
+            t << ['Documents Returned', execution_stats.dig('nReturned')]
+            t << :separator
+            t << ['Documents Examined', execution_stats.dig('totalDocsExamined')]
+            t << :separator
+            t << ['Keys Examined', execution_stats.dig('totalKeysExamined')]
+            t << :separator
+
+            # Execution Time
+            exec_time = execution_stats.dig('executionTimeMillis').to_f/1000
+            exec_time_ms = execution_stats.dig('executionTimeMillis')
+            exec_label = 'Execution time(s)'
+            exec_label_ms = 'Execution time(ms)'
+
+            if exec_time > 10
+              exec_label = fg_color :red, exec_label
+              exec_label_ms = fg_color :red, exec_label_ms
+            end
+            t << [exec_label_ms, exec_time_ms]
+            t << :separator
+            t << [exec_label, exec_time]
+          end
+        end
+
+        puts
+        puts table
+        puts
+      end
+
+      def winning_plan_data
+        used_indexes = []
+        plan = winning_plan
+        plan_str = stage_label_and_stats(plan)
+        plan_str = dig_input_stages(plan.dig('inputStage'), plan_str, used_indexes) if plan['inputStage']
+
+        [plan_str, used_indexes]
+      end
+
+      def root
+        result.dig('$cursor') || result
+      end
+
+      def winning_plan
+        root.dig('executionStats', 'executionStages') || root.dig('queryPlanner', 'winningPlan')
+      end
+
+      def rejected_plans
+        root.dig('queryPlanner', 'rejectedPlans')
+      end
+
+      def execution_stats
+        root.dig('executionStats')
+      end
+
+      def dig_input_stages(stage, str, used_indexes, input_stages = false)
+        used_indexes << "#{stage.dig('indexName')} (#{stage.dig('direction')})" if stage.dig('indexName').present?
+        if stage.dig('inputStage').nil? && stage.dig('inputStages').nil?
+          str += ' -> ' + stage_label_and_stats(stage)
+        end
+        if stage.dig('inputStage').present?
+          str += ' ->' if !input_stages
+          str += ' ' + stage_label_and_stats(stage)
+          str = dig_input_stages(stage.dig('inputStage'), str, used_indexes, input_stages)
+        end
+
+        if stage.dig('inputStages').present?
+          str += ' -> ' + stage_label_and_stats(stage) + ' ->'
+          str += ' [ '
+          stage.dig('inputStages').each_with_index do |s, idx|
+            str = dig_input_stages(s, str, used_indexes, true)
+            str += ' , ' if idx < stage.dig('inputStages').size - 1
+          end
+          str += ' ] '
+        end
+
+        str
+      end
+
+      def stage_label_and_stats(stage)
+        str = "#{stage.dig('stage')} ("
+        str += "#{stage.dig('docsExamined')} / " if stage.dig('docsExamined').present?
+        str += stage.dig('nReturned').to_s if stage.dig('nReturned').present?
+        str += ')'
+
+        str.gsub(' ()', '')
+      end
+    end
+  end
+end

data/lib/awesome_explain/version.rb

@@ -0,0 +1,3 @@
+module AwesomeExplain
+  VERSION = '0.3.0'
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: awesome_explain
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Ahmed El.Hussaini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+description: An awesome and simple approach to explain Mongoid queries that provides
+  winning plan stages and overall statistics
+email:
+- aelhussaini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- awesome_explain.gemspec
+- lib/awesome_explain.rb
+- lib/awesome_explain/kernel.rb
+- lib/awesome_explain/renderers/mongoid.rb
+- lib/awesome_explain/version.rb
+homepage: https://github.com/sandboxws/awesome_explain
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Awesome and simple approach to explain Mongoid queries
+test_files: []