rbench 0.2.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Yehuda Katz & Sindre Aarsaether
+
+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

@@ -0,0 +1,103 @@
+rbench
+======
+
+== What is RBench?
+
+Library for generating nice ruby-benchmarks in several formats.
+Only text-output is available atm.
+
+Heavily inspired by benchwarmer. Much love.
+
+== Usage
+
+require "rubygems"
+require "rbench"
+
+# Choose how many times you want to repeat each benchmark.
+# This can be overridden on specific reports, if needed.
+TIMES = 100_000
+
+# A relatively simple benchmark:
+RBench.run(TIMES) do
+  
+  column :one
+  column :two
+
+  report "Squeezing with #squeeze" do
+    one { "abc//def//ghi//jkl".squeeze("/") }
+    two { "abc///def///ghi///jkl".squeeze("/") }
+  end
+
+  report "Squeezing with #gsub" do
+    one { "abc//def//ghi//jkl".gsub(/\/+/, "/") }
+    two { "abc///def///ghi///jkl".gsub(/\/+/, "/") }
+  end
+
+  report "Splitting with #split" do
+    one { "aaa/aaa/aaa.bbb.ccc.ddd".split(".") }
+    two { "aaa//aaa//aaa.bbb.ccc.ddd.eee".split(".") }
+  end
+
+  report "Splitting with #match" do
+    one { "aaa/aaa/aaa.bbb.ccc.ddd".match(/\.([^\.]*)$/) }
+    two { "aaa//aaa//aaa.bbb.ccc.ddd.eee".match(/\.([^\.]*)$/) }
+  end
+  
+end 
+
+# The benchmark above will output the following:
+                                                                 ONE |     TWO |
+--------------------------------------------------------------------------------
+Squeezing with #squeeze                                        0.122 |   0.118 |
+Squeezing with #gsub                                           0.274 |   0.271 |
+Splitting with #split                                          0.349 |   0.394 |
+Splitting with #match                                          0.238 |   0.291 |
+
+
+# Now onto a benchmark that utilizes a some more stiff.
+RBench.run(TIMES) do
+
+  format :width => 65
+
+  column :times
+  column :one,  :title => "#1"
+  column :two,  :title => "#2"
+  column :diff, :title => "#1/#2", :compare => [:one,:two]
+
+  group "Squeezing" do
+    report "with #squeeze" do
+      one { "abc//def//ghi//jkl".squeeze("/") }
+      two { "abc///def///ghi///jkl".squeeze("/") }
+    end
+    report "with #gsub" do
+      one { "abc//def//ghi//jkl".gsub(/\/+/, "/") }
+      two { "abc///def///ghi///jkl".gsub(/\/+/, "/") }
+    end
+    
+    summary "all methods (totals)"
+  end
+ 
+  group "Splitting" do
+    report "with #split" do
+      one { "aaa/aaa/aaa.bbb.ccc.ddd".split(".") }
+      two { "aaa//aaa//aaa.bbb.ccc.ddd.eee".split(".") }
+    end
+    report "with #match", TIMES / 100 do
+      one { "aaa/aaa/aaa.bbb.ccc.ddd".match(/\.([^\.]*)$/) }
+      two { "aaa//aaa//aaa.bbb.ccc.ddd.eee".match(/\.([^\.]*)$/) }
+    end
+  end
+  
+end
+
+# The benchmark above will output the following:
+                                  |      #1 |      #2 |   #1/#2 |
+--Squeezing------------------------------------------------------
+with #squeeze             x100000 |   0.122 |   0.117 |   1.04x |
+with #gsub                x100000 |   0.267 |   0.279 |   0.96x |
+all methods (totals)              |   0.390 |   0.396 |   0.98x |
+--Splitting------------------------------------------------------
+with #split               x100000 |   0.341 |   0.394 |   0.87x |
+with #match                 x1000 |   0.002 |   0.003 |   0.82x |
+
+

data/TODO

