benchmarkx 001

data/.gemified

@@ -0,0 +1,11 @@
+--- 
+:summary: BenchmarkX is a extension of standard benchmark.rb for rendering sexy graph using gruff.
+:email: keita.yamaguchi@gmail.com
+:has_rdoc: true
+:name: benchmarkx
+:homepage: http://rubyforge.org/projects/benchmarkx/
+:version: "001"
+:dependencies: 
+- gruff
+:rubyforge_project: benchmarkx
+:author: Keita Yamaguchi

data/History.txt

@@ -0,0 +1,5 @@
+= 001: 2008-04-12
+
+* Keita Yamaguchi:
+  * Initial release
+

data/License.txt

@@ -0,0 +1,56 @@
+BenchmarkX is copyrighted free software by Keita Yamaguchi <keita.yamaguchi@gmail.com>.
+You can redistribute it and/or modify it under either the terms of the GPL
+(see the file GPL), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README.txt

@@ -0,0 +1,19 @@
+= BenchmarkX
+
+Author::    Keita Yamaguchi(山口 慶太) <keita.yamaguchi@gmail.com>
+Copyright:: © Keita Yamaguchi, 2008. All rights reserved.
+License::   Ruby License
+
+BenchmarkX is a Ruby library for extending standard benchmark with sexy graph!
+
+== Usage
+
+See {the documentation}[http://github.com/keita/benchmarkx/wikis].
+
+== Links
+
+* BenchmarkX
+  * {RubyForge}[http://rubyforge.org/projects/weatherhacks/]
+  * {GitHub}[http://github.com/keita/ruby-weatherhacks/tree/master]
+* author's blog(written in Japanese)
+  * {¬¬日常日記}[http://d.hatena.ne.jp/keita_yamaguchi/]

data/Rakefile

@@ -0,0 +1,9 @@
+require "rubygems"
+require "rtask"
+
+RTask.new
+
+desc "Run the specs"
+task "spec" do
+  sh "bacon spec/benchmarkx_spec.rb"
+end

data/lib/benchmarkx.rb

@@ -0,0 +1,164 @@
+require "benchmark"
+require "gruff"
+
+module BenchmarkX
+  VERSION = "001"
+
+  include Benchmark
+
+  alias :benchmark_orig :benchmark
+
+  # Same as Benchmark.benchmark.
+  def benchmark(caption = "", label_width = nil, fmtstr = nil, *labels)
+    # copied from benchmark.rb
+    sync = STDOUT.sync
+    STDOUT.sync = true
+    label_width ||= 0
+    fmtstr ||= FMTSTR
+    raise ArgumentError, "no block" unless iterator?
+    print caption
+
+    # modified
+    report = Report.new(label_width, fmtstr)
+    results = yield(report)
+
+    # copied from benchmark.rb and modified
+    Array === results and results.grep(Tms).each {|t|
+      label = labels.shift
+      print((label || t.label || "").ljust(label_width), t.format(fmtstr))
+      report.record(label, t)
+    }
+    STDOUT.sync = sync
+
+    # new
+    report.render
+  end
+
+  alias :bmbm_orig :bmbm
+
+  # Same as Benchmark.bmbm
+  def bmbm(width = 0, &blk)
+    # copied from benchmark.rb
+    job = Job.new(width)
+    yield(job)
+    width = job.width
+    sync = STDOUT.sync
+    STDOUT.sync = true
+
+    # copied from benchmark.rb
+    # rehearsal
+    print "Rehearsal "
+    puts '-'*(width+CAPTION.length - "Rehearsal ".length)
+    list = []
+    rehearsal = Report.new # appended
+    job.list.each{|label,item|
+      print(label.ljust(width))
+      res = Benchmark::measure(&item)
+      print res.format()
+      list.push res
+
+      # new
+      rehearsal.record(label, res)
+    }
+    sum = Tms.new; list.each{|i| sum += i}
+    ets = sum.format("total: %tsec")
+    printf("%s %s\n\n",
+           "-"*(width+CAPTION.length-ets.length-1), ets)
+
+    # new
+    rehearsal.filename = "rehearsal-" + rehearsal.filename
+    rehearsal.gruff.title = rehearsal.gruff.title.to_s + "(Rehearsal)"
+    rehearsal.render
+
+    # copied from benchmark.rb
+    # take
+    print ' '*width, CAPTION
+    list = []
+    ary = []
+    report = Report.new # appended
+    job.list.each{|label,item|
+      GC::start
+      print label.ljust(width)
+      res = Benchmark::measure(&item)
+      print res.format()
+      ary.push res
+      list.push [label, res]
+
+      # new
+      report.record(label, res)
+    }
+
+    # new
+    report.render
+
+    # copied from benchmark.rb
+    STDOUT.sync = sync
+    ary
+  end
+
+  module_function :benchmark, :measure, :realtime, :bm, :bmbm
+
+  class Report < Benchmark::Report
+    attr_accessor :filename
+    attr_reader :gruff, :labels, :utimes, :stimes, :totals, :reals
+
+    alias :initialize_orig :initialize
+
+    def initialize(width = 0, fmtstr = nil)
+      initialize_orig(width, fmtstr)
+      @gruff = Gruff::SideBar.new
+      @gruff.x_axis_label = "sec"
+      @gruff.sort = false
+      @labels, @utimes, @stimes, @totals, @reals = [], [], [], [], []
+      @filename = "graph.png"
+    end
+
+    def item(label = "", *fmt, &blk)
+      # copied from benchmark.rb
+      print label.ljust(@width)
+      res = Benchmark::measure(&blk)
+      print res.format(@fmtstr, *fmt)
+
+      # new
+      record(label, res)
+
+      # copied from benchmark.rb
+      res
+    end
+
+    alias :report :item
+
+    def record(label,time)
+      @labels << label
+      @utimes << time.utime
+      @stimes << time.stime
+      @totals << time.total
+      @reals << time.real
+    end
+
+    def render
+      @labels.each_with_index{|label, idx| @gruff.labels[idx] = label }
+      @gruff.data("user", @utimes)
+      @gruff.data("system", @stimes)
+      @gruff.data("total", @totals)
+      @gruff.data("real", @reals)
+      @gruff.write(@filename)
+      return self
+    end
+  end
+end
+
+# copied from benchmark.rb and modified a little
+if __FILE__ == $0
+  include BenchmarkX
+
+  n = ARGV[0].to_i.nonzero? || 50000
+  puts "#{n} times iterations of `a = \"1\"'"
+  benchmark("       " + CAPTION, 7, FMTSTR) do |x|
+    x.filename = "graph1.png"
+    x.gruff.title = "#{n} times iterations of `a = \"1\"'"
+    x.report("for:")   {for i in 1..n; a = "1"; end} # Benchmark::measure
+    x.report("times:") {n.times do   ; a = "1"; end}
+    x.report("upto:")  {1.upto(n) do ; a = "1"; end}
+  end
+end

data/spec/benchmarkx_spec.rb

@@ -0,0 +1,103 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require "benchmarkx"
+
+require "rubygems"
+require "stringio"
+require "bacon"
+
+describe "BenchmarkX" do
+  before do
+    FileUtils.rm_f "graph.png"
+    FileUtils.rm_f "rehearsal-graph.png"
+  end
+
+  after do
+    FileUtils.rm_f "graph.png"
+    FileUtils.rm_f "rehearsal-graph.png"
+  end
+
+  # Records the reporting within the block
+  def report(&block)
+    begin
+      @result = StringIO.new
+      $stdout = @result
+      yield
+      $stdout = STDOUT
+    rescue Object => ex
+      $stdout = STDOUT
+      raise ex
+    end
+  end
+
+  it 'should create a graph image' do
+    report do
+      BenchmarkX.bm do |x|
+        x.report("A") { 1 }
+        x.report("B") { 2 }
+        x.report("C") { 3 }
+      end
+    end
+    File.exist?("graph.png").should.be.true
+  end
+
+  it 'should handle "bm" method' do
+    report do
+      Proc.new {
+        BenchmarkX.bm do |x|
+          x.report("A") { 1 }
+          x.report("B") { 2 }
+          x.report("C") { 3 }
+        end
+      }.should.not.raise
+    end
+  end
+
+  it 'should handle "bmbm" method' do
+    report do
+      Proc.new {
+        BenchmarkX.bmbm do |x|
+          x.report("A") { 1 }
+          x.report("B") { 2 }
+          x.report("C") { 3 }
+        end
+      }.should.not.raise
+    end
+    File.exist?("rehearsal-graph.png").should.be.true
+    File.exist?("graph.png").should.be.true
+  end
+
+  it 'should report the result to STDOUT by the normal benchmark format' do
+    report do
+      BenchmarkX.bm do |x|
+        x.report("A") { 1 }
+        x.report("B") { 2 }
+        x.report("C") { 3 }
+      end
+    end
+    @result.string.should =~ /user\s+system\s+total\s+real/
+  end
+
+  it 'should setup gruff object' do
+    report do
+      BenchmarkX.bm do |x|
+        x.gruff.should.be.kind_of(Gruff::SideBar)
+        x.gruff.title = "BenchmarkX"
+        x.gruff.title.should == "BenchmarkX"
+        x.report("A") { 1 }
+        x.report("B") { 2 }
+        x.report("C") { 3 }
+      end
+    end
+  end
+
+  it 'should keep label order' do
+    report do
+      BenchmarkX.bm do |x|
+        x.report("A") { 1 }
+        x.report("B") { 2 }
+        x.report("C") { 3 }
+        x.labels.should == ["A", "B", "C"]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: benchmarkx
+version: !ruby/object:Gem::Version 
+  version: "001"
+platform: ruby
+authors: 
+- Keita Yamaguchi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-12 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: gruff
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: keita.yamaguchi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gemified
+- History.txt
+- License.txt
+- README.txt
+- Rakefile
+- lib/benchmarkx.rb
+- spec/benchmarkx_spec.rb
+has_rdoc: true
+homepage: http://rubyforge.org/projects/benchmarkx/
+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: benchmarkx
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: BenchmarkX is a extension of standard benchmark.rb for rendering sexy graph using gruff.
+test_files: []
+