benchmark_to_js 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 479d8472107c4f042a7e784c953ad551499d9424
+  data.tar.gz: 3beb181cba8a22ba2cb40096a75a5fa2b3987579
+SHA512:
+  metadata.gz: b200b8b9abba932732509b0cd7a6d0016e19c501727c8e64bcac980c1e01f062efbfda3badb64bb5b31829bf4e16ad1d882bc41e89b3129fb13d8e84836392ae
+  data.tar.gz: f72afd1938772a01f40d76b8d0667af843eae506a2634adbebd032747854dd2bc95c35f2fee0a64ce124c1dde4c753d7f5db04343cb7dc1c4e171c9bd352da92

data/.gitignore

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

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 dave@tanda.co. 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 @@
+source 'https://rubygems.org'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dave Allie
+
+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,83 @@
+# BenchmarkToJs
+
+This gem allows you to benchmark render times for sections of views and partials, and outputs those times to the Javascript console.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'benchmark_to_js'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install benchmark_to_js
+
+## Configuration
+
+By default, the benchmarking will only run in the Rails development environment, however this behaviour can be overridden in an initializer along with several other settings.
+
+```ruby
+# config/initializers/benchmark_to_js.rb
+BenchmarkToJs.configure do |config|
+  config.run_in_environments = [:development, :staging] # default [:development]
+
+  # see below for examples on pretty enabled/disabled output
+  config.pretty = true # default true
+
+  # the following only apply if pretty if set to true
+  # minimum milliseconds before time is highlighted in respective colour
+  config.red_threshold = 1000   # default 2000
+  config.orange_threshold = 200 # default 500
+end
+```
+
+Please note that it is **NOT** recommended to configure this gem to run your production environment!
+
+## Usage
+
+To use, just wrap a section of a view in a `benchmark_to_js(name)` block, like so:
+
+### ERB
+```erb
+<%= benchmark_to_js("my content") do %>
+  <h1>Some Header</h1>
+  <%= some_intensive_methods %>
+  ...
+<% end %>
+```
+
+### Haml
+```haml
+= benchmark_to_js("my content") do
+  %h1 Some Header
+  = some_intensive_methods
+  ...
+```
+
+Both methods will render the content as if it wasn't in the block, and a line will be logged to the Javascript console: `'my content' ran in 123.456ms`.
+
+If pretty formatting is enabled (it is by default) then your output will look something like this:
+![Pretty console output](img/pretty.png)
+
+and if it isn't, well then it will look bland, like this:
+![Bland console output](img/bland.png)
+
+That's all there is to it!
+
+## Development
+
+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]/benchmark_to_js. 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 @@
+require "bundler/gem_tasks"

data/benchmark_to_js.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'benchmark_to_js/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "benchmark_to_js"
+  spec.version       = BenchmarkToJs::VERSION
+  spec.authors       = ["Dave Allie"]
+  spec.email         = ["dave@daveallie.com"]
+
+  spec.summary       = %q{Benchmarks content in views and logs times to JS console.}
+  spec.description   = %q{Benchmarks content in views and logs times to the Javascript console.}
+  spec.homepage      = "https://github.com/daveallie/benchmark_to_js"
+  spec.license       = "MIT"
+
+  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.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "benchmark_to_js"
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/benchmark_to_js/configuration.rb

@@ -0,0 +1,26 @@
+module BenchmarkToJs
+  class Configuration
+    attr_accessor :run_in_environments, :pretty, :orange_threshold, :red_threshold
+
+    def initialize
+      self.run_in_environments = [:development]
+      self.pretty = true
+      self.orange_threshold = 500
+      self.red_threshold = 2000
+    end
+
+    def run?
+      @run ||= begin
+        defined?(Rails) && Array(self.run_in_environments).map(&:to_s).include?(Rails.env)
+      end
+    end
+  end
+
+  def self.configuration
+    @configuration ||=  Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+end

data/lib/benchmark_to_js/railtie.rb

@@ -0,0 +1,8 @@
+require 'benchmark_to_js/view_helpers'
+module BenchmarkToJs
+  class Railtie < Rails::Railtie
+    initializer 'benchmark_to_js.view_helpers' do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/benchmark_to_js/version.rb

@@ -0,0 +1,3 @@
+module BenchmarkToJs
+  VERSION = "0.1.0"
+end

data/lib/benchmark_to_js/view_helpers.rb

@@ -0,0 +1,28 @@
+module BenchmarkToJs
+  module ViewHelpers
+    def benchmark_to_js(name = 'block', &block)
+      if BenchmarkToJs.configuration.run?
+        ret = ''
+        time = Benchmark.ms {ret = capture(&block)}
+
+        message = if BenchmarkToJs.configuration.pretty
+          color = if time >= BenchmarkToJs.configuration.red_threshold
+            'red'
+          elsif time >= BenchmarkToJs.configuration.orange_threshold
+            'darkorange'
+          else
+            'green'
+          end
+
+          %Q("%c #{escape_javascript(name)} %c ran in %c#{time.round(5)}ms", 'background: #222; color: #bada55', '', 'color:#{color}')
+        else
+          %Q("'#{escape_javascript(name)}' ran in #{time.round(5)}ms")
+        end
+
+        ret + javascript_tag(%Q(console.log(#{message})))
+      else
+        capture(&block)
+      end
+    end
+  end
+end

data/lib/benchmark_to_js.rb

@@ -0,0 +1,3 @@
+require 'benchmark_to_js/version'
+require 'benchmark_to_js/configuration'
+require 'benchmark_to_js/railtie' if defined?(Rails)

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: benchmark_to_js
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dave Allie
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: Benchmarks content in views and logs times to the Javascript console.
+email:
+- dave@daveallie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark_to_js.gemspec
+- bin/console
+- bin/setup
+- img/bland.png
+- img/pretty.png
+- lib/benchmark_to_js.rb
+- lib/benchmark_to_js/configuration.rb
+- lib/benchmark_to_js/railtie.rb
+- lib/benchmark_to_js/version.rb
+- lib/benchmark_to_js/view_helpers.rb
+homepage: https://github.com/daveallie/benchmark_to_js
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Benchmarks content in views and logs times to JS console.
+test_files: []