benchmark_time 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 ebeland
+
+MIT License
+
+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.md

@@ -0,0 +1,48 @@
+# BenchmarkTime
+
+Benchmark the execution time of an arbitrary block of code. Specify concurrent
+threads and number of execution loops for more robust sampling.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'benchmark_time'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install benchmark_time
+
+## Usage
+  require 'benchmark_time'
+
+    benchmark_time(threads: 10, loops: 2) do
+      conn = Bunny.new
+      conn.start
+      ch  = conn.create_channel
+      q   = ch.queue("test1")
+      q.publish(@data)
+      conn.stop
+    end
+
+  ->
+
+  "----------------------------------------"
+  "Samples:               20"
+  "Min time:              0.059449195861816406"
+  "Max time:              0.15325689315795898"
+  "Average time:          0.10354292392730713"
+  "Standard Deviation:    0.027390028761805192"
+  "----------------------------------------"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/benchmark_time.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'benchmark_time/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "benchmark_time"
+  spec.version       = BenchmarkTime::VERSION
+  spec.authors       = ["ebeland"]
+  spec.email         = ["ebeland@gmail.com"]
+  spec.description   = %q{Quickly benchmark functionality from the command line}
+  spec.summary       = %q{Run and benchmark a ruby block with min/max/avg}
+  spec.homepage      = "http://github.com/ericbeland"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/benchmark_time/benchmark_time.rb

@@ -0,0 +1,75 @@
+require_relative "enumerable_statistics"
+
+module BenchmarkTime
+  # A simple time-based benchmarking script for the command line.
+  class BenchmarkTime
+
+    # announce if we have an exception
+    Thread.abort_on_exception = true
+
+    # ==== Arguments
+    #
+    # +&work_block+    The actual work to be performed
+    #
+    # Create and run a new benchmark with output to the command line
+    # ==== Options
+      # +:work_warmup_proc:+ A proc to call for each thread. this can pre-warm connections, 
+      # or perform oother non-timed work.
+      # +:threads+  Number of concurrent threads to execute the work
+      # +:loops+    Number of times to call the block in each execution thread.
+    def initialize(options = {}, &work_block)
+      default_options = {num_threads: 10, num_loops: 10, print_samples: true, work_warmup_proc: nil}
+      options = default_options.merge(options)
+      options.to_instance_variables(binding, define: :attr_reader)
+      @threads            = []
+      @results            = []
+      @results.extend(EnumerableStatistics)
+      @work_block         = work_block
+      run
+    end
+
+    # Returns a time for an arbitrary block's execution
+    def time_operation(&block)
+      start = Time.now.to_ms
+      yield
+      Time.now.to_ms - start
+    end
+
+    # Prints benchmark results to stdout.
+    def display_results(result_array)
+      puts result_array.inspect if @print_samples
+      puts "--------------------------------------------------------------"
+      puts "Samples:                    #{result_array.length}"
+      puts "Min time (ms):              #{result_array.min}"
+      puts "Max time (ms):              #{result_array.max}"
+      puts "Average time (ms):          #{result_array.mean}"
+      puts "Standard Deviation (ms):    #{result_array.standard_deviation}"
+      puts "--------------------------------------------------------------"
+    end
+
+    # Performs a multi-threaded execution of the block as specified in the initializer
+    def run
+      puts "Starting run with #{@num_threads} threads looping #{@num_loops} times"
+      @num_threads.times do 
+        @threads << Thread.new do |th|
+          @num_loops.times do
+            @results << time_operation do 
+              @work_warmup_proc.call if @work_warmup_proc
+              @work_block.call 
+            end
+          end
+        end
+      end
+      @threads.each {|th| th.join }
+      puts "Completed run"
+      display_results(@results)
+    end
+
+  end
+
+end
+
+# an easy wrapper to do the bem
+def benchmark_time(*args, &block)
+  ::BenchmarkTime::BenchmarkTime.new(*args, &block)
+end

data/lib/benchmark_time/enumerable_statistics.rb

@@ -0,0 +1,26 @@
+# Extend enumerable with basic statistical methods
+
+# arr = []
+# arr.extend(EnumerableStatistics)
+
+module EnumerableStatistics
+
+    def sum
+      self.inject(0){|accum, i| accum + i }
+    end
+
+    def mean
+      self.sum/self.length.to_f
+    end
+
+    def sample_variance
+      m = self.mean
+      sum = self.inject(0){|accum, i| accum +(i-m)**2 }
+      sum/(self.length - 1).to_f
+    end
+
+    def standard_deviation
+      Math.sqrt(self.sample_variance)
+    end
+
+end 

data/lib/benchmark_time/hash_extensions.rb

@@ -0,0 +1,13 @@
+module HashExtensions
+  def to_instance_variables(bind, opts={})
+    each do |key, val|
+      bind.eval("@#{key}=#{val.inspect}")
+      # we can build attr_accessor, attr_reader, attr_writers off these options
+     # bind.eval "self.class.class_eval 'attr_reader :foo'"if opts[:define]
+    end
+  end
+end
+
+class Hash
+  include HashExtensions
+end

data/lib/benchmark_time/time.rb

@@ -0,0 +1,5 @@
+class Time
+  def to_ms
+    (self.to_f * 1000.0).to_i
+  end
+end

data/lib/benchmark_time/version.rb

@@ -0,0 +1,3 @@
+module BenchmarkTime
+  VERSION = "1.0.0"
+end

data/lib/benchmark_time.rb

@@ -0,0 +1,6 @@
+require_relative "benchmark_time/version"
+
+require_relative "benchmark_time/hash_extensions"
+require_relative "benchmark_time/enumerable_statistics"
+require_relative "benchmark_time/benchmark_time"
+require_relative "benchmark_time/time"

data/sample/sample_benchmark.rb

@@ -0,0 +1,5 @@
+require_relative "../lib/benchmark_time"
+
+benchmark_time(threads: 10, loops: 2, print_samples: true) do
+ sleep 1.00
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: benchmark_time
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- ebeland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Quickly benchmark functionality from the command line
+email:
+- ebeland@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark_time.gemspec
+- lib/benchmark_time.rb
+- lib/benchmark_time/benchmark_time.rb
+- lib/benchmark_time/enumerable_statistics.rb
+- lib/benchmark_time/hash_extensions.rb
+- lib/benchmark_time/time.rb
+- lib/benchmark_time/version.rb
+- sample/sample_benchmark.rb
+homepage: http://github.com/ericbeland
+licenses:
+- MIT
+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.8.25
+signing_key: 
+specification_version: 3
+summary: Run and benchmark a ruby block with min/max/avg
+test_files: []
+has_rdoc: