peek-activerecord 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e48abc9c66c1fd7f15a72ff4a563dde041dea5f1
+  data.tar.gz: 7275d15031cefde6987261d922159e9c7543e299
+SHA512:
+  metadata.gz: 10b39ba2a7439d76f9053e7771267b010f95ef0bc37acb1e369766009b33e41c3394e4eacfcf7a1a1baf998e48aa2ee73ce74fd92eb55e620f682fc1ac5f57b5
+  data.tar.gz: 604b5e7d52f777e211b27c869ca22d6846e984daa2f1f5445b234c0963222c18237f899485c97ea68b00f618315469fd61d3665cd16bdd4bb10a7bae0ae56e04

data/.gitignore

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

data/.travis.yml

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

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 bhuga@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 [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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in peek-activerecord.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ben Lavender
+
+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,64 @@
+# Peek::Activerecord
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/peek/activerecord`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'peek-activerecord'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install peek-activerecord
+
+In `/app/assets/stlyesheets/application.scss`:
+
+```
+ = require peek/views/activerecord
+ = require peek/views/activerecord/pygments
+```
+
+In `/app/assets/javascripts/application.coffee`:
+
+```
+#= require peek/views/activerecord
+```
+
+This works the same way in `application.js` if you have that instead, just put
+the require in a comment.
+
+## Usage
+
+Any page with `peek_enbled?` will have a new `ActiveRecord Queries` link. Click
+on it to see your queries:
+
+![](https://github-slack.s3.amazonaws.com/monosnap/Your_Builds_2017-06-27_14-00-43.png)
+
+Controllers have a new method, `peek_activerecord_enabled?`, that you can
+overwrite to separate AR enabled-ness from peek enabled-ness if you like.
+
+## Development
+
+There's no good development harness yet, sorry. Contributions are welcome if
+you're up to it.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bhuga/peek-activerecord. 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).
+
+## Code of Conduct
+
+Everyone interacting in the Peek::Activerecord project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bhuga/peek-activerecord/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/app/assets/javascripts/peek/views/activerecord.js

@@ -0,0 +1,8 @@
+$(document).on('click', '#js-peek-activerecord-toggle', function(e) {
+  table = document.getElementById('peek-activerecord-modal');
+  peek = document.getElementById('peek')
+  peek.appendChild(table);
+  peek.classList.toggle('display-activerecord-modal')
+  e.preventDefault();
+  return false;
+});

data/app/assets/stylesheets/peek/views/activerecord.scss

@@ -0,0 +1,57 @@
+#peek.display-activerecord-modal {
+  height: auto;
+
+  #peek-activerecord-modal {
+    display: block;
+  }
+}
+
+#peek-activerecord-modal {
+  display: none;
+  clear: both;
+  background: #000;
+
+  .duration-header {
+    max-width: 100px;
+  }
+
+  .cached-header {
+    width: 50px;
+  }
+
+  .duration-data, .cache-data {
+    text-align: center;
+  }
+
+  .duration-data {
+    max-width: 100px;
+  }
+
+  .cache-data {
+    width: 50px;
+  }
+
+  .sql-data {
+    text-align: left;
+    pre {
+      white-space: normal;
+      .highlight {
+        font-family: monospace;
+      }
+    }
+  }
+
+  ul {
+    display: block;
+    li {
+      display: block;
+      ul.row {
+        display: flex;
+        flex-direction: row;
+        li {
+          padding: 5px;
+        }
+      }
+    }
+  }
+}

data/app/assets/stylesheets/peek/views/activerecord/pygments.scss

@@ -0,0 +1,60 @@
+.highlight  { background: #000; }
+.highlight .c { color: #999988; font-style: italic } /* Comment */
+.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
+.highlight .k { font-weight: bold } /* Keyword */
+.highlight .o { font-weight: bold } /* Operator */
+.highlight .cm { color: #999988; font-style: italic } /* Comment.Multiline */
+.highlight .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
+.highlight .c1 { color: #999988; font-style: italic } /* Comment.Single */
+.highlight .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
+.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
+.highlight .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
+.highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .gr { color: #aa0000 } /* Generic.Error */
+.highlight .gh { color: #999999 } /* Generic.Heading */
+.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
+.highlight .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
+.highlight .go { color: #888888 } /* Generic.Output */
+.highlight .gp { color: #555555 } /* Generic.Prompt */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
+.highlight .gu { color: #800080; font-weight: bold; } /* Generic.Subheading */
+.highlight .gt { color: #aa0000 } /* Generic.Traceback */
+.highlight .kc { font-weight: bold } /* Keyword.Constant */
+.highlight .kd { font-weight: bold } /* Keyword.Declaration */
+.highlight .kp { font-weight: bold } /* Keyword.Pseudo */
+.highlight .kr { font-weight: bold } /* Keyword.Reserved */
+.highlight .kt { color: #445588; font-weight: bold } /* Keyword.Type */
+.highlight .m { color: #009999 } /* Literal.Number */
+.highlight .s { color: #d14 } /* Literal.String */
+.highlight .na { color: #008080 } /* Name.Attribute */
+.highlight .nb { color: #0086B3 } /* Name.Builtin */
+.highlight .nc { color: #445588; font-weight: bold } /* Name.Class */
+.highlight .no { color: #008080 } /* Name.Constant */
+.highlight .ni { color: #800080 } /* Name.Entity */
+.highlight .ne { color: #990000; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #990000; font-weight: bold } /* Name.Function */
+.highlight .nn { color: #555555 } /* Name.Namespace */
+.highlight .nt { color: #000080 } /* Name.Tag */
+.highlight .nv { color: #008080 } /* Name.Variable */
+.highlight .ow { font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mf { color: #009999 } /* Literal.Number.Float */
+.highlight .mh { color: #009999 } /* Literal.Number.Hex */
+.highlight .mi { color: #009999 } /* Literal.Number.Integer */
+.highlight .mo { color: #009999 } /* Literal.Number.Oct */
+.highlight .sb { color: #d14 } /* Literal.String.Backtick */
+.highlight .sc { color: #d14 } /* Literal.String.Char */
+.highlight .sd { color: #d14 } /* Literal.String.Doc */
+.highlight .s2 { color: #d14 } /* Literal.String.Double */
+.highlight .se { color: #d14 } /* Literal.String.Escape */
+.highlight .sh { color: #d14 } /* Literal.String.Heredoc */
+.highlight .si { color: #d14 } /* Literal.String.Interpol */
+.highlight .sx { color: #d14 } /* Literal.String.Other */
+.highlight .sr { color: #009926 } /* Literal.String.Regex */
+.highlight .s1 { color: #d14 } /* Literal.String.Single */
+.highlight .ss { color: #990073 } /* Literal.String.Symbol */
+.highlight .bp { color: #999999 } /* Name.Builtin.Pseudo */
+.highlight .vc { color: #008080 } /* Name.Variable.Class */
+.highlight .vg { color: #008080 } /* Name.Variable.Global */
+.highlight .vi { color: #008080 } /* Name.Variable.Instance */
+.highlight .il { color: #009999 } /* Literal.Number.Integer.Long */

data/app/views/peek/views/_active_record.html.erb

@@ -0,0 +1 @@
+<%= link_to 'ActiveRecord Queries', {}, id: "js-peek-activerecord-toggle" %>

data/app/views/peek/views/_activerecord.html.erb

@@ -0,0 +1 @@
+<%= link_to 'ActiveRecord Queries', :activerecord => true %>

data/bin/console

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

data/bin/setup

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

data/lib/peek-activerecord.rb

@@ -0,0 +1,4 @@
+require 'peek'
+require "peek-activerecord/version"
+require 'peek-activerecord/railtie'
+require 'peek/views/activerecord'

data/lib/peek-activerecord/railtie.rb

@@ -0,0 +1,13 @@
+require 'peek/activerecord/controller_helpers'
+
+module Peek
+  module ActiveRecord
+    class Railtie < ::Rails::Engine
+      initializer 'peek.activerecord.include_controller_helpers' do
+        ActiveSupport.on_load(:action_controller) do
+          include Peek::ActiveRecord::ControllerHelpers
+        end
+      end
+    end
+  end
+end

data/lib/peek-activerecord/version.rb

@@ -0,0 +1,5 @@
+module Peek
+  module Activerecord
+    VERSION = "0.1.0"
+  end
+end

data/lib/peek/activerecord.rb

@@ -0,0 +1,4 @@
+require 'peek'
+require "peek-activerecord/version"
+require 'peek-activerecord/railtie'
+require 'peek/views/activerecord'

data/lib/peek/activerecord/controller_helpers.rb

@@ -0,0 +1,96 @@
+begin
+  require 'pygments.rb'
+rescue LoadError
+  # Doesn't have pygments.rb installed
+end
+
+require "rack/utils"
+
+module Peek
+  module ActiveRecord
+    module ControllerHelpers
+      extend ActiveSupport::Concern
+
+      included do
+        around_action :inject_peek_activerecord, :if => [:peek_enabled?, :peek_activerecord_enabled?]
+      end
+
+      protected
+
+      def pygments_enabled?
+        defined?(Pygments)
+      end
+
+      def pygmentized_sql(sql)
+        if pygments_enabled?
+          Pygments.highlight(sql, :lexer => 'sql')
+        else
+          "#{Rack::Utils.escape_html(code)}"
+        end
+      end
+
+      # This can be overwritten in ApplicationController to disable query
+      # tracking separately from peek
+      def peek_activerecord_enabled?
+        peek_enabled?
+      end
+
+      def inject_peek_activerecord(&block)
+        puts "injecting"
+        return block.call unless peek_activerecord_enabled?
+        ret = nil
+        queries = []
+        subscriber = ActiveSupport::Notifications.subscribe "sql.active_record" do |*args|
+          event = ActiveSupport::Notifications::Event.new *args
+          queries << event
+        end
+        ret = block.call
+        peek_activerecord_append_queries_to_response(queries)
+        ret
+      ensure
+        ActiveSupport::Notifications.unsubscribe(subscriber) if subscriber
+      end
+
+      def peek_activerecord_append_queries_to_response(queries)
+        if response.content_type =~ %r|text/html|
+          output = <<-EOS
+            <div class=ar_instrumentation id=peek_activerecord_table>
+            <ul>
+              <li>
+                <ul class=row>
+                  <li class=duration-header>
+                    Duration
+                  </li>
+                  <li class=cached-header>
+                    Cached
+                  </li>
+                  <li class=sql-header>
+                    SQL
+                  </li>
+                </ul>
+              </li>
+          EOS
+          queries.each do |query|
+            output << <<-EOS
+              <li>
+                <ul class=row>
+                  <li class=duration-data>
+                    #{"%.3f" % query.duration}ms
+                  </li>
+                  <li class=cache-data>
+                    #{query.payload[:name] == "CACHE"}
+                  </li>
+                  <li class=sql-data>
+                    #{pygmentized_sql(query.payload[:sql])}
+                  </li>
+                </ul>
+              </li>
+            EOS
+          end
+          output << "</table>"
+          response.body += "<div id='peek-activerecord-modal'>#{output}</div>".html_safe
+        end
+      end
+    end
+  end
+end

data/lib/peek/views/activerecord.rb

@@ -0,0 +1,8 @@
+require 'peek/views/view'
+
+module Peek
+  module Views
+    class ActiveRecord < View
+    end
+  end
+end

data/peek-activerecord.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "peek-activerecord/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "peek-activerecord"
+  spec.version       = Peek::Activerecord::VERSION
+  spec.authors       = ["Ben Lavender"]
+  spec.email         = ["blavender@gmail.com"]
+
+  spec.summary       = %q{Peek plugin for activerecord queries and timings}
+  spec.homepage      = "https://github.com/bhuga/peek-activerecord"
+  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 'peek'
+  spec.add_dependency 'pygments.rb'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry", '~> 0'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: peek-activerecord
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Lavender
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: peek
+  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: pygments.rb
+  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.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: 
+email:
+- blavender@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/peek/views/activerecord.js
+- app/assets/stylesheets/peek/views/activerecord.scss
+- app/assets/stylesheets/peek/views/activerecord/pygments.scss
+- app/views/peek/views/_active_record.html.erb
+- app/views/peek/views/_activerecord.html.erb
+- bin/console
+- bin/setup
+- lib/peek-activerecord.rb
+- lib/peek-activerecord/railtie.rb
+- lib/peek-activerecord/version.rb
+- lib/peek/activerecord.rb
+- lib/peek/activerecord/controller_helpers.rb
+- lib/peek/views/activerecord.rb
+- peek-activerecord.gemspec
+homepage: https://github.com/bhuga/peek-activerecord
+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.11
+signing_key: 
+specification_version: 4
+summary: Peek plugin for activerecord queries and timings
+test_files: []