rbm 0.0.1

data/README.md

@@ -0,0 +1,45 @@
+# Ruby Benchmark
+
+rbm is a command line tool for doing quick benchmarks of ruby code.
+
+# Installing
+
+## Recommended
+
+    gem install rbm
+
+## Edge
+
+    git clone https://github.com/samuelkadolp/rbm.git
+    cd rbm && rake install
+
+# Usage
+
+Using rbm is quite simple. Just pass in each code fragment you want to test as a separate argument.
+
+    rbm "sleep 1" "sleep 5"
+
+You can specify the number of times to loop. You can also provide a code fragment to be run before each time each code fragment is run.
+
+    rbm --times 100 "sleep 0.01"
+    rbm --prerun "n = 5" "sleep n"
+
+You may provide a name to each code fragment to be displayed on the benchmark.
+
+    rbm --name "sleep for 5" "sleep 5" --name "sleep for 2" "sleep 2"
+
+You can see the full usage statement at any time with `rbm --help`
+
+    Usage: rbm [options] [--name name] code [[-N name] code...]
+
+    Ruby Options:
+        -r, --require file[,file]        Files to require before benchmarking
+        -I, --load-path path[,path]      Paths to append to $LOAD_PATH
+
+    Benchmark Options:
+        -n, --times N                    Number of times to run each code fragment
+        -p, --pre code                   Code to run before each code fragment to be benchmarked
+        -N, --name name                  Names the following code fragment
+
+    General Options:
+        -h, --help                       Show this message

data/UNLICENSE

@@ -0,0 +1,22 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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/bin/rbm

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "rbm"
+
+RBM.start

data/lib/rbm.rb

@@ -0,0 +1,78 @@
+require 'optparse'
+require 'rbm/benchmarker'
+
+module RBM
+  class << self
+    def start
+      fragments, options = parse_options(ARGV)
+
+      if load_paths = options.delete(:load_paths)
+        $LOAD_PATH.concat(load_paths)
+      end
+
+      begin
+        if requires = options.delete(:requires)
+          requires.each { |r| require(r) }
+        end
+      rescue LoadError => e
+        puts e
+        exit
+      end
+
+      begin
+        Benchmarker.new(fragments, options).run
+      rescue BenchmarkerSyntaxError => e
+        puts e
+        exit
+      end
+    end
+
+    private
+      def parse_options(args)
+        fragments, options = [], {}
+        current_name = nil
+
+        op = OptionParser.new do |op|
+          op.banner = "Usage: #{op.program_name} [options] [--name name] code [[-N name] code...]"
+
+          op.separator ''
+          op.separator 'Ruby Options:'
+
+          op.on('-r', '--require file[,file]', Array, 'Files to require before benchmarking') do |list|
+            (options[:requires] ||= []).concat(list)
+          end
+
+          op.on('-I', '--load-path path[,path]', Array, 'Paths to append to $LOAD_PATH') do |list|
+            (options[:load_paths] ||= []).concat(list)
+          end
+
+          op.separator ''
+          op.separator 'Benchmark Options:'
+
+          op.on('-n', '--times N', Integer, 'Number of times to run each code fragment') { |n| options[:times] = n }
+          op.on('-p', '--pre code', String, 'Code to run before each code fragment to be benchmarked') { |p| options[:prerun] = p }
+          op.on('-N', '--name name', String, 'Names the following code fragment') { |n| current_name = n }
+
+          op.separator ''
+          op.separator 'General Options:'
+
+          op.on('-h', '--help', 'Show this message') do
+            puts op
+            exit
+          end
+        end
+        op.order!(args) do |fragment|
+          # block gets run for each non-option argument
+          fragments << [current_name || '', fragment]
+          current_name = nil
+        end
+
+        if fragments.empty?
+          puts op
+          exit
+        end
+
+        [fragments, options]
+      end
+  end
+end

data/lib/rbm/benchmarker.rb

@@ -0,0 +1,73 @@
+require 'benchmark'
+
+module RBM
+  class Benchmarker
+    DEFAULT_OPTIONS = {
+      :times => 1
+    }
+
+    attr_reader :options
+
+    def initialize(fragments, options)
+      @options = DEFAULT_OPTIONS.merge(options)
+
+      compile_prerun(options[:prerun])
+      @fragments = fragments.map { |name, fragment| [name, compile_fragment(fragment, options[:prerun], name)] }
+    end
+
+    def run
+      width = @fragments.map { |name, method| name.size }.max
+      Benchmark.bm(width) do |bm|
+        @fragments.each do |name, method|
+          bm.report(name) do
+            # TODO: wrap errors from fragment execution
+            options[:times].times { send(method) }
+          end
+        end
+      end
+    end
+
+    private
+      def compile_prerun(prerun)
+        # TODO:
+        #   another way to check prerun syntax outside of compile_fragment so we can
+        #   give meaningful syntax errors (error in prerun not in a fragment itself)
+        wrap_syntax_errors do
+          instance_eval <<-EVAL, "prerun", -1
+            def bm_prerun
+              #{prerun}
+            end
+            undef bm_prerun
+          EVAL
+        end
+      end
+
+      def compile_fragment(fragment, prerun = nil, name = nil)
+        name = (@fragment_name ||= "fragment_0").succ! unless name && !name.empty?
+        fragment_name = "bm_#{name.gsub(/\s+/, '_')}".to_sym
+        defined = instance_method(fragment_name) rescue false
+        raise "#{fragment_name} is already defined" if defined
+
+        wrap_syntax_errors do
+          # TODO: provide better runtime errors and NameError errors and cleaner stack trace
+          instance_eval <<-EVAL, name, -1
+            def #{fragment_name}
+              #{prerun}
+              #{fragment}
+            end
+          EVAL
+        end
+
+        fragment_name
+      end
+
+      def wrap_syntax_errors
+        yield
+      rescue SyntaxError => e
+        raise(BenchmarkerSyntaxError.new(e.to_s))
+      end
+  end
+
+  class BenchmarkerSyntaxError < SyntaxError
+  end
+end

data/lib/rbm/version.rb

@@ -0,0 +1,3 @@
+module RBM
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: rbm
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Samuel Kadolph
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-14 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Command line tool for doing quick ruby benchmarks. Provide each code fragment to run as a separate code fragment to rbm.See rbm --help for more information.
+email: 
+- samuel@kadolph.com
+executables: 
+- rbm
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/rbm
+- lib/rbm/benchmarker.rb
+- lib/rbm/version.rb
+- lib/rbm.rb
+- README.md
+- UNLICENSE
+has_rdoc: true
+homepage: https://github.com/samuelkadolph/rbm
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Simple command line tool for quick ruby benchmarks.
+test_files: []
+