rgauge 1.0.4

data/History.rdoc

@@ -0,0 +1,29 @@
+
+=== 1.0.4 / 2009-03-19
+
+* Added warmup support
+* Added #swap_caption
+* Misc refactoring
+* Removed #assign_report_performance
+
+=== 1.0.3 / 2009-01-30
+
+* Added :scale option, alias of :duration_scale
+* Added :format option, alias of :duration_format
+* Updated length of report, made it larger to support larger labels
+
+=== 1.0.1 / 2009-01-16
+
+* Changed spinner to include the caption like: / benchmarking @caption
+
+=== 1.0.0 / 2009-01-16
+
+* Added sexy ANSI progress indication spinner
+
+=== 0.0.2 / 2009-01-16
+
+* Added progress indication
+
+=== 0.0.1 / 2009-01-15
+
+* Initial release

data/Manifest

@@ -0,0 +1,19 @@
+examples/simple.rb
+History.rdoc
+lib/rgauge/formatters/terminal.rb
+lib/rgauge/formatters.rb
+lib/rgauge/import.rb
+lib/rgauge/runner.rb
+lib/rgauge/version.rb
+lib/rgauge.rb
+Manifest
+Rakefile
+README.rdoc
+rgauge.gemspec
+spec/functional/rguage_spec.rb
+spec/spec_helper.rb
+tasks/benchmark.rake
+tasks/docs.rake
+tasks/gemspec.rake
+tasks/spec.rake
+Todo.rdoc

data/README.rdoc

@@ -0,0 +1,57 @@
+
+= RGauge
+
+Ultra slick benchmarking DSL, sexiest of them all.
+
+== Features:
+
+* Simple
+* Nestable
+* Sorts performance results ascending (fastest first, easy on the brain)
+* Pretty (ansi escape sequences sexify things, and progress indication)
+* Formatters (more to come)
+
+== Example:
+
+  require 'rubygems'
+  require 'rgauge'
+
+  benchmark 'Inflection', :times => 100_000 do
+    report('camel_case') { 'underscore_string'.camel_case }
+    report('snake_case') { 'CamelCaseString'.snake_case }
+    report('pluralize')  { 'lots of goose'.pluralize }
+  end
+
+== Output:
+
+  Inflection                100,000 times
+  ---------------------------------------
+  pluralize                       0.408 |
+  camel_case                      1.078 |
+  snake_case                      1.197 |
+
+== License:
+
+(The MIT License)
+
+Copyright (c) 2008 TJ Holowaychuk <tj@vision-media.ca>
+
+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, an d/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.
+LINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,14 @@
+
+require 'rubygems'
+require 'rake'
+require 'echoe'
+require './lib/rgauge.rb'
+
+Echoe.new("rgauge", RGauge::VERSION) do |p|
+  p.author = "TJ Holowaychuk"
+  p.email = "tj@vision-media.ca"
+  p.summary = "Ultra slick benchmarking DSL"
+  p.url = "http://github.com/visionmedia/rgauge"
+end
+
+Dir['tasks/**/*.rake'].sort.each { |lib| load lib }

data/Todo.rdoc

@@ -0,0 +1,15 @@
+
+== Major:
+
+* Allow array of 'times' and re-benchmark each of those times
+* Allow overriding of options via #report
+* Comparison percentages (best being 100%, 1/3 slower 150% etc)
+* More formatters like charts
+
+== Minor:
+
+* Nothing
+
+== Brainstorming:
+
+* Nothing

data/examples/simple.rb

@@ -0,0 +1,26 @@
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'rgauge'
+require 'benchmark'
+require 'rubygems'
+require 'extlib'
+
+# RGauge
+
+benchmark 'Inflection', :times => 100_000, :scale => 4, :warmup => true do
+  report('camel_case') { 'underscore_string'.camel_case }
+  report('snake_case') { 'CamelCaseString'.snake_case }
+  report('pluralize')  { 'lots of goose'.pluralize }
+end
+
+# Standard library benchmark.rb
+
+puts
+puts 'Standard library:'
+n = 100_000
+Benchmark.bm(15) do |x|
+  x.report("camel_case") { n.times do 'underscore_string'.camel_case end }
+  x.report("snake_case") { n.times do 'CamelCaseString'.snake_case end }
+  x.report("pluralize") { n.times do 'lots of goose'.pluralize end }
+end

data/lib/rgauge.rb

@@ -0,0 +1,29 @@
+#--
+# Copyright (c) 2008 TJ Holowaychuk
+#
+# 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.
+#++
+
+$:.unshift File.dirname(__FILE__)
+
+require 'rgauge/version'
+require 'rgauge/runner'
+require 'rgauge/formatters'
+require 'rgauge/import'

data/lib/rgauge/formatters.rb

@@ -0,0 +1,6 @@
+
+module RGauge
+  module Formatter
+    autoload :Terminal, 'rgauge/formatters/terminal'
+  end
+end

data/lib/rgauge/formatters/terminal.rb

@@ -0,0 +1,108 @@
+
+module RGauge
+  module Formatter
+    class Terminal
+      
+      ##
+      # Terminal benchmark formatter.
+      
+      def initialize runner, reports
+        @runner, @reports = runner, reports
+        @scale = @runner.options.fetch :scale, 3
+        @format = @runner.options.fetch :format, "%0.#{@scale}f"
+        @reports = @reports.sort_by { |report| report[:duration] }
+        render
+      end
+      
+      ##
+      # Render the benchmark reporting.
+      
+      def render
+        s = '%-30s %s' % headings
+        s << seperator << render_rows
+        puts "#{indent(s)}\n\n"
+      end
+      
+      ##
+      # Render a seperator.
+      
+      def seperator
+        "\n#{ '-' * 49 }\n"
+      end
+      
+      ##
+      # Render rows.
+      
+      def render_rows
+        rows.map { |row| render_row row }.join "\n"
+      end
+      
+      private
+      
+      def render_row row
+        '%-34s %12s |' % row
+      end
+      
+      ##
+      # Return formatted headings.
+      
+      def headings
+        return @runner.caption, call_times
+      end
+      
+      ##
+      # Return array of rows captured by the runner.
+      
+      def rows
+        @reports.map do |report|
+          [report[:label], @format % report[:duration]]
+        end
+      end
+      
+      ##
+      # Formatted number of times called label.
+      
+      def call_times
+        return '' if @runner.n <= 1
+        '%20s times' % bold(sexify_int(@runner.n))
+      end
+      
+      ##
+      # Wrap a string in red.
+      
+      def red string
+        "\e[31m#{string}\e[0m"
+      end
+      
+      ##
+      # Wrap a string in green.
+            
+      def green string
+        "\e[32m#{string}\e[0m"
+      end
+      
+      ##
+      # Wrap a string in bold.
+      
+      def bold string
+        "\e[1m#{string}\e[0m"
+      end
+      
+      ##
+      # Indent a +string+, x number of +spaces+.
+      
+      def indent string, spaces = 2
+        string.to_s.gsub! /^/, (" " * spaces)
+      end
+      
+      ##
+      # Sexify an +int+ by converting to a string and generating thousandths seperators.
+      # For example 1000000 becomes 1,000,000.
+      
+      def sexify_int int
+        int.to_s.gsub /(\d)(?=(\d\d\d)+(?!\d))/, '\1,'
+      end
+      
+    end
+  end
+end

data/lib/rgauge/import.rb

@@ -0,0 +1,6 @@
+
+module Kernel
+  def benchmark *args, &block
+    RGauge::Runner.new *args, &block
+  end
+end

data/lib/rgauge/runner.rb

@@ -0,0 +1,130 @@
+
+module RGauge
+  class Runner
+    
+    attr_reader :options, :threads, :caption, :reports
+    
+    ##
+    # Create a new runner with a given +caption+ and +options+.
+    #
+    # === Options:
+    #
+    #   :times      Number of times to call each procedure;       Default 1
+    #   :formatter  Output formatter instantiated for reporting;  Default RGauge::Formatter::Terminal
+    #
+    #   Terminal formatter:
+    #   
+    #   :scale   Decimals to the right of the duration. Default 3
+    #   :format  Format string used to output duration. Default '%0.#{duration_scale}f'
+    #
+    
+    def initialize caption = '', options = {}, &block
+      @reports, @finished, @caption = [], false, "benchmarking #{caption}"
+      @options = { :times => 1, :formatter => Formatter::Terminal }.merge options
+      instance_eval &block
+      run!
+    end
+    
+    ##
+    # Run the reports.
+    
+    def run!
+      puts "\n" 
+      display_progress
+      reports.each { |report| warmup report } if options[:warmup] 
+      reports.each { |report| benchmark report }  
+      finished!
+      options[:formatter].new self, @reports
+    end
+    
+    ##
+    # Add a report with +label+ and +block+.
+    
+    def report label = '', &block
+      @reports << { :label => label, :proc => block }
+    end
+    
+    ##
+    # Number of times to perform the procedure call.
+    
+    def n
+      options[:times].to_i
+    end
+    
+    ##
+    # Wither or not the benchmarking is complete.
+    
+    def finished?
+      @finished
+    end
+    
+    ##
+    # Finish benchmarking.
+        
+    def finished!
+      @finished = true
+      erase_line
+    end
+    
+    ##
+    # Run the +report+ once to 'warm it up'.
+    
+    def warmup report
+      swap_caption "warming up #{report[:label]}" do
+        report[:proc].call
+      end
+    end
+
+    ##
+    # Erase previous terminal line.
+
+    def erase_line
+      print "\r\e[K"
+    end
+    
+    ##
+    # Set caption to +string+, setting back
+    # the original caption after block execution 
+    # is complete.
+    
+    def swap_caption string, &block
+      prev_caption, @caption = @caption, string
+      yield
+      @caption = prev_caption
+    end
+    
+    ##
+    # Print a rgauge caption +string+.
+    
+    def print_caption string, count = 0
+      s = '|', '/', '-', '\\'
+      print "  \e[1m" + s[count % s.length] + "\e[0m #{string} "
+      $stdout.flush
+      erase_line
+    end
+    
+    ##
+    # Benchmark a +report+.
+    
+    def benchmark report
+      start = Time.now
+      for i in 1..n; report[:proc].call end
+      report[:duration] = (Time.now - start)
+    end
+    
+    ##
+    # Display progress of benchmark.
+    
+    def display_progress
+      Thread.new do
+        count = 0
+        until finished? do
+          print_caption caption, count
+          count += 1
+          sleep 0.05
+        end
+      end
+    end
+    
+  end
+end

data/lib/rgauge/version.rb

@@ -0,0 +1,4 @@
+
+module RGauge
+  VERSION = '1.0.4'
+end

data/rgauge.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rgauge}
+  s.version = "1.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["TJ Holowaychuk"]
+  s.date = %q{2009-03-19}
+  s.description = %q{Ultra slick benchmarking DSL}
+  s.email = %q{tj@vision-media.ca}
+  s.extra_rdoc_files = ["lib/rgauge/formatters/terminal.rb", "lib/rgauge/formatters.rb", "lib/rgauge/import.rb", "lib/rgauge/runner.rb", "lib/rgauge/version.rb", "lib/rgauge.rb", "README.rdoc", "tasks/benchmark.rake", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
+  s.files = ["examples/simple.rb", "History.rdoc", "lib/rgauge/formatters/terminal.rb", "lib/rgauge/formatters.rb", "lib/rgauge/import.rb", "lib/rgauge/runner.rb", "lib/rgauge/version.rb", "lib/rgauge.rb", "Manifest", "Rakefile", "README.rdoc", "rgauge.gemspec", "spec/functional/rguage_spec.rb", "spec/spec_helper.rb", "tasks/benchmark.rake", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "Todo.rdoc"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/visionmedia/rgauge}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Rgauge", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rgauge}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Ultra slick benchmarking DSL}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/functional/rguage_spec.rb

@@ -0,0 +1 @@
+

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+
+require 'rgauge'
+

data/tasks/benchmark.rake

@@ -0,0 +1,5 @@
+
+desc 'Benchmark'
+task :benchmark do
+  ruby 'examples/simple.rb'
+end

data/tasks/docs.rake

@@ -0,0 +1,13 @@
+
+namespace :docs do
+  
+  desc 'Remove rdoc products'
+  task :remove => [:clobber_docs]
+  
+  desc 'Build docs, and open in browser for viewing (specify BROWSER)'
+  task :open => [:docs] do
+    browser = ENV["BROWSER"] || "safari"
+    sh "open -a #{browser} doc/index.html"
+  end
+  
+end

data/tasks/gemspec.rake

@@ -0,0 +1,3 @@
+
+desc 'Build gemspec file'
+task :gemspec => [:build_gemspec]

data/tasks/spec.rake

@@ -0,0 +1,25 @@
+
+require 'spec/rake/spectask'
+  
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << "lib"
+  t.spec_opts = ["--color", "--require", "spec/spec_helper.rb"]
+end
+  
+namespace :spec do
+
+  desc "Run all specifications verbosely"
+  Spec::Rake::SpecTask.new(:verbose) do |t|
+    t.libs << "lib"
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+  desc "Run specific specification verbosely (specify SPEC)"
+  Spec::Rake::SpecTask.new(:select) do |t|
+    t.libs << "lib"
+    t.spec_files = [ENV["SPEC"]]
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: rgauge
+version: !ruby/object:Gem::Version 
+  version: 1.0.4
+platform: ruby
+authors: 
+- TJ Holowaychuk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-19 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Ultra slick benchmarking DSL
+email: tj@vision-media.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/rgauge/formatters/terminal.rb
+- lib/rgauge/formatters.rb
+- lib/rgauge/import.rb
+- lib/rgauge/runner.rb
+- lib/rgauge/version.rb
+- lib/rgauge.rb
+- README.rdoc
+- tasks/benchmark.rake
+- tasks/docs.rake
+- tasks/gemspec.rake
+- tasks/spec.rake
+files: 
+- examples/simple.rb
+- History.rdoc
+- lib/rgauge/formatters/terminal.rb
+- lib/rgauge/formatters.rb
+- lib/rgauge/import.rb
+- lib/rgauge/runner.rb
+- lib/rgauge/version.rb
+- lib/rgauge.rb
+- Manifest
+- Rakefile
+- README.rdoc
+- rgauge.gemspec
+- spec/functional/rguage_spec.rb
+- spec/spec_helper.rb
+- tasks/benchmark.rake
+- tasks/docs.rake
+- tasks/gemspec.rake
+- tasks/spec.rake
+- Todo.rdoc
+has_rdoc: true
+homepage: http://github.com/visionmedia/rgauge
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Rgauge
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: rgauge
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Ultra slick benchmarking DSL
+test_files: []
+