benchmark_harness 0.0.0

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm ree@bh

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+gem "easystats"
+
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem "ruby-debug"
+  gem "mocha"
+end

data/Gemfile.lock

@@ -0,0 +1,40 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    easystats (0.0.7)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    linecache (0.43)
+    mocha (0.9.12)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  easystats
+  jeweler (~> 1.5.2)
+  mocha
+  rcov
+  rspec (~> 2.3.0)
+  ruby-debug

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Daniel Higginbotham
+
+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.rdoc

@@ -0,0 +1,19 @@
+= benchmark_harness
+
+Description goes here.
+
+== Contributing to benchmark_harness
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Daniel Higginbotham. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "benchmark_harness"
+  gem.homepage = "http://github.com/flyingmachine/benchmark_harness"
+  gem.license = "MIT"
+  gem.summary = %Q{harness for running benchmark multiple times and running stats on the results}
+  gem.description = %Q{harness for running benchmark multiple times and running stats on the results}
+  gem.email = "daniel@flyingmachinestudios.com"
+  gem.authors = ["Daniel Higginbotham"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "benchmark_harness #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/benchmark_harness.gemspec

@@ -0,0 +1,78 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{benchmark_harness}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Daniel Higginbotham"]
+  s.date = %q{2011-03-29}
+  s.description = %q{harness for running benchmark multiple times and running stats on the results}
+  s.email = %q{daniel@flyingmachinestudios.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "benchmark_harness.gemspec",
+    "lib/benchmark_harness.rb",
+    "lib/benchmark_harness/collection.rb",
+    "spec/benchmark_harness_spec.rb",
+    "spec/fixtures/string_example.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/flyingmachine/benchmark_harness}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{harness for running benchmark multiple times and running stats on the results}
+  s.test_files = [
+    "spec/benchmark_harness_spec.rb",
+    "spec/fixtures/string_example.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<easystats>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<easystats>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<ruby-debug>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<easystats>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<ruby-debug>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end
+

data/lib/benchmark_harness.rb

@@ -0,0 +1,30 @@
+require 'singleton'
+require 'forwardable'
+require 'benchmark'
+require 'easystats'
+
+require 'benchmark_harness/collection'
+
+class BenchmarkHarness
+  include Singleton
+  
+  class << self
+    extend Forwardable
+    def_delegators :instance, :collections, :measure, :flush!
+  end
+  
+  def collections
+    @collections ||= Hash.new{|h,k| h[k] = Collection.new}
+  end
+  
+  def flush!
+    @collections = nil
+  end
+  
+  def measure(collection_name)
+    m = Benchmark.measure{
+      yield
+    }
+    collections[collection_name] << m.to_a[1..-1]
+  end
+end

data/lib/benchmark_harness/collection.rb

@@ -0,0 +1,50 @@
+class BenchmarkHarness
+  class Collection < Array
+    # order corresponds to values in each sample
+    KEYS        = [:user, :system, :children_user, :children_system, :real]
+    STATS       = [:mean, :median, :mode, :range, :standard_deviation, :variance]
+    STATS_HUMAN = STATS.collect{|s| s.to_s.sub(/_/, " ").capitalize}
+    
+    def reconciled
+      return @reconciled if @reconciled
+      @reconciled = Hash.new{|h,k| h[k] = []}
+      self.each do |sample|
+        KEYS.each_with_index do |key, index|
+          @reconciled[key] << sample[index]
+        end
+      end
+      @reconciled
+    end
+    
+    # Specify that the corresponding easystats method can be used
+    # also defines the method so that it can optionally take a key.
+    # If they key is present, return result for just that vector;
+    # otherwise return hash of results for all keys/vectors    
+    [:mean, :median, :mode, :range, :standard_deviation, :variance].each do |method_name|
+      class_eval <<-END
+        def #{method_name}(key = nil)
+          if key
+            reconciled[key].#{method_name}
+          else
+            result = {}
+            KEYS.each do |key|
+              result[key] = reconciled[key].#{method_name}
+            end
+            result
+          end
+        end
+      END
+    end
+    
+    # Formatted output
+    def print
+      label_size = STATS_HUMAN.max{|a, b| a.size <=> b.size}.size
+      puts sprintf("%#{label_size}s %d", "Samples:", self.size)
+      puts "Displaying user, system, children user, children system, real"
+      STATS_HUMAN.each_with_index do |label, i|
+        puts sprintf("%#{label_size}s: %g %g %g %g %g", label, *KEYS.collect{|k| self.send(STATS[i], k)})
+      end
+    end
+    
+  end
+end

data/spec/benchmark_harness_spec.rb

@@ -0,0 +1,96 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "BenchmarkHarness" do
+  after :each do
+    BenchmarkHarness.flush!
+  end
+  
+  # #measure used in StringExample
+  describe "#measure" do
+    it "should add each instance of a run to a named collection" do
+      2.times{
+        StringExample.concatenate_with_plus("Hello ", "Dave")
+        StringExample.concatenate_with_append("Hello ", "Dave")
+      }
+      BenchmarkHarness.collections[:plus].size.should == 2
+      BenchmarkHarness.collections[:append].size.should == 2
+    end
+  end
+  
+  describe "Collection" do
+    it "should provide a mean, median, mode, range, standard deviation, and variance for each kind of time if no key provided" do
+      Benchmark::Tms.any_instance.stubs(:to_a).returns((1..6).to_a)
+      2.times{
+        StringExample.concatenate_with_plus("Hello ", "Dave")
+      }
+    
+      BenchmarkHarness.collections[:plus].mean().should == {
+        :user            => 2,
+        :system          => 3,
+        :children_user   => 4,
+        :children_system => 5,
+        :real            => 6
+      }
+      
+      BenchmarkHarness.collections[:plus].median().should == {
+        :user            => 2,
+        :system          => 3,
+        :children_user   => 4,
+        :children_system => 5,
+        :real            => 6
+      }
+      
+      BenchmarkHarness.collections[:plus].mode().should == {
+        :user            => 2,
+        :system          => 3,
+        :children_user   => 4,
+        :children_system => 5,
+        :real            => 6
+      }
+      
+      BenchmarkHarness.collections[:plus].range().should == {
+        :user            => 0,
+        :system          => 0,
+        :children_user   => 0,
+        :children_system => 0,
+        :real            => 0
+      }
+      
+      BenchmarkHarness.collections[:plus].standard_deviation().should == {
+        :user            => 0,
+        :system          => 0,
+        :children_user   => 0,
+        :children_system => 0,
+        :real            => 0
+      }
+      
+      BenchmarkHarness.collections[:plus].variance().should == {
+        :user            => 0,
+        :system          => 0,
+        :children_user   => 0,
+        :children_system => 0,
+        :real            => 0
+      }
+    end
+    
+    it "should provide *only* the mean, median, mode, range, etc when key is given" do
+      Benchmark::Tms.any_instance.stubs(:to_a).returns((1..6).to_a)
+      2.times{
+        StringExample.concatenate_with_plus("Hello ", "Dave")
+      }
+    
+      BenchmarkHarness.collections[:plus].mean(:user).should == 2
+    end
+  end
+  
+  describe "#flush" do
+    it "should remove all previous samples" do
+      2.times{
+        StringExample.concatenate_with_plus("Hello ", "Dave")
+      }
+      BenchmarkHarness.flush!
+    
+      BenchmarkHarness.collections.should be_empty
+    end
+  end
+end

data/spec/fixtures/string_example.rb

@@ -0,0 +1,16 @@
+# Simple string methods for testing benchmarking
+module StringExample
+  class << self
+    def concatenate_with_plus(first, second)
+      BenchmarkHarness.measure(:plus) {
+        first + second
+      }
+    end
+  
+    def concatenate_with_append(first, second)
+      BenchmarkHarness.measure(:append) {
+        first << second
+      }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'benchmark_harness'
+require 'mocha'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+# Require fixtures
+Dir["#{File.dirname(__FILE__)}/fixtures/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification 
+name: benchmark_harness
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Daniel Higginbotham
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-29 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  name: easystats
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rspec
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: bundler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: jeweler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rcov
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: ruby-debug
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: mocha
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id007
+description: harness for running benchmark multiple times and running stats on the results
+email: daniel@flyingmachinestudios.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- benchmark_harness.gemspec
+- lib/benchmark_harness.rb
+- lib/benchmark_harness/collection.rb
+- spec/benchmark_harness_spec.rb
+- spec/fixtures/string_example.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/flyingmachine/benchmark_harness
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: harness for running benchmark multiple times and running stats on the results
+test_files: 
+- spec/benchmark_harness_spec.rb
+- spec/fixtures/string_example.rb
+- spec/spec_helper.rb