@@ -0,0 +1,6 @@
+TODO
+====
+* Add #to_html and #to_xml output
+* Write general documentation
+* Make example in readme with a boolean-column
+* Write specs

data/lib/rbench.rb

@@ -0,0 +1,16 @@
+require 'pathname'
+require 'benchmark'
+
+dir = Pathname(__FILE__).dirname.expand_path + 'rbench/'
+
+require dir + 'runner'
+require dir + 'column'
+require dir + 'group'
+require dir + 'report'
+require dir + 'summary'
+
+module RBench
+  def self.run(times=1, &block)
+    Runner.new(times).run(&block)
+  end
+end

data/lib/rbench/column.rb

@@ -0,0 +1,26 @@
+module RBench
+  class Column
+    attr_accessor :name, :title, :width, :compare, :default
+    
+    def initialize(runner, name, options = {})
+      @runner  = runner
+      @name    = name
+      @title   = options[:title] || (@name == :times ? "" : @name.to_s.upcase)
+      @width   = options[:width] || [@title.length,7].max
+      @compare = options[:compare]
+      @default = @compare ? @compare : options[:default]
+    end
+    
+    def to_s(val=title)
+      str = case val
+        when Array      then "%#{width-1}.2f" % (val[0] / val[1]) + "x"
+        when Float      then "%#{width}.3f" % val
+        when Integer    then "%#{width}.0f" % val
+        when TrueClass  then " "*(width/2.0).floor + "X" + " "*(width/2.0).floor
+        when String     then "%#{width}s" % (val)[0,width]
+        when Object     then " " * width
+      end
+      return " #{(str.to_s+" "*width)[0,width]} |"
+    end
+  end
+end

data/lib/rbench/group.rb

@@ -0,0 +1,42 @@
+module RBench
+  class Group
+    self.instance_methods.each do |m|
+      send(:undef_method, m) unless m =~ /^(__|is_a?|kind_of?|respond_to?|hash|eql?|inspect|instance_eval)/
+    end
+    
+    attr_reader :name, :items, :block
+    
+    def initialize(runner, name, &block)
+      @runner = runner
+      @name    = name
+      @items = []
+      @block = block
+    end
+    
+    def prepare
+      # This just loops through and spawns the reports, and the summary (if exists)
+      self.instance_eval(&@block) if @block
+      # Now we want to make sure that the summary is 
+      @items << @items.shift if @items.first.is_a?(Summary)
+    end
+    
+    def run
+      # Put a separator with the group-name at the top. puts?
+      puts @runner.separator(@name)
+      # Now loop through the items in this group, and run them
+      @items.each{|item| item.run}
+    end
+
+    def report(name,times=nil,&block)
+      @items << Report.new(@runner,self,name,times,&block)
+    end
+    
+    def summary(name)
+      @items.unshift(Summary.new(@runner,self,name)) unless @items.detect{|i| i.is_a?(Summary)}
+    end
+    
+    def to_s
+      @runner.separator(@name) << @items.map { |item| item.to_s }.join
+    end
+  end
+end

data/lib/rbench/report.rb

