rack-webprofiler 0.1.0.pre.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e53fe35fbf1ec6a915d0374a19f1906099038b1
+  data.tar.gz: 5d4e24c3922f21f2ab2729c76ab2773d23c5139d
+SHA512:
+  metadata.gz: 6fe6001ef5e408dd90112981ef35a71767df331c4050493cbe9cd0e047e3f263f398e75d1f4461215eee7a701602e7ee534ef886bdf88bdb1cb896516f696d32
+  data.tar.gz: 20a4c13c4861a4a025b3b09b3a8889d18b7cf98665e3caa530575658cdc2d8e279416ebb185d14194c4ae1fdee55a7de1fd605cc7335aa0e6993f58485623f63

data/.editorconfig

@@ -0,0 +1,27 @@
+; top-most EditorConfig file
+root = true
+
+; Unix-style newlines
+[*]
+end_of_line = LF
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.rb]
+indent_style = space
+indent_size = 2
+
+[{*.css,*.scss}]
+indent_style = space
+ident_size = 4
+
+[*.js]
+indent_style = space
+ident_size = 2
+
+[*.yml]
+indent_style = space
+indent_size = 2

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,34 @@
+# This is the configuration used to check the rubocop source code.
+
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 1.9
+  Exclude:
+    - 'examples/**/*'
+    # - 'tmp/**/*'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/IfUnlessModifier:
+  MaxLineLength: 120
+
+Style/WhileUntilModifier:
+  MaxLineLength: 120
+
+Metrics/LineLength:
+  Max: 120
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+# Style/IndentArray:
+#   EnforcedStyle: align_brackets

data/.travis.yml

