mongo_clarify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36c90f7e00b8374b12af01bc1a4dccfea1e5a0794ca8de73f15f37857368acbd
+  data.tar.gz: d17f50a9ef3f588ee32df9a2dc072f6185e46c2e2a85f88de1795595bcd6b5f8
+SHA512:
+  metadata.gz: d54511d77bba0f73c50098f3f71ca5f815a0652d0fe4ff4793bc5e7d0a1546e03f312641039243039205537ed41477ed914547dc62a166b0b1c5e55492019ded
+  data.tar.gz: 24d6d711bbbdb8cba7c1a2aebc1826cbb255cab637da14477eb75d6b6813ee97e04d466c9f4a4f30a45f96292074198f6553524260d0602446cdd3b0a6687308

data/.gitignore

@@ -0,0 +1,54 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/.bundle/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+require: rubocop-performance
+
+AllCops:
+  Exclude:
+    - "vendor/**/*"
+    - "spec/spec_helper.rb"
+    - "lib/mongo_clarify/investigate_ruby2_7.rb"
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/LineLength:
+  Max: 120
+
+Style/LambdaCall:
+  Exclude:
+    - "lib/mongo_clarify/investigate.rb"

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

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 omnimani3@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,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+gem 'guard-rspec'
+gem 'pattern-match'
+gem 'pry'
+gem 'pry-byebug'
+gem 'rspec'
+gem 'rubocop'
+gem 'rubocop-performance'

data/Gemfile.lock

