nested-benchmark 0.8.0

data/HISTORY

@@ -0,0 +1,7 @@
+= History
+
+== 0.8.0, 2007-12-04
+
+Initial public release with basic features and a little testing.
+
+* TODO: Build out tests, move output to ruport

data/README

@@ -0,0 +1,72 @@
+= Nested Benchmark
+
+== Author
+
+Bruce Williams <bruce@codefluency.com>
+http://codefluency.com
+
+== Synopsis
+
+The purpose of the nested-benchmark library is to add simple support for:
+* Named, nested benchmarks that you don't have to keep track of to output later
+* Blocks of code you want ignored by the benchmarks
+
+== Usage
+
+Requiring the library is intentionally similar to the Ruby Standard Library 'benchmark'
+
+  require 'benchmark/nested'
+  
+Note that it's 'benchmark/nested' and NOT 'nested/benchmark'
+
+This adds two methods to Object; +benchmark+ and +ignore+.  Here's an example of usage:
+
+  benchmark "Insert 30 records" do
+    ignore do 
+      # Some database setup you don't want benchmarked
+    end
+    1.upto(30) do |number|
+      benchmark "Prepare record ##{number} for insertion" do
+        sleep rand(0.3)
+        # something that takes some time
+      end
+      sleep rand(0.1)
+      # insert into database
+    end
+  end
+  
+Afterwards, you can get the results by:
+
+  puts Benchmark::CAPTION # Just for some headers
+  NestedBenchmark.each do |benchmark|
+    # Note these are the toplevel benchmarks
+    puts benchmark
+  end
+
+and get something like:
+  
+  user       system     total      real
+  0.010000   0.000000   0.010000 ( 25.789001) Insert 30 records
+  0.000000   0.000000   0.000000 (  0.409687) > Prepare record #1 for insertion
+  0.000000   0.000000   0.000000 (  0.332127) > Prepare record #2 for insertion
+  0.000000   0.000000   0.000000 (  0.774727) > Prepare record #3 for insertion
+  0.000000   0.000000   0.000000 (  0.522462) > Prepare record #4 for insertion
+  0.000000   0.000000   0.000000 (  0.099711) > Prepare record #5 for insertion
+  
+You could also crawl the benchmarks manually if you want:
+
+  NestedBenchmark.each do |benchmark|
+    benchmark.each do |child|
+      child.each do |grandchild|
+        # ...
+      end
+    end
+  end
+
+== Caveats
+
+Don't put a +benchmark+ inside an +ignore+.
+
+It doesn't really make any sense, and neither will the results.
+
+  

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rake/testtask'
+require 'rubygems/specification'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+
+task :default => :test
+
+Rake::TestTask.new do |t| 
+  t.libs       = %w(lib)
+  t.test_files = FileList["test/**/*.rb"]
+end
+
+Rake::RDocTask.new do |d|
+  d.main = "README"
+  d.rdoc_files.include("README", "HISTORY", "lib/**/*.rb")
+end
+
+PKG_VERSION = '0.8.0'
+PKG_FILES = FileList['**/*'].exclude(/CVS|\.svn|pkg|coverage|Makefile|doc|rdoc|html/)
+GEMSPEC = Gem::Specification.new do |s|
+  s.name = 'nested-benchmark'
+  s.version = PKG_VERSION
+  s.summary = "Support for nested bechmarking and ignored blocks"
+  s.description = "Add support for simple named benchmarking blocks, blocks to ignore during benchmarking, and output of benchmarks"
+  s.files = PKG_FILES
+  s.require_path = 'lib'
+
+  s.has_rdoc = true
+  s.rdoc_options <<
+    '--main' << 'NestedBenchmark' << '--line-numbers'
+
+  s.author = "Bruce Williams"
+  s.email = "bruce@codefluency.com"
+  s.homepage = "http://codefluency.rubyforge.org/nested-benchmark"
+  s.rubyforge_project = "codefluency"
+end
+
+Rake::GemPackageTask.new(GEMSPEC) do |pkg|
+  pkg.need_tar = true
+  pkg.package_files += PKG_FILES
+end
+

data/lib/benchmark/nested.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) << "/nested/benchmark"
+
+class Object
+  include NestedBenchmark
+end

data/lib/benchmark/nested/benchmark.rb

