bme 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/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "bme"
+    gem.summary = %Q{Cleaner, simpler ruby benchmarks}
+    gem.description = %Q{A simple wrapper around ruby's Benchmark library}
+    gem.email = "james@jameswilding.net"
+    gem.homepage = "http://github.com/jameswilding/bme"
+    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 = "bme #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/bme.rb

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

data/test/bme_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class BmeTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  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 'bme'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: bme
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- jameswilding
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-22 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
+email: james@jameswilding.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/bme.rb
+- test/bme_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/jameswilding/bme
+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/bme_test.rb
+- test/test_helper.rb