@@ -0,0 +1,100 @@
+PATH
+  remote: .
+  specs:
+    mongo_clarify (0.1.0)
+      pattern-match
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.11.1)
+    formatador (0.2.5)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    jaro_winkler (1.5.2)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    pattern-match (1.0.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.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.70.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.3.0)
+      rubocop (>= 0.68.0)
+    ruby-progressbar (1.10.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    thor (0.20.3)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  guard-rspec
+  mongo_clarify!
+  pattern-match
+  pry
+  pry-byebug
+  rake (~> 10.0)
+  rspec
+  rubocop
+  rubocop-performance
+
+BUNDLED WITH
+   1.16.1

data/Guardfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 morihirok
+
+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,61 @@
+# MongoClarify
+
+WARNING: This program is under construction.
+
+MongoDB explain is a little hard to read because it is JSON.
+
+This program makes it possible to convert MongoDB explain into Markdown table format. As below.
+
+| Key | Value |
+| --- | --- |
+| Means of Operation  | Collection Scan |
+| nReturned           | 1 |
+| executionTimeMillis | 59 msec |
+| totalKeysExamined   | 0 |
+| totalDocsExamined   | 100000 |
+
+## Installation
+
+```ruby
+gem 'mongo_clarify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongo_clarify
+
+## Usage
+
+In the case of CLI.
+
+```sh
+$ mongo_clarify <Json file of MongoDB explain>
+```
+
+If you are using Mongoid.
+
+```ruby
+MongoClarify.run(Model.where(query).explain)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mongo_clarify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 MongoClarify project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mongo_clarify/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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'mongo_clarify'
+
+# 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,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/exe/mongo_clarify

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require 'JSON'
+require 'mongo_clarify'
+
+raise ArgumentError, 'Please input explain json.' if ARGV[0].nil?
+
+file = File.read("./#{ARGV[0]}")
+explain = JSON.parse(file, symbolize_names: true)
+
+MongoClarify.run(explain)

data/lib/mongo_clarify/investigate.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'pattern-match/experimental'
+
+module MongoClarify
+  class Investigate
+    using PatternMatch
+
+    def initialize(explain)
+      @explain = explain
+    end
+
+    def operation_method
+      match(@explain) do
+        with(Hash.(queryPlanner: Hash.(winningPlan: Hash.(stage: 'COLLSCAN')))) do
+          'Collection Scan'
+        end
+        with(Hash.(queryPlanner: Hash.(winningPlan: Hash.(stage: 'FETCH', inputStage: Hash.(stage: 'IXSCAN', indexName: index_name))))) do
+          "Index Scan (Index Name: #{index_name})"
+        end
+      end
+    rescue PatternMatch::NoMatchingPatternError
+      nil
+    end
+
+    def execution_stats
+      match(@explain) do
+        with(Hash.(executionStats: Hash.(nReturned: n, executionTimeMillis: msec, totalKeysExamined: keys, totalDocsExamined: docs))) do
+          {
+            n_returned: n,
+            execution_time_millis: msec,
+            total_keys_examined: keys,
+            total_docs_examined: docs
+          }
+        end
+      end
+    rescue PatternMatch::NoMatchingPatternError
+      nil
+    end
+  end
+end

data/lib/mongo_clarify/investigate_ruby2_7.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module MongoClarify
+  class InvestigateRuby2_7
+    def initialize(explain)
+      @explain = explain
+    end
+
+    def operation_method
+      case @explain
+      in { queryPlanner: { winningPlan: { stage: 'COLLSCAN' } } }
+        'Collection Scan'
+      in { queryPlanner: { winningPlan: { stage: 'FETCH', inputStage: { stage: 'IXSCAN', indexName: index_name } } } }
+        "Index Scan (Index Name: #{index_name})"
+      else
+        'Unknown'
+      end
+    end
+
+    def execution_stats
+      case @explain
+      in { executionStats: { nReturned: n, executionTimeMillis: msec, totalKeysExamined: keys, totalDocsExamined: docs } }
+      else
+      end
+      { n_returned: n, execution_time_millis: msec, total_keys_examined: keys, total_docs_examined: docs }
+    end
+  end
+end

data/lib/mongo_clarify/output.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module MongoClarify
+  class Output
+    def initialize(operation_method, exec_stats)
+      @operation_method = operation_method
+      @exec_stats = exec_stats
+    end
+
+    def markdown_table
+      if @operation_method.nil? && @exec_stats.nil?
+        return puts 'Could not parse this explain...'
+      elsif @exec_stats.nil?
+        return puts means_of_operation_only_table(@operation_method)
+      end
+
+      puts full_table
+    end
+
+    private
+
+    def full_table
+      <<~EXPLAIN
+        | Key | Value |
+        | --- | --- |
+        | Means of Operation  | #{@operation_method || 'Unknown'} |
+        | nReturned           | #{@exec_stats[:n_returned]} |
+        | executionTimeMillis | #{@exec_stats[:execution_time_millis]} msec |
+        | totalKeysExamined   | #{@exec_stats[:total_keys_examined]} |
+        | totalDocsExamined   | #{@exec_stats[:total_docs_examined]} |
+      EXPLAIN
+    end
+
+    def means_of_operation_only_table(operation_method)
+      <<~EXPLAIN
+        | Key | Value |
+        | --- | --- |
+        | Means of Operation  | #{operation_method} |
+        | Execution Stats     | Not detected |
+      EXPLAIN
+    end
+  end
+end

data/lib/mongo_clarify/version.rb

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

data/lib/mongo_clarify.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'mongo_clarify/version'
+
+require_relative 'mongo_clarify/investigate'
+require_relative 'mongo_clarify/output'
+
+module MongoClarify
+  class << self
+    def run(explain)
+      investigate = MongoClarify::Investigate.new(explain)
+      exec_stats = investigate.execution_stats
+      operation_method = investigate.operation_method
+
+      MongoClarify::Output.new(operation_method, exec_stats).markdown_table
+    end
+  end
+end

data/mongo_clarify.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongo_clarify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mongo_clarify'
+  spec.version       = MongoClarify::VERSION
+  spec.authors       = ['morihirok']
+  spec.email         = ['omnimani3@gmail.com']
+
+  spec.summary       = "Make MongoDB's explain results more understandable."
+  spec.homepage      = 'https://github.com/morihirok/mongo-clarify'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_dependency 'pattern-match'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: mongo_clarify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- morihirok
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pattern-match
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: 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: 
+email:
+- omnimani3@gmail.com
+executables:
+- mongo_clarify
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/mongo_clarify
+- lib/mongo_clarify.rb
+- lib/mongo_clarify/investigate.rb
+- lib/mongo_clarify/investigate_ruby2_7.rb
+- lib/mongo_clarify/output.rb
+- lib/mongo_clarify/version.rb
+- mongo_clarify.gemspec
+homepage: https://github.com/morihirok/mongo-clarify
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Make MongoDB's explain results more understandable.
+test_files: []