@@ -0,0 +1,23 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+
+install:
+  - bin/ci-prepare
+
+script:
+  - time bundle exec rake spec
+  - bundle exec bundle-audit update
+  - bundle exec bundle-audit check
+
+notifications:
+  email:
+      on_success: change
+      on_failure: always
+  webhooks:
+    urls:
+      - secure: X0uF0lUgFuKAPxNWL26+RsP8SYcuxLdRwopuMpkxc0qdP972IrgVLpKnbi02zsnt7IK0LCSiknj3uV6X1aqiRPAeZwOLEScEttuA50qnth3spVFc0UmYRvs9H6OdE2ylc3iBlavptP4TJytJQiPAyfzl8DeLvkTZesPEf5Jkiw+WmGWk+al4zt8Ejq9+vHsYbBk4ty/GzVP5FgruEpmtQG3TibVo5aKRmgvJc6c+HZHkefXBGZwhmhoQpvH3rRUXp/c7c/3K1QJTI0LzO+AAjl5Jh3qP5U5JhblmCaVqFKp0eD7jhym/lTyWSodPDdZ+JoDV8S7EJhoWjMtlW5c1Q9hooax/mjCwmApGXhrMaPPqmlU6l0Io1TYV8f4MLus0WXDf2O62AFe4uD4NvrFAS1tEPx6fEJd8X9chE96h03S+SxM3Ol3d++n6latb3H9dWTN0QM0miOmwdUUKSK6iOMuiFOp1cZoM+AbvyQvMhqAHvZ3SVeL3FCRpqFt7UpFTmVaBmtxSWlByU4raD1yK6LLfJxcPoOWZg2XoqZ5OAu1GWtdE5Xgr9jnnDojMMOlpcCpIydBbhdTe6e/qsg+iVA4HBwxuiKIYbL4mXBXoTcdgwpD/mufaM9NLmJsc9WqO3n+rIkxB+msYgR6lw5Brw0ofCBm7Yw2AL+cZqXs8DzY=
+    on_success: always
+    on_failure: always
+    on_start: never

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+## Unplanned
+
+### Features
+
+  * Create a collector to show informations about CPU usage.
+  * Create a collector to list all `.inspect` method calls.
+  * Create a collector to list the HTTP calls.
+  * Create a collector for Devise gem.
+  * Create a collector for ActiveRecord.
+  * Create a collector for Sequel.
+  * Create a collector for SQL requests without ActiveRecord.
+  * Create a collector to show the Rails logger informations.
+  * Create a collector to list jobs created with ActiveJob.
+  * Create a collector to list the ajax requests.
+  * Have a friendly UI.
+  * Catch 500 or exceptions.
+
+
+## v0.2.0
+
+### Features
+
+  * Create a Rails request collector.
+  * Create a collector to show which Rails version it is used and the current environment.
+
+
+## v0.1.0 (WIP)
+
+### Features
+
+  * Web toolbar injected into text/html responses.
+  * Have a panel who list all the request stored into the profiler and show more informations than the toolbar.
+  * Provide a nice DSL for collector to allow adding a new collector easily.
+  * Create a execution time collector.
+  * Create a collector to show which version of ruby it is used.
+  * Create a collector to show the Rack request informations.
+  * Create a collector to show the Sinatra request informations.

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 pro@nicolas-brousse.fr. 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 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rack-webprofiler.gemspec
+gemspec
+
+gem "sinatra"
+gem "simplecov", require: false
+gem "rubocop", "~> 0.38.0", require: false
+gem "bundler-audit"
+gem "flog"
+gem "flay"
+gem "ruby2ruby"
+gem "yard"
+gem "shotgun"
+gem "pry"

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nicolas Brousse
+
+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,94 @@
+# Rack WebProfiler
+
+A Rack profiler for web application.
+
+[![Version         ](http://img.shields.io/gem/v/rack-webprofiler.svg)                               ](https://rubygems.org/gems/rack-webprofiler)
+[![Travis CI       ](http://img.shields.io/travis/nicolas-brousse/rack-webprofiler/master.svg)           ](https://travis-ci.org/nicolas-brousse/rack-webprofiler)
+[![Gitter         ](https://img.shields.io/gitter/room/nicolas-brousse/rack-webprofiler.svg)       ](https://gitter.im/nicolas-brousse/rack-webprofiler)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-webprofiler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-webprofiler
+
+### Rack
+
+```ruby
+home = lambda { |_env|
+  [200, { "Content-Type" => "text/html" }, ["<html><body>Hello world!</body></html>"]]
+}
+
+builder = Rack::Builder.new do
+  use Rack::WebProfiler
+
+  map('/') { run home }
+end
+
+run builder
+```
+
+### Sinatra
+
+```ruby
+require "rack-webprofiler"
+
+class App < Sinatra::Base
+  use Rack::WebProfiler
+end
+```
+
+### Rails
+
+The WebProfiler is automatically enabled.
+
+
+## Configuration
+
+You can specify the temporary directory. It is used to save the SQlite database.
+
+```ruby
+use Rack::WebProfiler, tmp_dir: File.expand_path("/tmp", __FILE__)
+```
+
+## Usage
+
+TODO
+
+HTTP headers `X-RackWebProfiler-Token` `X-RackWebProfiler-Url`.
+
+
+## Examples
+
+See [the examples](./examples).
+
+## 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/nicolas-brousse/rack-webprofiler. 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).
+
+## Alternatives & comments
+
+* https://github.com/MiniProfiler/rack-mini-profiler
+* https://github.com/dawanda/rack-profiler
+
+This project is in part inspired by the [Symfony WebProfiler Bundle](https://github.com/symfony/web-profiler-bundle).

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
+require "yard"
+
+RSpec::Core::RakeTask.new(:spec)
+
+YARD::Rake::YardocTask.new do |t|
+  t.files         = ["lib/**/*.rb"]
+  t.stats_options = ["--list-undoc"]
+end
+
+RuboCop::RakeTask.new do
+  # task.requires << "rubocop-rspec"
+end
+
+task default: :spec

data/bin/ci-prepare

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+gem install bundler --no-ri --no-rdoc
+
+echo ''
+echo '------------------------------------------------------------------------------------------'
+echo "Shell:           $SHELL"
+echo "PATH:            $PATH"
+echo "Ruby path:       $(which ruby)"
+echo "Ruby version:    $(ruby -v)"
+echo "Bundler path:    $(which bundle)"
+echo "Bundler version: $(bundle -v)"
+echo '------------------------------------------------------------------------------------------'
+echo ''
+
+bundle install --retry=3 --jobs $(($(nproc) + 1)) "${FLAGS[@]}"

data/bin/console

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

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/examples/README.md

@@ -0,0 +1,56 @@
+# Examples
+
+```shell
+$ rackup rack/config.ru
+$ rackup sinatra/config.ru
+```
+
+
+# How to create a custom collector
+
+## What is a collector
+
+A collector is a class who permit retrieve profiler data. And also create a tab and show content into the toolbar.
+
+## The class
+
+```ruby
+class MyCustomCollector
+  include Rack::WebProfiler::Collector::DSL
+
+  collector_name "my_collector" # Technical name of the collector.
+  icon     ""                   # Base64 encoded image for the icon collector.
+  position 0                    # Position of the collector in the toolbar.
+
+  # Retrieve the env, the request and the response
+  # to collect the needed information. Then save datas
+  # and show them in the profiler toolbar and panel.
+  collect do |env, request, response|
+    store :version, MyApp::VERSION
+    store :list, ["value1", "value2"]
+  end
+
+  # The path of the collector template.
+  # May be with some options to know if we show the collector
+  # on tab and/or panel.
+  template "../path/to/template.erb"
+  # Or
+  # template __FILE__, type: :DATA
+
+  # To know if the collector must be enabled.
+  # Usefull to load collector only if a gem is installed.
+  is_enabled? -> { defined? MyApp }
+end
+```
+
+And you have to register it
+
+```ruby
+Rack::WebProfiler.register_collector MyCustomCollector
+```
+
+You could also unregister a collector
+
+```ruby
+Rack::WebProfiler.unregister_collector MyCustomCollector
+```

data/examples/rack/config.ru

@@ -0,0 +1,52 @@
+require "bundler/setup"
+require "rack/webprofiler"
+require "rack"
+
+# An example of a custom collector.
+#
+# module MyCollector
+#   class Profiler::Collector::TimeCollector
+#     include Rack::WebProfiler::Collector::DSL
+#
+#     icon ""
+#
+#     collector_name "my_collector"
+#     position       2
+#
+#     collect do |request, response|
+#       store :runtime, request.runtime
+#     end
+#
+#     template "
+# <% content_for :tab do %>
+#   <%= data[:runtime] %>
+# <% end %>
+# "
+#   end
+# end
+
+home = lambda { |_env|
+  [200, { "Content-Type" => "text/html" }, [<<-'HTML'
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title>Rack WebProfiler test</title>
+  </head>
+
+  <body>
+    <p>Hello world!</p>
+  </body>
+</html>
+HTML
+]]
+}
+
+builder = Rack::Builder.new do
+  use Rack::WebProfiler, tmp_dir: File.expand_path("../tmp", __FILE__)
+  use Rack::ShowExceptions
+
+  map('/') { run home }
+end
+
+run builder

data/examples/sinatra/app.rb

@@ -0,0 +1,37 @@
+require "bundler/setup"
+require "rack/webprofiler"
+require "rack"
+require "sinatra"
+
+class App < Sinatra::Base
+  use Rack::WebProfiler, tmp_dir: File.expand_path("../tmp", __FILE__)
+
+  get "/" do
+    erb "Hello World!", layout: TEMPLATE
+  end
+
+  get "/without_profiler" do
+    erb "Hello World!"
+  end
+
+  get "/500" do
+    "Hello World!" if hello == world
+    erb ""
+  end
+
+  TEMPLATE = <<-HTML
+  <html>
+  <head>
+    <title>Rack WebProfiler test — Sinatra</title>
+  </head>
+  <body>
+    <p>
+      <a href="./">text/html page</a>
+      - <a href="./without_profiler">text/plain page</a>
+      - <a href="./500">500 page</a>
+    </p>
+    <%= yield %>
+  </body>
+  </html>
+  HTML
+end

data/examples/sinatra/config.ru

@@ -0,0 +1,3 @@
+require File.expand_path("../app.rb", __FILE__)
+
+run App

data/lib/rack/templates/404.erb

@@ -0,0 +1 @@
+404

data/lib/rack/templates/assets/rwpt.css

@@ -0,0 +1,9 @@
+/*! normalize.css v3.0.3 | MIT License | github.com/necolas/normalize.css */img,legend{border:0}legend,td,th{padding:0}html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,optgroup,strong{font-weight:700}dfn{font-style:italic}h1{font-size:2em;margin:.67em 0}mark{background:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{box-sizing:content-box;height:0}pre,textarea{overflow:auto}code,kbd,pre,samp{font-family:monospace,monospace;font-size:1em}button,input,optgroup,select,textarea{color:inherit;font:inherit;margin:0}button{overflow:visible}button,select{text-transform:none}button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}input{line-height:normal}input[type=checkbox],input[type=radio]{box-sizing:border-box;padding:0}input[type=number]::-webkit-inner-spin-button,input[type=number]::-webkit-outer-spin-button{height:auto}input[type=search]{-webkit-appearance:textfield;box-sizing:content-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}table{border-collapse:collapse;border-spacing:0}
+
+#rack-webprofiler {
+  top: 0;
+}
+
+body {
+  margin-top: 50px;
+}