@@ -0,0 +1,81 @@
+require File.dirname(__FILE__) << '/tms_ext'
+
+module NestedBenchmark
+  
+  class << self
+    
+    include Enumerable
+    
+    def each(&block)
+      benchmarks.each(&block)
+    end
+    
+    def benchmarks
+      @benchmarks ||= []
+    end
+    
+    def children_stack
+      @children_stack ||= []
+    end
+    
+    def ignores
+      @ignores ||= []
+    end
+    
+    def included(base)
+      base.__send__(:include, InstanceMethods)
+    end
+    
+    def ignore_in_parent(offset)
+      NestedBenchmark.ignores.last << offset unless NestedBenchmark.ignores.empty?
+    end
+    
+    def ignore
+      offset = sum(NestedBenchmark.ignores.pop)
+      ignore_in_parent offset
+      offset
+    end
+    
+    def calculate(&block)
+      NestedBenchmark.ignores << []
+      yield - ignore
+    end
+    
+    def reset!
+      benchmarks.clear
+    end
+    
+    def sum(benchmarks)
+      benchmarks.inject(Benchmark::Tms.new) do |result, benchmark|
+        result + benchmark
+      end
+    end
+    
+    def add(benchmark)
+      if NestedBenchmark.children_stack.empty?
+        NestedBenchmark.benchmarks << benchmark
+      else
+        NestedBenchmark.children_stack.last << benchmark
+      end
+      benchmark
+    end
+    
+  end
+  
+  module InstanceMethods
+    
+    def benchmark(name=nil, &block)
+      NestedBenchmark.children_stack << []
+      result = NestedBenchmark.calculate { Benchmark.measure(&block) }
+      result.label = name
+      result.children = NestedBenchmark.children_stack.pop
+      NestedBenchmark.add result
+    end
+    
+    def ignore(&block)
+      NestedBenchmark.ignores.last << Benchmark.measure(&block)
+    end
+    
+  end
+  
+end

data/lib/benchmark/nested/tms_ext.rb

@@ -0,0 +1,32 @@
+require 'benchmark'
+
+module Benchmark
+  
+  class Tms
+    
+    include Enumerable
+    
+    attr_accessor :label
+    attr_writer :children
+    def children
+      @children ||= []
+    end
+    
+    def each(&block)
+      children.each(&block)
+    end
+    
+    def to_s(indent=0)
+      lines = []
+      lines << format(FMTSTR).rstrip
+      indenter = ('>' * indent) + ' ' if indent > 0
+      lines.last << " #{indenter}#{@label}"
+      children.each do |child|
+        lines << child.to_s(indent + 1)
+      end
+      lines.join("\n")
+    end
+    
+  end
+  
+end

data/test/nested_benchmark_test.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'test/spec'
+
+require File.dirname(__FILE__) << "/test_helper"
+
+context "Nested Benchmark" do
+  
+  specify "can use in arbitrary objects" do
+    assert_supports_benchmarking_in Object.new
+    assert_supports_benchmarking_in self
+    assert_supports_benchmarking_in Class.new
+    assert_supports_benchmarking_in Class.new.new
+  end
+  
+  specify "benchmark returns a benchmark with children" do
+    b = benchmark { benchmark { } }
+    assert_kind_of Benchmark::Tms, b
+    assert_kind_of Array, b.children
+    assert_respond_to b, :each
+    b.each do |c|
+      assert_kind_of Benchmark::Tms, c
+    end
+  end
+  
+  specify "can reset toplevel benchmarks" do
+    benchmark { benchmark { } }
+    assert 1, benchmarks.size
+    NestedBenchmark.reset!
+    assert 0, benchmarks.size
+  end
+  
+  #######
+  private
+  #######
+  
+  def benchmarks
+    NestedBenchmark.benchmarks
+  end
+
+  def assert_supports_benchmarking_in(object)
+    %w(benchmark ignore).all? { |m| object.respond_to?(m) }
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+$:.unshift File.dirname(__FILE__) + "/../lib"
+
+require 'benchmark/nested'

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: nested-benchmark
+version: !ruby/object:Gem::Version 
+  version: 0.8.0
+date: 2007-12-04 00:00:00 -06:00
+summary: Support for nested bechmarking and ignored blocks
+require_paths: 
+- lib
+email: bruce@codefluency.com
+homepage: http://codefluency.rubyforge.org/nested-benchmark
+rubyforge_project: codefluency
+description: Add support for simple named benchmarking blocks, blocks to ignore during benchmarking, and output of benchmarks
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Bruce Williams
+files: 
+- HISTORY
+- lib
+- lib/benchmark
+- lib/benchmark/nested
+- lib/benchmark/nested/benchmark.rb
+- lib/benchmark/nested/tms_ext.rb
+- lib/benchmark/nested.rb
+- Rakefile
+- README
+- test
+- test/nested_benchmark_test.rb
+- test/test_helper.rb
+test_files: []
+
+rdoc_options: 
+- --main
+- NestedBenchmark
+- --line-numbers
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+