pg-eyeballs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8318a41826d020850ea248b42562f98495e7b319
+  data.tar.gz: cb5b794673a55abde012a232b2d21660c58f2b73
+SHA512:
+  metadata.gz: 421cc9c3588a38bfc9c9d0ac05c43e068012f407cb9eca5d03fae6e17e8635f7cfe57daed87509efd632586ef37632bd050cff69be93550faef7c6fd57a67d59
+  data.tar.gz: b668d16c03dc16e7d5f7b1b6f3ccb97f9b64c5c4c4c7166785025bbe2858465bb6a398f8195c700353c32f31c0c992a88789643ea5c124cbfcdb792037307af0

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at bradurani@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'pry'
+gem 'pry-byebug'
+gem 'awesome_print'
+
+# Specify your gem's dependencies in pg-eyeballs.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Brad Urani
+
+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,196 @@
+[![CircleCI](https://circleci.com/gh/bradurani/pg-eyeballs.svg?style=svg)](https://circleci.com/gh/bradurani/pg-eyeballs)
+# pg-eyeballs 👀
+
+`pg-eyeballs` is a ruby gem that gives you detailed information about how the
+SQL queries created by the active record code you write are executed by the database.
+It gives you an easy, ruby friendly way to see the output of the Postgres
+[`EXPLAIN` command](https://www.postgresql.org/docs/9.4/static/using-explain.html) and integrates with the popular query analysis tool [`gocmdpev`](https://github.com/simon-engledew/gocmdpev). 
+
+Using it you can see:
+- What queries were run
+- How long they took
+- Which indexes were used
+- Which algorithms were used
+- Much more!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg-eyeballs'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg-eyeballs
+
+## Usage
+
+### explain(options: [:analyze, :verbose, :costs, :buffers], format: :text)
+
+```ruby
+User.all.eyeballs.explain
+
+["Seq Scan on public.users  (cost=0.00..22.30 rows=1230 width=36) (actual time=0.002..0.002 rows=1 loops=1)
+    Output: id, email
+    Buffers: shared hit=1
+  Planning time: 0.014 ms
+  Execution time: 0.009 ms"
+]
+```
+Most eyeballs methods return an array because an `ActiveRecord::Relation` can run
+more than one query, for instance when it has a `preload` or with certain
+subqueries
+```ruby
+User.all.preload(:profiles).eyeballs.explain(options: [:verbose], format: :yaml)
+['- Plan: 
+      Node Type: "Seq Scan"
+      Relation Name: "users"
+      Schema: "public"
+      Alias: "users"
+      Startup Cost: 0.00
+      Total Cost: 22.30
+      Plan Rows: 1230
+      Plan Width: 36
+      Output: 
+      - "id"
+      - "email"', 
+ '- Plan:     
+      Node Type: "Seq Scan"
+      Relation Name: "profiles"
+      Schema: "public"
+      Alias: "profiles"
+      Startup Cost: 0.00\
+      Total Cost: 36.75
+      Plan Rows: 11
+      Plan Width: 8
+      Output: 
+        - "id"
+        - "user_id"
+      Filter: "(profiles.user_id = 1)"'
+]
+```
+**formats:** :text, :xml, :json, :yaml
+
+### explain_queries(options: [:analyze, :verbose, :costs, :buffers], format: :text)
+```ruby
+User.all.preload(:profiles).eyeballs.explain_queries
+["EXPLAIN (ANALYZE,VERBOSE,COSTS,BUFFERS,FORMAT TEXT) SELECT \"users\".* FROM \"users\"",
+ "EXPLAIN (ANALYZE,VERBOSE,COSTS,BUFFERS,FORMAT TEXT) SELECT \"profiles\".* FROM \"profiles\" WHERE \"profiles\".\"user_id\" IN (1)"]
+ ```
+**formats:** :text, :xml, :json, :yaml
+
+### log_json(options: [:analyze, :verbose, :costs, :buffers])
+Prints each JSON plan on a separate line. This is useful for command line
+processing with [`xargs`](https://linux.die.net/man/1/xargs) and [`jq`](https://stedolan.github.io/jq/) or
+[`gocmdpev`](https://github.com/simon-engledew/gocmdpev)
+```ruby
+User.all.preload(:profiles).eyeballs.log_json
+```
+
+### queries
+```ruby
+User.all.preload(:profiles).eyeballs.queries
+["SELECT \"users\".* FROM \"users\"",
+ "SELECT \"profiles\".* FROM \"profiles\" WHERE \"profiles\".\"user_id\" IN (1)"]
+ ```
+
+### to_hash_array(options: [:analyze, :verbose, :costs, :buffers])
+```ruby
+User.all.eyeballs.to_hash_array
+[[{"Plan"=>{
+    "Node Type"=>"Seq Scan",
+    "Relation Name"=>"users",
+    "Schema"=>"public",
+    "Alias"=>"users",
+    "Startup Cost"=>0.0,
+    "Total Cost"=>22.3,
+    "Plan Rows"=>1230,
+    "Plan Width"=>36,
+    "Actual Startup Time"=>0.001,
+    "Actual Total Time"=>0.001,
+    "Actual Rows"=>1,
+    "Actual Loops"=>1,
+    "Output"=>["id", "email"],
+    "Shared Hit Blocks"=>1,
+    "Shared Read Blocks"=>0,
+    "Shared Dirtied Blocks"=>0,
+    "Shared Written Blocks"=>0,
+    "Local Hit Blocks"=>0,
+    "Local Read Blocks"=>0,
+    "Local Dirtied Blocks"=>0,
+    "Local Written Blocks"=>0,
+    "Temp Read Blocks"=>0,
+    "Temp Written Blocks"=>0,
+    "I/O Read Time"=>0.0,
+    "I/O Write Time"=>0.0},
+    "Planning Time"=>0.014,
+    "Triggers"=>[],
+    "Execution Time"=>0.007}]
+]
+```
+
+### to_json(options: [:analyze, :verbose, :costs, :buffers])
+**alias for** `explain(format: :json)`
+
+### to_s(options: [:analyze, :verbose, :costs, :buffers])
+
+```ruby
+User.all.preload(:profiles).eyeballs.to_s
+"Seq Scan on public.users  (cost=0.00..22.30 rows=1230 width=36) (actual time=0.001..0.002 rows=1 loops=1)
+  Output: id, email
+  Buffers: shared hit=1
+Planning time: 0.010 ms
+Execution time: 0.005 ms
+
+Seq Scan on public.profiles  (cost=0.00..36.75 rows=11 width=8) (actual time=0.002..0.002 rows=1 loops=1)
+  Output: id, user_id
+  Filter: (profiles.user_id = 1)
+  Buffers: shared hit=1
+Planning time: 0.013 ms
+Execution time: 0.006 ms"
+```
+
+## Integration with `gocmdpev`
+
+`pg-eyeballs` integrates with
+[`gocmdpev`](https://github.com/simon-engledew/gocmdpev). If you have `gocmdpev`
+installed, you can use it in your Rails console:
+```ruby
+User.all.preload(:profiles).eyeballs.gocmdpev
+```
+
+![gocmdpev](https://raw.githubusercontent.com/bradurani/pg-eyeballs/master/gocmdpev.png "Using
+gocmdpev in the Rails console")
+
+You can also use `pg-eyeballs` and `gocmdpev` together from the command line.
+First, alias the included command. From inside the directory of you Rails
+project run
+```bash
+alias eyeballs=$(bundle show pg-eyeballs)/bin/gocmdpev
+```
+To use, also from inside your Rails project directory, run
+```bash
+eyeballs User.preload(:profiles)
+```
+
+## 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/bradurani/pg-eyeballs. 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](http://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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pg-eyeballs"
+
+# 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 "pry"
+Pry.start

data/bin/gocmdpev

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+bundle exec rails runner "$1.eyeballs.log_json" | while read x; do echo "$x" |  gocmdpev; echo; done

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/circle.yml

@@ -0,0 +1,8 @@
+machine:
+  environment:
+    POSTGRES_DB_DATABASE: circle_test
+    POSTGRES_DB_USERNAME: ubuntu
+    POSTGRES_DB_PASSWORD: ''
+database:
+  override: 
+    - echo 'using circle_test'

data/lib/eyeballs/errors.rb

@@ -0,0 +1,5 @@
+class Eyeballs::UnknownFormatError < StandardError
+end
+
+class Eyeballs::UnknownOptionError < StandardError
+end

data/lib/eyeballs/includes.rb

@@ -0,0 +1,5 @@
+module Eyeballs::RelationMixin
+  def eyeballs
+    Eyeballs::Inspector.new(self)
+  end
+end

data/lib/eyeballs/inspector.rb

@@ -0,0 +1,105 @@
+module Eyeballs
+  class Inspector
+
+    OPTIONS = [:analyze, :verbose, :costs, :buffers]
+    FORMATS = [:text, :xml, :json, :yaml]
+
+    def initialize(relation)
+      @relation = relation
+    end
+
+    def explain(format: :text, options: OPTIONS)
+      @explain ||= explain_queries(format: format, options: options).map do |query|
+        run_query(query)
+      end
+    end
+
+    def explain_queries(format: :text, options: OPTIONS)
+      validate_format!(format)
+      validate_options!(options)
+      @explain_queries ||= queries.map do |query|
+        explain_query(query, format, options)
+      end
+    end
+
+    def queries
+      @queries ||= query_array.map do |query_binding|
+        build_sql(query_binding)
+      end
+    end
+
+    def to_s(options: OPTIONS)
+      explain.join("\n\n")
+    end
+
+    def to_json(options: OPTIONS)
+      explain(options: options, format: :json)
+    end
+
+    def to_hash_array(options: OPTIONS)
+      to_json(options: options).map { |json| JSON.parse(json) }
+    end
+
+    def inspect
+      "Eyeballs::Inspector: #{@relation.to_s}"
+    end
+
+    def log_json(options: OPTIONS)
+      to_hash_array.each { |h| puts "#{h.to_json }" }
+      nil
+    end
+
+    def gocmdpev
+      to_hash_array.each do |h|
+        system("echo '#{h.to_json}' | gocmdpev")
+      end
+      nil 
+    end
+
+    private
+
+    def query_array
+      @relation.send(:collecting_queries_for_explain) do
+        @relation.send(:exec_queries)
+      end
+    end
+
+    def validate_format!(format)
+      unless FORMATS.include?(format)
+        raise Eyeballs::UnknownFormatError, "Unknown Format #{format}" 
+      end
+    end
+
+    def validate_options!(options)
+      options.each do |option|
+        unless OPTIONS.include?(option)
+          raise Eyeballs::UnknownOptionError, "Unknown Option #{option}" 
+        end
+      end
+    end
+
+    def explain_query(query, format, options)
+      "EXPLAIN (#{explain_options(format, options)}) #{query}" 
+    end
+
+    def explain_options(format, options)
+      options.map(&:upcase).tap { |a| a << "FORMAT #{format.upcase}" }.join(',')
+    end
+
+    def run_query(sql)
+      @relation.connection.raw_connection.exec(sql).values.join("\n")
+    end
+
+    def build_sql(query_binding)
+      sql = query_binding[0]
+      values = query_binding[1].map do |b|
+        cast_type = b[0].cast_type
+        cast_value = cast_type.type_cast_for_database(b[1])
+        quoted_value = @relation.connection.quote(cast_value)
+      end
+      values.each.with_index.reduce(sql) do |sql,(value, index)|
+        sql.sub("$#{index + 1}", value.to_s)
+      end
+    end
+  end
+end

data/lib/eyeballs/version.rb

@@ -0,0 +1,3 @@
+module Eyeballs
+  VERSION = "1.0.0"
+end

data/lib/pg-eyeballs.rb

@@ -0,0 +1,9 @@
+require 'active_record'
+require 'pg'
+
+module Eyeballs
+end
+
+Dir[File.join(File.dirname(__FILE__), 'eyeballs', '*.rb')].each {|file| require file }
+
+ActiveRecord::Relation.include Eyeballs::RelationMixin

data/pg-eyeballs.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eyeballs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pg-eyeballs"
+  spec.version       = Eyeballs::VERSION
+  spec.authors       = ["Brad Urani"]
+  spec.email         = ["bradurani@gmail.com"]
+
+  spec.summary       = 'A Ruby gem for using the postgres explain command with Active Record' 
+  spec.description   = 'pg-eyeballs is a ruby gem that gives you detailed information about how the SQL queries created by the active record code you write are executed by the database. It gives you an easy, ruby friendly way to see the output of the Postgres EXPLAIN command and integrates with the popular query analysis tool gocmdpev'
+  spec.homepage      = "http://github.com/bradurani/pg-eyeballs"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "database_cleaner"
+
+  spec.add_dependency "activerecord", ">=4.0", "<5.0"
+  spec.add_dependency "pg"
+
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: pg-eyeballs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brad Urani
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+description: pg-eyeballs is a ruby gem that gives you detailed information about how
+  the SQL queries created by the active record code you write are executed by the
+  database. It gives you an easy, ruby friendly way to see the output of the Postgres
+  EXPLAIN command and integrates with the popular query analysis tool gocmdpev
+email:
+- bradurani@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/gocmdpev
+- bin/setup
+- circle.yml
+- gocmdpev.png
+- lib/eyeballs/errors.rb
+- lib/eyeballs/includes.rb
+- lib/eyeballs/inspector.rb
+- lib/eyeballs/version.rb
+- lib/pg-eyeballs.rb
+- pg-eyeballs.gemspec
+homepage: http://github.com/bradurani/pg-eyeballs
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby gem for using the postgres explain command with Active Record
+test_files: []