easybench 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 jameswilding
+
+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.markdown

@@ -0,0 +1,64 @@
+# bme: benchmark everything
+
+BME is a simple wrapper around ruby's Benchmark library which helps you write benchmark code that is clearer, simpler, and more meaningful.
+
+A normal benchmark with the 'benchmark' library can quickly get untidy:
+
+	require 'benchmark'
+
+	iterations = 100,000
+
+	Benchmark.bm do	|bm|
+	  bm.report 'some_method' do
+	    iterations.times { Library.some_method(args) }
+	  end
+	end
+
+As you add more benchmarks, those iterations will start to get in the way of the important code. A benchmark with BME is cleaner -- the code being tested is more apparent:
+
+	require 'bme'
+	
+	BME.benchmark do |bm|
+	  bm.report 'some_method' do
+	    Library.some_method(args)
+	  end
+	end
+
+By default, BME iterates over each piece of code 100,000 times. Use the :iterations option to override the default behaviour for all benchmarks:
+
+	BME.benchmark(:iterations => 500) do |bm|
+	  # ...
+	end
+
+Or on a per-benchmark basis:
+
+	BME.benchmark do |bm|
+	  bm.report 'some_method' do
+	    Library.some_method(args)
+	  end
+
+	  bm.report 'other_method', :iterations => 500 do
+	    Library.other_method(args)
+	  end
+	end
+
+That's it!
+
+## Installation
+
+	$ gem install bme --source http://gemcutter.org
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2009 James Wilding. See LICENSE for details.

data/README.rdoc

