benchmark_requires 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b07e2c540d6ec7f257cd936a9bb92717d539ce3
+  data.tar.gz: d6c3acf3bd94e9f79b01d0b3afa27d7ce39fbbe3
+SHA512:
+  metadata.gz: 853593d2b6935448749ac4f1e39d7f7aa863af035fe95dae9d239db15f0c576b5934cfa301475182b4a9e14449280e63ff514f6c73416820dbcc494d2d6b59ca
+  data.tar.gz: 6ca91dc35d13df8aff6a0f740cfaac89eb074f239fcbc61b844a7ab6b7c219643a142d782646e95b92ecc4bf529c5eaf2aefddcdee95264e73c8287978ee83e4

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Jon Daniel
+
+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,58 @@
+benchmark_requires
+==================
+
+BenchmarkRequires is a simple gem that helps identify slow loading libraries.
+
+As applications get older and more complex the start-up time tends to increase 
+quite dramatically. BenchmarkRequires helps by logging all requires/load and 
+load times.
+
+Idea inspired by http://nationbuilder.com/blistering_rails_performance_part_1_boot_performance
+
+## Usage
+
+To use benchmark_requires simply require and initialize the library as early in
+your application's loading process as possible. All necessary configuration will 
+be handled "just in time" when the first require/load is benchmarked.
+
+```ruby
+require 'benchmark_requires'
+BenchmarkRequires.setup!
+
+# now load the rest of your app
+```
+
+Startup your application and keep an eye on STDOUT (don't worry, you can
+change this too).
+
+## Using a Custom Logger and Log Action
+
+By default benchmark_requires uses `Logger` and all logged actions will be sent
+to `:debug`. Changing these defaults is easy. 
+ 
+```ruby
+require 'benchmark_requires'
+
+BenchmarkRequires.logger = Rails.logger
+BenchmarkRequires.logger = Logger.new STDERR
+BenchmarkRequires.logger = Logger.new nil
+
+BenchmarkRequires.log_action = proc do |logger, message|
+  logger.info message
+end
+
+# super basic log action.
+BenchmarkRequires.log_action = proc do |logger, message|
+  puts message
+end
+
+BenchmarkRequires.setup!
+ 
+# etc, etc, etc
+```
+
+## TODOs
+
+* More tests. 
+* Better support for custom loggers.
+* More Documentation.

data/Rakefile

@@ -0,0 +1,9 @@
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:test) 
+
+task :default => [:test]

data/lib/benchmark_requires.rb

@@ -0,0 +1,51 @@
+require "benchmark"
+require "logger"
+require "benchmark_requires/message_builder"
+require "benchmark_requires/runner"
+
+module BenchmarkRequires
+
+  class << self
+
+    attr_accessor :logger, :log_action
+    attr_accessor :setup, :runner
+
+    def benchmark file_name, &block
+      setup! unless setup?
+      self.runner.benchmark file_name, &block
+    end
+
+    def log message
+      self.log_action.call self.logger, message
+    end
+
+    def setup!
+      require "benchmark_requires/object_extension"
+
+      unless self.logger
+        logger = Logger.new(STDOUT)
+        logger.formatter = proc do |severity, datetime, progname, message|
+           "#{message}\n"
+        end
+        self.logger = logger
+      end
+
+      unless self.log_action
+        self.log_action = lambda do |logger, message|
+          logger.debug message
+        end
+      end
+
+      self.setup = true
+    end
+
+    def setup?
+      self.setup == true
+    end
+
+  end
+
+  self.setup = false
+  self.runner = Runner.new
+
+end

data/lib/benchmark_requires/message_builder.rb

@@ -0,0 +1,40 @@
+module BenchmarkRequires
+
+  class MessageBuilder
+
+    def initialize file_name, time
+      @file_name = file_name
+      @time = time.round 5
+    end
+
+    def message level 
+      "#{preamble(level)} -> #{colorize_file_name} took #{colorize_time} seconds."
+    end
+
+    private
+
+    def preamble level
+      (level - 1).times.map{|n| "  "}.join("") 
+    end
+
+    def colorize_file_name
+      "\e[1;37m#{@file_name}\e[0m"
+    end
+
+    def colorize_time
+      color = if @time <= 0.01 # green
+        "\e[0;32m"
+      elsif @time <= 0.25 # yellow
+        "\e[1;33m"
+      elsif @time <= 0.75 # red
+        "\e[1;31m"
+      else # OMFG RED!!!!
+        "\e[0;31m"
+      end
+ 
+      color + ("%f" % @time) + "\e[0m"
+    end
+
+  end
+
+end

data/lib/benchmark_requires/object_extension.rb

@@ -0,0 +1,20 @@
+class Object
+
+  def load file_name, wrap=false
+    result = nil
+    BenchmarkRequires.benchmark(file_name) do 
+      result = super(file_name, wrap)
+    end
+
+    return result 
+  end 
+
+  def require file_name
+    result = nil
+    BenchmarkRequires.benchmark(file_name) do
+      result = super(file_name)
+    end
+    return result 
+  end
+
+end

data/lib/benchmark_requires/runner.rb

