boot_polish 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.pairs

@@ -0,0 +1,21 @@
+pairs:
+  bw: Brent Wheeldon; brent
+  co: Cathy O'Connell; cathy
+  nm: Nick Monje; nmonje
+  eg: Evan Goodberry; egoodberry
+  bm: Ben Moss; bmoss
+  ck: Chien Kuo; ckuo
+  ec: Edwin Chong; echong
+  ab: Adam Berlin; aberlin
+  ra: Rasheed Abdul-Aziz; rabdulaziz
+  rm: Ryan McGarvey; ryan
+  jm: Johnny Mukai; johnny
+  js: James Somers; james
+  mt: Mark Thorn; mark
+  me: Maia Engeli; maia
+  mf: Michael Frederick; mike
+  gd: Geoffrey Ducharme; geoffrey
+  ak: Alex Kramer; alex
+email:
+  prefix: pair
+  domain: pivotallabs.com

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rake'
+end
+
+# Specify your gem's dependencies in boot_polish.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    boot_polish (0.0.1)
+      rubytree
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.0.8)
+    diff-lcs (1.1.3)
+    json (1.7.6)
+    method_source (0.8.1)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rake (10.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    rubytree (0.8.3)
+      json (>= 1.7.5)
+      structured_warnings (>= 0.1.3)
+    slop (3.3.3)
+    structured_warnings (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  boot_polish!
+  pry
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Rasheed Abdul-Aziz
+
+MIT License
+
+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,60 @@
+# BootPolish
+
+[![Build Status](https://travis-ci.org/zephyr-dev/boot_polish.png)](https://travis-ci.org/zephyr-dev/boot_polish)
+
+Boot time introspection to help you get under the heroku 60 second timeout.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'boot_polish'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install boot_polish
+
+## Usage
+
+Add the following line to your 'config/boot.rb' right after the require 'rubygems'
+
+    require 'boot_polish'
+
+I personally wrap it in a guard:
+
+    if ENV["BENCHMARK_REQUIRES"] && ENV["BENCHMARK_REQUIRES"] == 'true'
+      require 'boot_polish'
+    end
+
+During startup, you'll see all the requires and their associated times.
+The default renderer is leaf-first, where the very deepest require is shown first,
+with each subsequent outdentation showing the aggregate time for the require and 
+its children.
+
+For example:
+
+      0.0020 for require c/4
+      0.0187 for require c/3 
+      0.0009 for require c/2 
+        0.0002 for require c/1/z
+      0.0015 for require c/1 
+    0.0250 for require c
+    0.0002 for require b
+    0.0002 for require a 
+
+'a' and 'b' had no children requires
+'c' required c/1 (which required c/1/z), c/2, c/3 and c/4
+
+'c' had a time of 0.0250 which was a cumulative of it's time and all it's child requires.
+
+## Todo
+
+ * Make it possible to specify the renderer used by the require_benchmark
+ * Introduce some basic network logging (on socket)
+ * Introduce basic HTTP logging
+ * Introduce a plugin architecture for testing specific hogs (fog, postgress, etc) 
+  

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/boot_polish.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'boot_polish/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "boot_polish"
+  gem.version       = BootPolish::VERSION
+  gem.authors       = ["Rasheed Abdul-Aziz"]
+  gem.email         = ["rasheed@pivotallabs.com"]
+  gem.description   = %q{Boot time introspection to help you get under the heroku 60 second timeout.}
+  gem.summary       = %q{Boot time introspection to help you get under the heroku 60 second timeout.}
+  gem.homepage      = "https://github.com/zephyr-dev/boot_polish"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency "rubytree"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "pry"
+end

data/lib/boot_polish.rb

@@ -0,0 +1,10 @@
+require 'boot_polish/base'
+require 'boot_polish/nested_benchmark'
+require 'boot_polish/default_renderer'
+
+def require(file)
+  BootPolish::Base.require_benchmark.nest "require #{file}" do
+    super(file)
+  end
+end
+

data/lib/boot_polish/base.rb

@@ -0,0 +1,9 @@
+require 'boot_polish/nested_benchmark'
+
+module BootPolish 
+  class Base
+    def self.require_benchmark
+      @require_benchmark ||= NestedBenchmark.new
+    end
+  end
+end

data/lib/boot_polish/default_renderer.rb

@@ -0,0 +1,33 @@
+module BootPolish
+  class DefaultRenderer
+
+    def initialize(output = nil)
+      @output = output || STDOUT
+      @indent = -1
+    end
+
+    def descend
+      @indent += 1
+    end
+
+    def exception(method, exception)
+      @output << "#{indent}#{method} raised #{exception.message}\n"
+    end
+
+    def benchmark method, time
+      @output << format("#{indent}%.4f for #{method}\n", time.real)
+    end
+
+    def ascend
+      @indent -= 1
+    end
+
+    private
+
+    def indent
+      "  " * @indent
+    end
+
+  end
+
+end

data/lib/boot_polish/nested_benchmark.rb

@@ -0,0 +1,48 @@
+require 'benchmark'
+
+module BootPolish
+  class NestedBenchmark
+
+    attr_accessor :visitor
+
+    def initialize(visitor = nil)
+      @visitor = visitor || DefaultRenderer.new
+    end
+
+    def nest method, &block
+      result = nil
+
+      before_call
+
+      time_to_run = Benchmark.measure do
+        begin
+          result = yield
+        rescue Exception => e
+          after_call(method, nil, e)
+          raise e
+        end
+      end
+
+      after_call(method, time_to_run)
+
+      result
+    end
+
+    private
+    
+    def before_call 
+      @visitor.descend
+    end
+
+    def after_call(method, time_to_run, exception = nil)
+      if exception
+        @visitor.exception(method, exception)
+      else
+        @visitor.benchmark(method, time_to_run)
+      end
+
+      @visitor.ascend
+    end
+
+  end
+end

data/lib/boot_polish/tree_renderer.rb

@@ -0,0 +1,49 @@
+require 'tree'
+module BootPolish
+  class TreeRenderer
+
+    def initialize(output = nil)
+      @output = output || STDOUT
+      @tree = Tree::TreeNode.new("ROOT", "Root Content")
+      @current_node = @tree
+    end
+
+    def descend
+      new_node = Tree::TreeNode.new("node-#{@current_node.level}-#{@current_node.children.count}")
+      @current_node << new_node
+      @current_node = new_node
+    end
+
+    def exception(method, exception)
+      @current_node.content = { method: method, exception: exception }
+    end
+
+    def benchmark method, time
+      @current_node.content = { method: method, time: time }
+    end
+
+    def ascend
+      render(@current_node) if @current_node.parent.name == "ROOT"
+      @current_node = @current_node.parent
+    end
+    private
+
+    def render(current_node)
+      result = current_node.content
+      @output << "  " * (current_node.level - 1)
+      if result[:exception]
+        @output << "#{result[:method]} raised exception: #{result[:exception].message}"
+      else
+        @output << format("%.4f for #{result[:method]}", result[:time].real)
+      end
+      @output << "\n"
+
+      current_node.children.each do |child|
+        render child
+      end
+      @output.flush
+    end
+
+  end
+
+end

data/lib/boot_polish/version.rb

@@ -0,0 +1,3 @@
+module BootPolish
+  VERSION = "0.0.1"
+end

data/spec/boot_polish/base_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'boot_polish/base'
+
+module BootPolish 
+  describe Base do
+    describe ".require_benchmark" do
+      it "is memoized" do
+        BootPolish::Base.require_benchmark.should === BootPolish::Base.require_benchmark
+      end
+    end
+  end
+end

data/spec/boot_polish/default_renderer_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+require "boot_polish/default_renderer"
+
+module BootPolish
+  describe DefaultRenderer do
+    describe "instance" do
+
+      let(:output) { double(:output) }
+      let(:time) { double(:time, real: 9.99) }
+      let(:renderer) { DefaultRenderer.new(output) }
+
+      describe "#benchmark" do
+        it "outputs the method and real time" do
+          output.should_receive(:<<).with(/(footle)+/)
+
+          renderer.descend
+          renderer.benchmark("footle", time)
+          renderer.ascend
+        end
+      end
+
+      describe "#exception" do
+        it "outputs the method and the error" do
+          output.should_receive(:<<).with(/(footle)+.*(dootle)+/)
+
+          renderer.descend
+          renderer.exception("footle", Exception.new("dootle"))
+          renderer.ascend
+        end
+      end
+
+      describe "#ascend and #descend" do
+        it "indents two spaces for each descend after the first" do
+          output.should_receive(:<<).with(/footle/).ordered
+          output.should_receive(:<<).with(/^  .*wankle/).ordered
+          output.should_receive(:<<).with(/spittle/).ordered
+
+          renderer.descend
+          renderer.benchmark("footle", time)
+          renderer.descend
+          renderer.benchmark("wankle", time)
+          renderer.ascend
+          renderer.ascend
+
+          renderer.descend
+          renderer.benchmark("spittle", time)
+          renderer.ascend
+        end
+
+      end
+    end
+  end
+end
+

data/spec/boot_polish/nested_benchmark_spec.rb

@@ -0,0 +1,60 @@
+require "spec_helper"
+require "boot_polish/nested_benchmark"
+
+module BootPolish
+  describe NestedBenchmark do
+
+    describe "instance" do
+
+      let(:visitor) { double(:visitor, benchmark: nil, descend: nil, ascend: nil) }
+      let(:nested_benchmark) { NestedBenchmark.new( visitor ) }
+
+      describe "#visitor" do
+        context "is passed into new" do
+          it "is the same as the initalized value" do
+            nested_benchmark.visitor.should == visitor
+          end
+
+          it "can be changed" do
+            another_visitor = double(:another_visitor)
+            nested_benchmark.visitor = another_visitor
+            nested_benchmark.visitor.should == another_visitor
+          end
+        end
+
+        context "it is not passed into new" do
+          it "defaults to a new instance of DefaultRenderer" do
+            renderer = double(:renderer)
+            DefaultRenderer.should_receive(:new).and_return(renderer)
+
+            nested_benchmark = NestedBenchmark.new
+
+            nested_benchmark.visitor.should == renderer
+          end
+        end
+
+      end
+
+      describe "#nest" do
+        it "returns the blocks evaluated value" do
+          nested_benchmark.nest("holas") do
+            77
+          end.should == 77
+        end
+      end
+
+      it "visits and yields in the correct order" do
+        block_content = double(:block_content)
+
+        visitor.should_receive(:descend).ordered
+        block_content.should_receive(:yield!).ordered
+        visitor.should_receive(:benchmark).with("Hi", kind_of(Benchmark::Tms)).ordered
+        visitor.should_receive(:ascend).ordered
+
+        nested_benchmark.nest("Hi") do
+          block_content.yield!
+        end
+      end
+    end
+  end
+end

data/spec/boot_polish/tree_renderer_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+require "boot_polish/tree_renderer"
+
+module BootPolish
+  describe TreeRenderer do
+    describe "instance" do
+
+      let(:output) { double(:output) }
+      let(:time) { double(:time, real: 9.99) }
+      let(:renderer) { TreeRenderer.new(output) }
+
+      before do
+        output.should_receive(:flush).any_number_of_times
+        output.should_receive(:<<).with("\n").any_number_of_times
+      end
+
+      describe "#benchmark" do
+        it "outputs the method and real time" do
+          output.should_receive(:<<).with(/(footle)+/)
+          output.should_receive(:<<).with(anything).any_number_of_times
+
+          renderer.descend
+          renderer.benchmark("footle", time)
+          renderer.ascend
+        end
+      end
+
+      describe "#exception" do
+        it "outputs the method and the error" do
+          output.should_receive(:<<).with(/(footle)+.*(dootle)+/)
+          output.should_receive(:<<).with(anything).any_number_of_times
+
+          renderer.descend
+          renderer.exception("footle", Exception.new("dootle"))
+          renderer.ascend
+        end
+      end
+
+      describe "#ascend and #descend" do
+        it "indents two spaces for each descend after the first" do
+          output.should_receive(:<<).with("").ordered
+          output.should_receive(:<<).with(/footle/).ordered
+          output.should_receive(:<<).with("  ").ordered
+          output.should_receive(:<<).with(/wankle/).ordered
+          output.should_receive(:<<).with("").ordered
+          output.should_receive(:<<).with(/spittle/).ordered
+
+          renderer.descend
+          renderer.benchmark("footle", time)
+          renderer.descend
+          renderer.benchmark("wankle", time)
+          renderer.ascend
+          renderer.ascend
+
+          renderer.descend
+          renderer.benchmark("spittle", time)
+          renderer.ascend
+        end
+
+      end
+    end
+  end
+end
+

data/spec/boot_polish_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'boot_polish'
+
+describe "adding benchmarking aspects" do
+  describe ".require" do
+    it "benchmarks the require using require_benchmark.nest" do
+      benchmark = double(:benchmark)
+
+      benchmark.should_receive(:nest).
+        with("require fixtures/dummy.rb").
+        and_yield()
+
+      benchmark.should_receive(:nest).
+        any_number_of_times.
+        with(anything).
+        and_yield()
+
+
+      BootPolish::Base.should_receive(:require_benchmark).
+        any_number_of_times.
+        and_return(benchmark)
+
+      require('fixtures/dummy.rb').should be_true
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+require 'pry'
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+RSpec.configure do |config|
+  config.before(:each) do
+    @lib_dir = File.expand_path('../../lib', __FILE__)
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: boot_polish
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rasheed Abdul-Aziz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubytree
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Boot time introspection to help you get under the heroku 60 second timeout.
+email:
+- rasheed@pivotallabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .pairs
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- boot_polish.gemspec
+- lib/boot_polish.rb
+- lib/boot_polish/base.rb
+- lib/boot_polish/default_renderer.rb
+- lib/boot_polish/nested_benchmark.rb
+- lib/boot_polish/tree_renderer.rb
+- lib/boot_polish/version.rb
+- spec/boot_polish/base_spec.rb
+- spec/boot_polish/default_renderer_spec.rb
+- spec/boot_polish/nested_benchmark_spec.rb
+- spec/boot_polish/tree_renderer_spec.rb
+- spec/boot_polish_spec.rb
+- spec/fixtures/dummy.rb
+- spec/spec_helper.rb
+homepage: https://github.com/zephyr-dev/boot_polish
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3906148387546673340
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3906148387546673340
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Boot time introspection to help you get under the heroku 60 second timeout.
+test_files:
+- spec/boot_polish/base_spec.rb
+- spec/boot_polish/default_renderer_spec.rb
+- spec/boot_polish/nested_benchmark_spec.rb
+- spec/boot_polish/tree_renderer_spec.rb
+- spec/boot_polish_spec.rb
+- spec/fixtures/dummy.rb
+- spec/spec_helper.rb