@@ -0,0 +1,18 @@
+= easybench
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 jameswilding. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "easybench"
+    gem.summary = %Q{Cleaner, simpler ruby benchmarks}
+    gem.description = %Q{A simple wrapper around ruby's Benchmark library for cleaner, simpler benchmark tests}
+    gem.email = "james@jameswilding.net"
+    gem.homepage = "http://github.com/jameswilding/easybench/"
+    gem.authors = ["jameswilding"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_development_dependency "redgreen"    
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test #=> :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "easybench #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/easybench.gemspec

@@ -0,0 +1,61 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{easybench}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["jameswilding"]
+  s.date = %q{2009-10-24}
+  s.description = %q{A simple wrapper around ruby's Benchmark library for cleaner, simpler benchmark tests}
+  s.email = %q{james@jameswilding.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "easybench.gemspec",
+     "examples/benchmark.rb",
+     "lib/easybench.rb",
+     "test/benchmark_test.rb",
+     "test/easybench_test.rb",
+     "test/suite_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jameswilding/easybench/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Cleaner, simpler ruby benchmarks}
+  s.test_files = [
+    "test/benchmark_test.rb",
+     "test/easybench_test.rb",
+     "test/suite_test.rb",
+     "test/test_helper.rb",
+     "examples/benchmark.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<redgreen>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<redgreen>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<redgreen>, [">= 0"])
+  end
+end

data/examples/benchmark.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/../lib/bme'
+
+Easybench.bm do |bm|
+  bm.report 'Adding' do
+    1 + 1
+  end
+  
+  bm.report 'Subtracting' do
+    1 - 1
+  end
+  
+  bm.report 'Division', :iterations => 200000 do
+    1 / 1
+  end
+  
+end

data/lib/easybench.rb

@@ -0,0 +1,86 @@
+require 'benchmark'
+
+module Easybench # BenchMark Everything
+  
+  DEFAULT_ITERATIONS = 100000
+  
+  class << self
+    # Use :iterations => n to set n number of iterations (defaults to 100,000)
+    def bm(options = {}, &block)
+      suite = Suite.new(options[:iterations] || 100000, &block)
+
+      if options[:run] == false
+        suite
+      else
+        suite.run
+      end
+    end
+  end
+  
+  class Benchmark
+    
+    attr_reader :options
+    attr_reader :tests
+    
+    def initialize(name, options = {}, &tests)
+      @name    = name
+      @options = options
+      @tests   = tests
+    end
+    
+    def name(indent = nil)
+      indent ? @name.rjust(indent) : @name
+    end
+    
+    def iterations
+      @options[:iterations]
+    end
+        
+  end
+
+  class Suite
+    # Raised when two benchmark tests with the same name are defined
+    class DuplicateBenchmark < StandardError; end
+
+    attr_reader :tests
+    attr_reader :benchmarks    
+
+    def initialize(iterations, &tests)
+      @iterations = iterations
+      @tests      = tests
+      @benchmarks = []      
+    end
+
+    def add_benchmark(name, options = {}, &block)
+      if benchmark_defined?(name)
+        raise DuplicateBenchmark, "A benchmark test called '#{name}' has already been defined"
+      else
+        @benchmarks << Easybench::Benchmark.new(name, options, &block)
+      end
+    end
+
+    alias :report :add_benchmark
+
+    def run(runner = ::Benchmark)
+      @tests.call(self)
+
+      runner.bm do |interface|
+        @benchmarks.each do |benchmark|
+          interface.report(benchmark.name(indent)) do
+            (benchmark.iterations || @iterations).times(&benchmark.tests)
+          end
+        end
+      end
+    end
+        
+    private
+    def benchmark_defined?(name)
+      @benchmarks.any? { |benchmark| benchmark.name == name }
+    end
+
+    def indent
+      @indent ||= @benchmarks.map { |b| b.name }.sort.last.length      
+    end
+
+  end
+end

data/test/benchmark_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+class BenchmarkTest < Test::Unit::TestCase
+
+  context 'a BME::Benchmark instance' do
+    should 'initialize with name' do
+      name = 'test'
+      bm   = create_benchmark(name)
+
+      assert_equal name, bm.name
+    end
+    
+    should 'initialize with options' do
+      name    = 'test'
+      options = {:iterations => 10}
+      bm      = create_benchmark(name, options)
+      
+      assert_equal options, bm.options
+    end
+    
+    should 'know how many times to iterate' do
+      bm = create_benchmark('test', :iterations => 10)
+      
+      assert_equal 10, bm.iterations
+    end
+        
+    should 'initialize with a block' do
+      name    = 'test'
+      tests   = lambda { 1 + 1 }
+      bm      = create_benchmark(name, &tests)
+      
+      assert_equal tests, bm.tests
+    end
+    
+    should 'indent its name if requested to' do
+      name = 'test'
+      bm   = create_benchmark(name)
+      
+      assert_equal name, bm.name
+      assert_equal name.rjust(10), bm.name(10)
+    end
+    
+  end
+
+  def create_benchmark(name, options = {}, &block)
+    Easybench::Benchmark.new(name, options, &block)
+  end
+  
+end

data/test/easybench_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+class BmeTest < Test::Unit::TestCase
+  
+  context 'Easybench' do
+    should 'initiate a benchmark suite without a block' do
+      assert_nothing_raised { suite = Easybench.bm(:run => false) }
+    end
+    
+    should 'initialize a benchmark suite with a block' do
+      tests = lambda { |bm| bm.report('adding') { 1 + 1 } }
+      suite = Easybench.bm({:run => false}, &tests)
+      
+      assert_kind_of Easybench::Suite, suite
+      assert_not_nil suite.tests
+      assert_equal   tests, suite.tests
+    end    
+  end  
+end

data/test/suite_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+class SuiteTest < Test::Unit::TestCase
+  
+  context 'a BME::Suite instance' do
+    
+    setup { @suite = Easybench.bm(:run => false) }
+    
+    context 'initialized without a block' do
+      should 'have no benchmarks' do
+        assert @suite.benchmarks.empty?
+      end
+    end
+    
+    context 'initializing with a block' do
+      should 'add benchmarks from the block' do
+        @suite.add_benchmark('adding') { 1 + 1 }
+        assert_equal 1, @suite.benchmarks.length
+      end
+      
+      should 'add benchmarks as BME::Becnhmark objects' do
+        @suite.add_benchmark('adding') { 1 + 1 }
+        assert_kind_of Easybench::Benchmark, @suite.benchmarks.last
+      end
+
+      should 'set individual benchmark options' do
+        options = {:iterations => 10}
+        @suite.add_benchmark('subtracting', options) { 1 - 1 }
+        assert_equal options, @suite.benchmarks.last.options
+      end
+
+      should 'raise an exception when a duplicate benchmark is added' do
+        assert_raises(Easybench::Suite::DuplicateBenchmark) do
+          @suite.add_benchmark('adding') { 1 + 1 }
+          @suite.add_benchmark('adding') { 1 + 1 }
+        end
+      end
+      
+    end    
+  end
+    
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'redgreen'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'easybench'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: easybench
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- jameswilding
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-24 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: redgreen
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A simple wrapper around ruby's Benchmark library for cleaner, simpler benchmark tests
+email: james@jameswilding.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- README.rdoc
+- Rakefile
+- VERSION
+- easybench.gemspec
+- examples/benchmark.rb
+- lib/easybench.rb
+- test/benchmark_test.rb
+- test/easybench_test.rb
+- test/suite_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/jameswilding/easybench/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Cleaner, simpler ruby benchmarks
+test_files: 
+- test/benchmark_test.rb
+- test/easybench_test.rb
+- test/suite_test.rb
+- test/test_helper.rb
+- examples/benchmark.rb