rake_report 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 582c706a204224045d68a5198235d991df33a893
+  data.tar.gz: a4b6bc79eaeeeecdc640e785490b0e296559094b
+SHA512:
+  metadata.gz: 6691a3e8f13db4b29df9452ef187456283e8638556459bcc2ffe5b3f2cb31ef99dbbd0ee316dcfb96f2c34ebaf878e793d477e0c795ec12040b1d651524fd415
+  data.tar.gz: 4e0efb7e3899d5a8372f9a943c99505b6e118da64385523be33e1db457058ea504c9cb4ee5466caf78b2d4ab42710a1154118a235ca0bb1239aea929324dae49

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rake_report.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Steve Adams
+
+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,42 @@
+# RakeReport
+
+Generates timeline reports of rake runs. Useful for debugging parallelization
+and performance issues in complex rake configurations
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rake_report'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rake_report
+
+## Usage
+
+Add the following two lines to the top of your Rakefile:
+
+```ruby
+require 'rake_report'
+RakeReport.html("rake_report_#{ARGV.join('_').gsub(/:/, '-')}.html")
+```
+
+Rake will then output an html file (rake_report_*.html) that includes a Google
+DataTable formatted for the Timeline visualization API:
+
+https://developers.google.com/chart/interactive/docs/gallery/timeline#data-format
+
+## Contributing
+
+1. Fork it ( https://github.com/optimizely/rake_report/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+end
+task :default => :spec

data/lib/rake_report.rb

@@ -0,0 +1,38 @@
+require 'json'
+require 'rake'
+require 'rake_report/version'
+require 'rake_report/template'
+require 'rake_report/override'
+
+module RakeReport
+  @@times ||= {
+    cols: [{label: 'task', type: 'string'},
+           {label: 'type', type: 'string'},
+           {label: 'start', type: 'datetime'},
+           {label: 'end', type: 'datetime'}],
+    rows: []
+  }
+
+  class << self
+    def html(filename='rake_report.html')
+      at_exit do
+        RakeReportTemplate.new(@@times).save(filename)
+      end
+    end
+
+    def add_time(label, type, start, finish)
+      @@times[:rows].push({c:[{v:label},
+                              {v:type},
+                              {v:start.strftime("Date(%Y, %-m, %-d, %k, %M, %S, %L)")},
+                              {v:finish.strftime("Date(%Y, %-m, %-d, %k, %M, %S, %L)")}]})
+    end
+
+    def times
+      @@times
+    end
+
+    def to_json
+      JSON.generate(@@times)
+    end
+  end
+end

data/lib/rake_report/override.rb

@@ -0,0 +1,22 @@
+module Rake
+  class Task
+    def execute_with_time(*args)
+      start = Time.now
+      execute_without_time(*args)
+      finish = Time.now
+      RakeReport.add_time(name, 'execute', start, finish)
+    end
+
+    def invoke_with_time(*args)
+      start = Time.now
+      invoke_without_time(*args)
+      finish = Time.now
+      RakeReport.add_time(name, 'invoke', start, finish)
+    end
+
+    alias :execute_without_time :execute
+    alias :execute :execute_with_time
+    alias :invoke_without_time :invoke
+    alias :invoke :invoke_with_time
+  end
+end

data/lib/rake_report/template.rb

@@ -0,0 +1,64 @@
+require 'erb'
+
+class RakeReportTemplate
+  attr_accessor :colors, :template, :timers
+  def initialize(timers)
+    @colors = %w(#50ABD2 #78B653 #CAD04F #ED913D #E8182E)
+    @template = template
+    @timers = timers
+  end
+  
+  def template
+    %q{
+    <html>
+      <head>
+        <script type="text/javascript" src="https://www.google.com/jsapi"></script>
+        <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
+        <script type="text/javascript">
+          var jsonData = <%= timers.to_json %>;
+
+          google.load("visualization", "1", {packages:["timeline"]});
+          google.setOnLoadCallback(drawChart);
+
+          function drawChart() {
+            var dataTable = new google.visualization.DataTable(jsonData);
+            var container = document.getElementById('timeline');
+            var chart = new google.visualization.Timeline(container);
+
+            // If the number of rows exceeds the length of the color array
+            // the chart shows every row with the same color. This is prettier.
+            var color_palatte = <%= colors.to_json %>;
+            var colors = new Array();
+            for(var i=0; i < dataTable.getNumberOfRows(); i++) {
+              colors.push(color_palatte[i % color_palatte.length]);
+            }
+            var options = {
+              colors: colors,
+              timeline: {
+                showBarLabels: false,
+                colorByRowLabel: true,
+                groupByRowLabel: true
+              }
+            };
+
+            chart.draw(dataTable, options);
+          }
+        </script>
+      </head>
+      <body>
+        <div id="timeline" style="height: 100%"></div>
+      </body>
+    </html>
+    }
+  end
+
+  def render
+    ERB.new(@template).result(binding)
+  end
+
+  def save(file)
+    File.open(file, 'w') do |f|
+      f.write(render)
+    end
+  end
+end

data/lib/rake_report/version.rb

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

data/rake_report.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rake_report/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rake_report"
+  spec.version       = RakeReport::VERSION
+  spec.authors       = ["Steve Adams"]
+  spec.email         = ["steve.adams@optimizely.com"]
+
+  spec.summary       = %q{Generate timing reports for rake tasks.}
+  spec.homepage      = "https://github.com/optimizely/rake_report"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3.0"
+  spec.add_development_dependency "json-schema", "~> 2.5.1"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rake_report
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Steve Adams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.1
+description: 
+email:
+- steve.adams@optimizely.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rake_report.rb
+- lib/rake_report/override.rb
+- lib/rake_report/template.rb
+- lib/rake_report/version.rb
+- rake_report.gemspec
+homepage: https://github.com/optimizely/rake_report
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Generate timing reports for rake tasks.
+test_files: []