@@ -0,0 +1,53 @@
+module RBench
+  class Report
+    self.instance_methods.each do |m|
+      send(:undef_method, m) unless m =~ /^(__|is_a?|kind_of?|respond_to?|hash|inspect|instance_eval|eql?)/
+    end
+    
+    attr_reader :name, :cells
+    
+    def initialize(runner, group, name, times=nil,&block)
+      @runner = runner
+      @group  = group
+      @name   = name
+      @times  = (times || runner.times).ceil
+      @cells  = {}
+      @block  = block 
+      
+      # Setting the default for all cells
+      runner.columns.each {|c| @cells[c.name] = c.name == :times ? "x#{@times}" : c.default }
+      
+      new_self = (class << self; self end)
+      @runner.columns.each do |column|
+        new_self.class_eval <<-CLASS
+          def #{column.name}(val=nil,&block)
+            @cells[#{column.name.inspect}] = block ? Benchmark.measure { @times.times(&block) }.real : val
+          end
+        CLASS
+      end
+    end
+    
+    def run
+      # runs the actual benchmarks. If there is only one column, just evaluate the block itself.
+      if @runner.columns.length == 1
+        @cells[@runner.columns.first.name] = Benchmark.measure { @times.times(&@block) }.real
+      else
+        self.instance_eval(&@block)
+      end
+      # puts its row now that it is complete
+      puts to_s
+    end
+    
+    def to_s
+      out = "%-#{@runner.desc_width}s" % name
+      @runner.columns.each do |column|
+        value = @cells[column.name]
+        value = @cells.values_at(*value) if value.is_a?(Array)
+        value = nil if value.is_a?(Array) && value.nitems != 2
+        
+        out << column.to_s(value)
+      end
+      out << @runner.newline
+    end
+  end
+end

data/lib/rbench/runner.rb

@@ -0,0 +1,109 @@
+module RBench
+  class Runner
+    attr_accessor :columns, :items, :times, :width
+    
+    def initialize(times)
+      @width = 0
+      @times = times
+      @columns = []
+      @items = []
+    end
+    
+    def run(&block)
+      
+      # initiate all the columns, groups, reports, and summaries on top level.
+      self.instance_eval(&block)
+      
+      # the groups has not run just yet, but when they do, we really only want
+      # to make them initiate their reports, not run them (just yet)
+      # when we only have two levels, _every_ report should now be initialized.
+      @items.each{|item| item.prepare if item.is_a?(Group)}
+      
+      # We are putting the summary to the back if its there.
+      @items << @items.shift if @items.first.is_a?(Summary)
+      
+      # if on columns were set, create a default column
+      column(:results, :title => "Results") if @columns.empty?
+      
+      # since we are about to start rendering, we put out the column-header
+      puts header
+      
+      # now we are ready to loop through our items and run!
+      items.each { |item| item.run if item.respond_to?(:run) }
+      
+      # returning self so people can output it in different formats.
+      self
+    end
+    
+    def format(options={})
+      @width = options.delete(:width) || @width
+    end
+    
+    def column(name,options={})
+      @columns << Column.new(self,name,options)
+    end
+    
+    def group(name,&block)
+      @items << Group.new(self,name,&block)
+    end
+    
+    def report(name,times=nil,&block)
+      # create an anonymous group, or add it to the last open group.
+      group(nil) unless @items.last.is_a?(Group) && !@items.last.block
+      # now create the report on the last group
+      @items.last.report(name,times,&block)
+    end
+    
+    def summary(name)
+      # adding the summary to the front, so it is easier to put it last later.
+      @items.unshift(Summary.new(self,nil,name)) unless @items.detect{|i| i.is_a?(Summary)}
+    end
+    
+    ##
+    # convenience-methods
+    ##
+    
+    def groups
+      @items.select{|item| item.is_a?(Group) }
+    end
+
+    def reports
+      # we now want _all_ reports, also those that are part of subgroups
+      groups.map{|g| g.items.select{|item| item.is_a?(Report) } }.flatten
+    end
+    
+    ##
+    # for rendering text. pull out in separate module when to_xml and to_html is in place
+    ##
+    
+    def newline
+      "\n"
+    end
+    
+    def header
+      " " * desc_width + @columns.map {|c| c.to_s }.join + newline
+    end
+    
+    def desc_width
+      @desc_width ||= [items.map{|i| (i.items.map{|r| r.name} << i.name) }.flatten.map{|i| i.to_s.length}.max+8,@width-columns_width].max
+    end
+    
+    def columns_width
+      @columns.inject(0){ |tot,c| tot += (c.to_s.length) }
+    end
+    
+    def width(value=nil)
+      header.length-1
+    end
+
+    def separator(title=nil,chr="-",length=width)
+      title ? chr*2 + title + chr * (width - title.length - 2) : chr * length
+    end
+    
+    def to_s
+      out = " " * desc_width + @columns.map {|c| c.to_s }.join + newline
+      out << @items.map {|item| item.to_s}.join
+    end
+    
+  end
+end

data/lib/rbench/summary.rb

@@ -0,0 +1,51 @@
+module RBench
+  class Summary
+    attr_reader :name, :runner, :cells, :items
+    attr_accessor :lines
+    
+    def initialize(runner, group, name)
+      @runner = runner
+      @group  = group
+      @name   = name
+      @cells  = {}     # A hash with keys as columns, and values being the result
+      @items  = []
+    end
+    
+    def run
+      # maybe add convenience-method to group to. group == runner really.
+      items = (@group ? @group.items & @runner.reports : @runner.reports)
+      
+      rows = items.map{|item| item.cells.values_at(*@runner.columns.map{|c|c.name}) }
+      rows = rows.pop.zip(*rows)
+
+      @runner.columns.each_with_index do |c,i|
+        if c.compare
+          value,comparisons = 0,0
+          items.each do |item|
+            v1,v2 = *item.cells.values_at(*c.compare)
+            if v1.kind_of?(Numeric) && v2.kind_of?(Numeric) && v1 != 0 && v2 != 0
+              value += v1 / v2
+              comparisons += 1
+            end
+          end
+          @cells[c.name] = [value,comparisons] if comparisons > 0
+        elsif c.name != :times
+          @cells[c.name] = rows[i].compact.select{|r| r.kind_of?(Numeric)}.inject(0){|tot,v| tot += v.to_f }
+        end
+      end
+      
+      puts to_s
+    end
+    
+    def to_s
+      out = ""
+      out << @runner.separator(nil,"=") + @runner.newline unless @group
+      out << "%-#{@runner.desc_width}s" % name
+      @runner.columns.each do |column|
+        value = @cells[column.name]
+        out << column.to_s( value )
+      end
+      out << @runner.newline
+    end
+  end
+end

data/spec/rbench_spec.rb

@@ -0,0 +1,141 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path + 'spec_helper'
+
+TIMES = 100_000
+
+RBench.run(TIMES) do
+  
+  column :one
+  column :two
+
+  report "Squeezing with #squeeze" do
+    one { "abc//def//ghi//jkl".squeeze("/") }
+    two { "abc///def///ghi///jkl".squeeze("/") }
+  end
+
+  report "Squeezing with #gsub" do
+    one { "abc//def//ghi//jkl".gsub(/\/+/, "/") }
+    two { "abc///def///ghi///jkl".gsub(/\/+/, "/") }
+  end
+
+  report "Splitting with #split" do
+    one { "aaa/aaa/aaa.bbb.ccc.ddd".split(".") }
+    two { "aaa//aaa//aaa.bbb.ccc.ddd.eee".split(".") }
+  end
+
+  report "Splitting with #match" do
+    one { "aaa/aaa/aaa.bbb.ccc.ddd".match(/\.([^\.]*)$/) }
+    two { "aaa//aaa//aaa.bbb.ccc.ddd.eee".match(/\.([^\.]*)$/) }
+  end
+  
+end
+
+puts
+puts
+
+RBench.run(TIMES) do
+  
+  format :width => 80
+
+  report "Squeezing with #squeeze" do
+    "abc//def//ghi//jkl".squeeze("/")
+  end
+
+  report "Squeezing with #gsub" do
+    "abc//def//ghi//jkl".gsub(/\/+/, "/")
+  end
+
+  report "Splitting with #split" do
+    "aaa/aaa/aaa.bbb.ccc.ddd".split(".")
+  end
+
+  report "Splitting with #match" do
+    "aaa/aaa/aaa.bbb.ccc.ddd".match(/\.([^\.]*)$/)
+  end
+  
+end
+
+puts
+puts
+
+bench = RBench.run(TIMES) do
+
+  column :times
+  column :dm
+  column :ar
+  column :diff, :compare => [:dm,:ar]
+
+  group "This is a group" do
+
+    report "split", TIMES / 10 do
+      dm { "aaa/aaa/aaa.bbb.ccc.ddd".split(".") }
+      ar { "aaa//aaa//aaa.bbb.ccc.ddd.eee".split(".") }
+    end
+  
+    report "match" do
+      dm { "aaa/aaa/aaa.bbb.ccc.ddd".match(/\.([^\.]*)$/) }
+      ar { "aaa//aaa//aaa.bbb.ccc.ddd.eee".match(/\.([^\.]*)$/) }
+    end
+    
+    summary "methods (totals)" # should display total for all preceding rows within this group / scope
+  
+  end
+
+  group "This is a group" do
+
+    report "split", TIMES / 10 do
+      dm { "aaa/aaa/aaa.bbb.ccc.ddd".split(".") }
+      ar { "aaa//aaa//aaa.bbb.ccc.ddd.eee".split(".") }
+    end
+  
+    report "match" do
+      dm { "aaa/aaa/aaa.bbb.ccc.ddd".match(/\.([^\.]*)$/) }
+      #ar { "aaa//aaa//aaa.bbb.ccc.ddd.eee".match(/\.([^\.]*)$/) }
+    end
+  
+  end
+  
+  report "testing" do
+    dm { "aaa/aaa/aaa.bbb.ccc.ddd".match(/\.([^\.]*)$/) }
+    ar { "aaa//aaa//aaa.bbb.ccc.ddd.eee".match(/\.([^\.]*)$/) }
+  end
+  
+  summary "Overall"
+
+end
+
+puts
+puts
+
+RBench.run(TIMES) do
+
+  column :times
+  column :one,  :title => "#1"
+  column :two,  :title => "#2"
+  column :diff, :title => "#1/#2", :compare => [:one,:two]
+
+  group("Squeezing") do
+    report "with #squeeze" do
+      one { "abc//def//ghi//jkl".squeeze("/") }
+      two { "abc///def///ghi///jkl".squeeze("/") }
+    end
+    report "with #gsub" do
+      one { "abc//def//ghi//jkl".gsub(/\/+/, "/") }
+      two { "abc///def///ghi///jkl".gsub(/\/+/, "/") }
+    end
+    
+    summary "all methods (totals)"
+  end
+ 
+  group("Splitting") do
+    report "with #split" do
+      one { "aaa/aaa/aaa.bbb.ccc.ddd".split(".") }
+      two { "aaa//aaa//aaa.bbb.ccc.ddd.eee".split(".") }
+    end
+    report "with #match", TIMES / 100 do
+      one { "aaa/aaa/aaa.bbb.ccc.ddd".match(/\.([^\.]*)$/) }
+      two { "aaa//aaa//aaa.bbb.ccc.ddd.eee".match(/\.([^\.]*)$/) }
+    end
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+gem 'rspec', '>=1.1.3'
+require 'spec'
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'lib/rbench'

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: rbench
+version: !ruby/object:Gem::Version 
+  version: 0.2.2
+platform: ruby
+authors: 
+- Yehuda Katz & Sindre Aarsaether
+autorequire: rbench
+bindir: bin
+cert_chain: []
+
+date: 2008-06-16 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Library for generating nice ruby-benchmarks
+email: post [a] rbench [d] org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- README
+- LICENSE
+- TODO
+- spec/rbench_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- lib/rbench.rb
+- lib/rbench/summary.rb
+- lib/rbench/runner.rb
+- lib/rbench/report.rb
+- lib/rbench/group.rb
+- lib/rbench/column.rb
+has_rdoc: true
+homepage: http://www.rbench.org
+post_install_message: 
+rdoc_options: []
+
+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.1.1
+signing_key: 
+specification_version: 2
+summary: Library for generating nice ruby-benchmarks
+test_files: []
+