@@ -0,0 +1,49 @@
+module BenchmarkRequires
+
+  class Runner
+
+    def initialize
+      @level = 0
+      @log_buffer = [] 
+    end
+
+    def benchmark(file_name, &block)
+      increment_level!
+      time = Benchmark.realtime do
+        yield
+      end
+
+      buffer_log MessageBuilder.new(file_name, time).message(@level)
+      decrement_level!
+      flush_log_buffer if top_level? 
+    end
+
+    private
+
+    def increment_level!
+      @level += 1
+    end
+
+    def decrement_level!
+      @level -= 1
+    end
+
+    def top_level?
+      @level == 0
+    end
+
+    def buffer_log message
+      @log_buffer << message 
+    end
+
+    def flush_log_buffer
+      @log_buffer.reverse.each{|msg| BenchmarkRequires.log(msg)}
+      BenchmarkRequires.log("")
+
+      @log_buffer = []
+    end
+
+  end
+
+
+end

data/lib/benchmark_requires/version.rb

@@ -0,0 +1,17 @@
+module BenchmarkRequires
+
+  VERSION = "1.0.0"
+
+  SUMMARY = "BenchmarkRequires is a simple gem that helps identify slow loading libraries."
+
+  DESCRIPTION = <<-EOF
+#{SUMMARY}
+
+As applications get older and more complex the start-up time tends to increase 
+quite dramatically. BenchmarkRequires helps by logging all requires/load and 
+load times.
+
+Idea inspired by http://nationbuilder.com/blistering_rails_performance_part_1_boot_performance
+EOF
+
+end

data/spec/lib/benchmark_requires/message_builder_spec.rb

@@ -0,0 +1,23 @@
+require 'benchmark_requires'
+
+describe BenchmarkRequires::MessageBuilder do
+
+  it "rounds times to 6 decimal places" do
+    time = 0.000001
+    builder = described_class.new('test.rb', time)
+    builder.message(1).should match /0\.000000/
+  end
+
+  it "includes file name" do
+    builder = described_class.new('test.rb', 1.00)
+    builder.message(1).should match /test\.rb/ 
+  end
+
+  it "indents based on level" do
+    builder = described_class.new('test.rb', 1.00)
+    builder.message(1).should match /^ \-\> / 
+    builder.message(2).should match /^(   \-\> )/ 
+    builder.message(3).should match /^(     \-\> )/ 
+  end
+
+end

data/spec/lib/benchmark_requires/runner_spec.rb

@@ -0,0 +1,28 @@
+require "benchmark_requires"
+
+describe BenchmarkRequires::Runner do
+
+  before(:each) do
+    BenchmarkRequires.setup!
+    BenchmarkRequires.logger = Logger.new nil
+  end
+
+  it "flushes buffer log after benchmark" do
+    BenchmarkRequires.should_receive(:log).twice
+
+    runner = described_class.new
+    runner.benchmark('test.rb') do
+      # nothing.
+    end
+  end
+
+  it "returns to top level after benchmark is complete" do
+    runner = described_class.new
+    runner.benchmark('test.rb') do
+      # nothing.
+    end
+
+    runner.send(:top_level?).should be_true
+  end
+
+end

data/spec/lib/benchmark_requires_spec.rb

@@ -0,0 +1,49 @@
+require 'benchmark_requires'
+
+describe BenchmarkRequires do
+
+  before(:each) do
+    described_class.logger = Logger.new(nil)
+  end
+
+  context "post-setup" do
+
+    before(:each) do
+      described_class.setup!
+    end
+
+    it "reports as being setup" do
+      described_class.setup?.should eql true
+    end
+
+    it "sets up sane defaults" do
+      logger = described_class.logger
+
+      logger.should be
+      logger.should respond_to :debug
+
+      log_action = described_class.log_action
+      log_action.should be_a Proc
+
+      logger.should_receive(:debug).with("test123")
+      log_action.call(logger, "test123")
+    end
+
+    describe "#log" do
+
+      it "uses logger and log_action" do
+        logger = described_class.logger
+        log_action = described_class.log_action
+        message = "test123"
+        
+        logger.should_receive(:debug).with message
+
+        described_class.log message
+      end
+
+    end
+
+  end
+
+end
+

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: benchmark_requires
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jon Daniel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: "BenchmarkRequires is a simple gem that helps identify slow loading libraries.\n\nAs
+  applications get older and more complex the start-up time tends to increase \nquite
+  dramatically. BenchmarkRequires helps by logging all requires/load and \nload times.\n\nIdea
+  inspired by http://nationbuilder.com/blistering_rails_performance_part_1_boot_performance\n"
+email: binarycleric@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/benchmark_requires/message_builder.rb
+- lib/benchmark_requires/object_extension.rb
+- lib/benchmark_requires/runner.rb
+- lib/benchmark_requires/version.rb
+- lib/benchmark_requires.rb
+- LICENSE
+- README.md
+- spec/lib/benchmark_requires/message_builder_spec.rb
+- spec/lib/benchmark_requires/runner_spec.rb
+- spec/lib/benchmark_requires_spec.rb
+- Rakefile
+homepage: http://www.github.com/binarycleric/benchmark_requires
+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.0.5
+signing_key: 
+specification_version: 4
+summary: BenchmarkRequires is a simple gem that helps identify slow loading libraries.
+test_files:
+- spec/lib/benchmark_requires/message_builder_spec.rb
+- spec/lib/benchmark_requires/runner_spec.rb
+- spec/lib/benchmark_requires_spec.rb
+- Rakefile