bench_press 0.2.1 → 0.3.0

data/README.markdown

@@ -0,0 +1,83 @@
+Bench Press
+===========
+
+Bench Press is a simple dsl around Ruby's Benchmark library.
+
+Place the code you wish to benchmark inside of a measure block, run the
+bench_press command and you'll get a markdown report containing your system
+information and the realtime benchmark.
+
+Additionally, benchmarks can be published to the
+[Ruby Benchmark](http://rubybenchmark.com) via
+`bench_press --publish benchmark.rb` command.
+
+### Creating a new benchmark
+
+Use the `--new` flag to get started
+    $ bench_press --new benchmark
+    $ vi benchmark.rb
+
+## Example
+
+    # foo.rb
+    require 'bench_press'
+    extend BenchPress
+
+    base_string = ""
+    measure "string append" do
+      base_string << "Hello World"
+    end
+
+    base_string = ""
+    measure "string +=" do
+      base_string += "Hello World"
+    end
+
+    $ bench_press foo.rb
+
+    Foo
+    ===
+    Date: August 05, 2010
+
+    System Information
+    ------------------
+        Operating System:    Mac OS X 10.6.4 (10F569)
+        CPU:                 Intel Core 2 Duo 2.4 GHz
+        Processor Count:     2
+        Memory:              4 GB
+        ruby 1.8.7 (2009-12-24 patchlevel 248) [i686-darwin10.2.0], MBARI 0x6770, Ruby Enterprise Edition 2010.01
+
+    "string append" is up to 71% faster over 1000 repetitions
+    ---------------------------------------------------------
+
+        string append    0.00270986557006836 secs    Fastest
+        string +=        0.00948691368103027 secs    71% Slower
+
+## Details
+The default number of repetitions is 1000 meaning each measure block is run
+1000 times.
+
+Each measure block is run in a forked subprocess in an attempt to isolate the
+memory usage per measurement. As of 0.3.0, the benchmark is run twice, the
+first run gets thrown away while the second run is added to the report.
+
+## Running the binary/examples locally
+I use rubygems but this library is $LOAD_PATH friendly which means we need to
+set up our own load path when playing locally.
+
+Try sourcing the .dev file
+
+    $ source .dev
+
+## 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 Sandro Turriate. See LICENSE for details.

data/README.rdoc

@@ -2,6 +2,8 @@
 
 Sharable benchmarks
 
+bench_press --help for options
+
 == Running the binary/examples locally
 I use rubygems but this library is $LOAD_PATH friendly which means we need to
 set up our own load path when playing locally.

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/bench_press.gemspec

@@ -5,17 +5,18 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bench_press}
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sandro Turriate"]
-  s.date = %q{2010-08-01}
+  s.date = %q{2010-08-05}
   s.default_executable = %q{bench_press}
   s.description = %q{Sharable benchmarks}
   s.email = %q{sandro.turriate@gmail.com}
   s.executables = ["bench_press"]
   s.extra_rdoc_files = [
-    "README.rdoc",
+    "README.markdown",
+     "README.rdoc",
      "TODO"
   ]
   s.files = [
@@ -25,11 +26,13 @@ Gem::Specification.new do |s|
      ".rvmrc",
      "Gemfile",
      "MIT-LICENSE",
+     "README.markdown",
      "README.rdoc",
      "Rakefile",
      "VERSION",
      "bench_press.gemspec",
      "bin/bench_press",
+     "examples/clearing_an_array.rb",
      "examples/compare_rr_to_rspec.rb",
      "examples/existence_of_method.rb",
      "examples/hash_merge.rb",
@@ -67,9 +70,10 @@ Gem::Specification.new do |s|
      "spec/bench_press_spec.rb",
      "spec/spec_helper.rb",
      "spec/support/measurable.rb",
-     "examples/array_vs_string_concatenation.rb",
+     "examples/clearing_an_array.rb",
      "examples/compare_rr_to_rspec.rb",
      "examples/existence_of_method.rb",
+     "examples/foo.rb",
      "examples/hash_merge.rb",
      "examples/implicit_versus_explicit_return.rb",
      "examples/regexp_matching.rb",

data/examples/clearing_an_array.rb

@@ -0,0 +1,50 @@
+require 'bench_press'
+
+extend BenchPress
+
+author 'Sandro Turriate'
+date '2010-08-01'
+summary "
+  What's the best way to clear out an array? Could be useful if you're storing 
+  messages in an array like a buffer. How should you flush the buffer when 
+  you're done with it?
+"
+
+reps 10_000
+
+ARRAY = (1..1000).to_a.freeze
+
+measure "Array#clear" do
+  a = ARRAY.dup
+  a.clear
+end
+
+measure "Array#replace" do
+  a = ARRAY.dup
+  a.replace []
+end
+
+measure "Assign the variable to a new array" do
+  a = ARRAY.dup
+  a = []
+end
+
+measure "Array#-" do
+  a = ARRAY.dup
+  a = a - a
+end
+
+measure "Array#delete_if" do
+  a = ARRAY.dup
+  a.delete_if {true}
+end
+
+measure "Array#drop" do
+  a = ARRAY.dup
+  a = a.drop(a.size)
+end
+
+measure "Array#shift(n)" do
+  a = ARRAY.dup
+  a.shift(a.size)
+end

data/examples/foo.rb

@@ -0,0 +1,12 @@
+    require 'bench_press'
+    extend BenchPress
+
+    base_string = ""
+    measure "string append" do
+      base_string << "Hello World"
+    end
+
+    base_string = ""
+    measure "string +=" do
+      base_string += "Hello World"
+    end

data/lib/bench_press.rb

@@ -9,7 +9,7 @@ require 'bench_press/report'
 require 'bench_press/system_information'
 
 module BenchPress
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 
   autoload :RubyBenchmark, 'bench_press/ruby_benchmark'
 

data/lib/bench_press/cli.rb

@@ -30,11 +30,15 @@ module BenchPress
       @optparse ||= OptionParser.new do |opts|
         opts.banner = "Usage: bench_press [options] file_to_benchmark.rb"
 
+        opts.on( '-n', '--new', 'Create a new benchmark' ) do
+          options[:new] = true
+        end
+
         opts.on( '-p', '--publish', 'Publish the benchmark to http://rubybenchmark.com' ) do
           options[:publish] = true
         end
 
-        opts.on('--email EMAIL', String, "Author email, defaults to #{git_email}") do |email|
+        opts.on('--email EMAIL', String, "Author email used when publishing, defaults to #{git_email}") do |email|
           options[:email] = email
         end
 
@@ -49,6 +53,8 @@ module BenchPress
         exit_with_version
       elsif file_exists?
         perform_bench_press
+      elsif options[:new]
+        new_bench_press
       else
         abort "Could not proceed, please supply the filename you wish to benchmark"
       end
@@ -88,5 +94,41 @@ module BenchPress
         abort "Email missing. Use bench_press --publish --email me@example.com file.rb"
       end
     end
+
+    def new_bench_press
+      if filename && File.exists?(file_path_with_rb)
+        abort "A file named #{filename} already exists"
+      else
+        File.open(file_path_with_rb, 'w') { |f| f.write(template) } unless file_exists?
+      end
+    end
+
+    def file_path_with_rb
+      file_path + '.rb'
+    end
+
+    def template
+      <<-TEMPLATE
+
+require 'bench_press'
+
+extend BenchPress
+
+name 'gem1 vs. gem2'
+author 'YOUR NAME'
+date '#{Time.now.strftime('%Y-%m-%d')}'
+summary "
+  Describe what you're benchmarking
+"
+
+reps 10_000 #number of repetitions
+
+measure "Class#method" do
+  # code to be benchmarked
+end
+
+      TEMPLATE
+    end
+
   end
 end

data/lib/bench_press/report.rb

@@ -56,7 +56,7 @@ module BenchPress
     end
 
     def heading
-      %("#{result.fastest.name}" is up to #{result.slowest.percent_slower}% faster over #{repetitions} repetitions)
+      %("#{result.fastest.name}" is up to #{result.slowest.percent_slower}% faster over #{formatted_number repetitions} repetitions)
     end
 
     def runnable_heading
@@ -103,7 +103,7 @@ module BenchPress
     def repetitions
       Runnable.repetitions
     end
-
+    
     def row(*columns)
       row = spacer
       columns.each do |column|
@@ -115,6 +115,10 @@ module BenchPress
     def spacer
       ' ' * SPACING
     end
+    
+    def formatted_number(number, delimiter = ',')
+      number.to_s.gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{delimiter}")
+    end
 
     def run_name(content)
       content.to_s.ljust(result.longest_name.size + SPACING)

data/lib/bench_press/runnable.rb

@@ -25,10 +25,9 @@ module BenchPress
     def run
       r,w = IO.pipe
       fork do
+        run_it
         time = Benchmark.realtime do
-          self.class.repetitions.times do |i|
-            code_block.call(i)
-          end
+          run_it
         end
         w.write time
         w.close_write
@@ -55,5 +54,13 @@ module BenchPress
         :fastest => fastest
       }
     end
+
+    protected
+
+    def run_it
+      self.class.repetitions.times do |i|
+        code_block.call(i)
+      end
+    end
   end
 end

data/spec/bench_press/report_spec.rb

@@ -38,7 +38,13 @@ describe BenchPress::Report do
       subject.date.should == custom_date
     end
   end
-
+  
+  describe  "#formatted_number" do
+    it "comma-separates a number" do
+      subject.send(:formatted_number, 1000000).should == "1,000,000"
+    end
+  end
+  
   describe "#runnable_results" do
     let(:report) do
       r = BenchPress::Report.new
@@ -52,13 +58,13 @@ describe BenchPress::Report do
 
     it "displays a heading" do
       heading = <<-EOS
-"Implicit return" is up to 17% faster over 1000 repetitions
------------------------------------------------------------
+"Implicit return" is up to 17% faster over 1,000 repetitions
+------------------------------------------------------------
 EOS
 
       report.send(:runnable_heading).should == heading.strip
     end
-
+    
     it "displays the table of results" do
       table = <<-EOS
     Implicit return    0.00029 secs    Fastest

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bench_press
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Sandro Turriate
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-01 00:00:00 -04:00
+date: 2010-08-05 00:00:00 -04:00
 default_executable: bench_press
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -105,6 +105,7 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
+- README.markdown
 - README.rdoc
 - TODO
 files: 
@@ -114,11 +115,13 @@ files:
 - .rvmrc
 - Gemfile
 - MIT-LICENSE
+- README.markdown
 - README.rdoc
 - Rakefile
 - VERSION
 - bench_press.gemspec
 - bin/bench_press
+- examples/clearing_an_array.rb
 - examples/compare_rr_to_rspec.rb
 - examples/existence_of_method.rb
 - examples/hash_merge.rb
@@ -142,7 +145,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/measurable.rb
 - TODO
-- examples/array_vs_string_concatenation.rb
+- examples/foo.rb
 has_rdoc: true
 homepage: http://github.com/sandro/bench_press
 licenses: []
@@ -186,9 +189,10 @@ test_files:
 - spec/bench_press_spec.rb
 - spec/spec_helper.rb
 - spec/support/measurable.rb
-- examples/array_vs_string_concatenation.rb
+- examples/clearing_an_array.rb
 - examples/compare_rr_to_rspec.rb
 - examples/existence_of_method.rb
+- examples/foo.rb
 - examples/hash_merge.rb
 - examples/implicit_versus_explicit_return.rb
 - examples/regexp_matching.rb

data/examples/array_vs_string_concatenation.rb

@@ -1,30 +0,0 @@
-$:.unshift(File.dirname(__FILE__) + "/../lib")
-require 'bench_press'
-
-extend BenchPress
-
-reps 100_000
-array = []
-measure "Array#<<" do |repetition|
-  array << "1234567890"
-end
-
-string = ""
-measure "String#<<" do |repetition|
-  string << "1234567890"
-end
-
-a = (1..1000).to_a
-measure "Array#clear" do
-  a.dup.clear
-end
-
-measure "Array#replace" do
-  a.dup
-  a.replace []
-end
-
-measure "Re-assigning to new array" do
-  a.dup
-  a = []
-end