benchmark_time 1.0.1 → 1.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e0dd882b3f3c6affd29552750cde584f613743a
+  data.tar.gz: 787352d18319099f0cc43bcab25ba6bda005f621
+SHA512:
+  metadata.gz: 4f7cf60d047bfbba6794e3e1c390354d0abea16a20fb8d0d7ee5cce762624b5124d614c1b16314f186e07bc1c85bcc065b78d5ef55cee426dd75b51a31a6dca5
+  data.tar.gz: 899d34d1995fe566cfd8716ea289ced015b8b699690b0e8485cb46562483b5819cf529b911377a6269bd0c5327008f035480e8a3e777b0841d3d25f8fa0eb34d

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/README.md

@@ -1,7 +1,12 @@
 # BenchmarkTime
 
 Benchmark the execution time of an arbitrary block of code. Specify concurrent
-threads and number of execution loops.
+<<<<<<< HEAD
+threads and number of execution loops for more robust sampling. 
+
+BenchmarkTime is especially built to benchmark things like external services, 
+rather than ruby code itself. It can do something like a small scale 
+load test of external dependencies and give you a benchmark with concurrency.
 
 ## Installation
 
@@ -18,9 +23,11 @@ Or install it yourself as:
     $ gem install benchmark_time
 
 ## Usage
-
-  require 'benchmark_time'
-  require 'bunny'
+ 
+ # Benchmarking rabbitmq with bunny:
+ 
+    require 'benchmark_time'
+    require 'bunny'
 
     # Benchmark connecting and filing an item into rabbitmq with bunny
     benchmark_time(num_threads: 10, num_loops: 5) do
@@ -33,20 +40,36 @@ Or install it yourself as:
     end
 
   ->
-  --------------------------------------------------------------
+  "----------------------------------------"
+
+  "Samples:               20"
 
-  Samples:                    50
+  "Min time:              0.059449195861816406"
 
-  Min time (ms):              6
+  "Max time:              0.15325689315795898"
 
-  Max time (ms):              157
+  "Average time:          0.10354292392730713"
 
-  Average time (ms):          32.6
+  "Standard Deviation:    0.027390028761805192"
 
-  Standard Deviation (ms):    25.33046886777315
+  "----------------------------------------"
 
-  --------------------------------------------------------------
+  # Options for benchmark_time:
 
+      :work_warmup_proc A proc to call for each thread. this can pre-warm connections, 
+      or perform oother non-timed work.
+      
+      :num_threads          Number of concurrent threads to execute the work
+      
+      :num_loops            Number of times to call the block in each execution thread.
+      
+      :loop_delay           Delay after each loop. (defaults to 0)
+      
+      :show_values          If printing output show actual variable values (good at small scale)
+      
+      :print_results        If true, puts the result to sdtout at the end.
+      
+      :garbage_collection   If false (default) garbage colleciton will be off during the loop to benchmark.
 
 
 ## Contributing

data/benchmark_time.gemspec

@@ -17,7 +17,8 @@ Gem::Specification.new do |spec|
   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 "mocha"
+  spec.add_development_dependency "rspec"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 end

data/lib/benchmark_time/benchmark_time.rb

@@ -14,19 +14,32 @@ module BenchmarkTime
     # 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 other non-timed work.
-      # +: num_threads+  Number of concurrent threads to execute the work
-      # +: num_loops+    Number of times to call the block in each execution thread.
+      # or perform oother non-timed work.
+      # +:num_threads+        Number of concurrent threads to execute the work
+      # +:num_loops+          Number of times to call the block in each execution thread.
+      # +:loop_delay          Delay after each loop. (defaults to 0)
+      # 
+      # +:show_values+         If output is printed, display array of actual variable values (good at small scale)
+      # +:print_results+       If true, puts the result to sdtout at the end.
+      # +:garbage_collection+  If false (default) garbage colleciton will be off during the loop to benchmark.
+
+
     def initialize(options = {}, &work_block)
-      default_options = {num_threads: 10, num_loops: 10, print_samples: true, work_warmup_proc: nil}
+      default_options = { num_threads:          10, 
+                          num_loops:            10, 
+                          loop_delay:           0,
+                          show_values:          true, 
+                          print_results:        true,
+                          garbage_collection:   false,
+                          work_warmup_proc:     nil, 
+                        }
+
       options = default_options.merge(options)
-      # experiment: auto-create instance variables from hash...
-      options.to_instance_variables(binding, define: :attr_reader) 
+      options.to_instance_variables(binding, define: :attr_reader)
       @threads            = []
       @results            = []
-      @results.extend(EnumerableStatistics)
       @work_block         = work_block
-      run
+      @results.extend(EnumerableStatistics)
     end
 
     # Returns a time for an arbitrary block's execution
@@ -38,32 +51,36 @@ module BenchmarkTime
 
     # 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 "------------------- Completed run ----------------------------"
+      puts "Samples:               #{result_array.length}"
+      puts "Min time:              #{result_array.min}"
+      puts "Max time:              #{result_array.max}"
+      puts "Average time:          #{result_array.mean}"
+      puts "Standard Deviation:    #{result_array.standard_deviation}"
+      puts "Values:                #{result_array.inspect}" if @show_values
       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"
+      puts "Starting run with #{@num_threads} threads looping #{@num_loops} times" if @print_results 
       @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 
+              result = @work_block.call 
+              sleep @loop_delay
+              result
             end
           end
         end
       end
+      GC.disable unless @garbage_collection
       @threads.each {|th| th.join }
-      puts "Completed run"
-      display_results(@results)
+      GC.enable
+      display_results(@results) if @print_results 
+      @results
     end
 
   end
@@ -72,5 +89,6 @@ end
 
 # an easy wrapper to do the bem
 def benchmark_time(*args, &block)
-  ::BenchmarkTime::BenchmarkTime.new(*args, &block)
+  b = BenchmarkTime::BenchmarkTime.new(*args, &block)
+  b.run
 end

data/lib/benchmark_time/enumerable_statistics.rb

@@ -6,17 +6,17 @@
 module EnumerableStatistics
 
     def sum
-      self.inject(0){|accum, i| accum + i }
+      self.inject(0) {|accum, i| accum + i }
     end
 
     def mean
-      self.sum/self.length.to_f
+      self.sum / self.length.to_f
     end
 
     def sample_variance
-      m = self.mean
+      m   = self.mean
       sum = self.inject(0){|accum, i| accum +(i-m)**2 }
-      sum/(self.length - 1).to_f
+      sum / (self.length - 1).to_f
     end
 
     def standard_deviation

data/lib/benchmark_time/version.rb

@@ -1,3 +1,3 @@
 module BenchmarkTime
-  VERSION = "1.0.1"
+  VERSION = "1.2.1"
 end

data/sample/media_library_benchmark.rb

@@ -0,0 +1,9 @@
+require "bunny"
+require_relative "../lib/benchmark_time"
+
+
+benchmark_time(threads: 10, loops: 2) do
+ # thing to benchmark goes here...
+
+ 
+end

data/spec/benchmark_spec.rb

@@ -0,0 +1,54 @@
+require_relative "spec_helper"
+
+describe 'benchmark_time' do
+
+  it "should return an array with results" do
+    results = benchmark_time(num_threads: 1, num_loops: 2) { }
+    results.length.should == 2    
+    results = benchmark_time(num_threads: 4, num_loops: 4) { }
+    results.length.should == 16 
+  end
+
+  it "should return min/max/average" do
+    results = benchmark_time(num_threads: 1, num_loops: 2) { }
+    (results.min    >= 0).should be_true
+    (results.max    >= 0).should be_true
+    (results.mean   >= 0).should be_true
+  end
+
+  it "should print values if true" do
+    output = capture_stdout do
+      benchmark_time(num_threads: 1, num_loops: 1) {}
+    end
+    (output =~ /Values/).should be_true
+  end
+
+  it "should print min/max/average if printing output" do
+    output = capture_stdout do
+      benchmark_time(num_threads: 1, num_loops: 2) {}
+    end
+    (output =~ /min time/i).should be_true
+    (output =~ /max time/i).should be_true
+    (output =~ /average time/i).should be_true
+  end
+
+  it "should not print anything if printing output is disabled" do
+    output = capture_stdout do
+      benchmark_time(num_threads: 1, num_loops: 2, print_results: false) {}
+    end
+    output.empty?.should be_true
+  end
+
+  it "should disable garbage collection if off" do
+    GC.expects(:disable).once.returns(true)
+    results = benchmark_time(num_threads: 2, num_loops: 1, garbage_collection: false) { }
+    GC.unstub(:disable)
+  end
+
+  it "should not disable garbage collection if off" do
+    GC.expects(:disable).never.returns(true)
+    results = benchmark_time(num_threads: 2, num_loops: 1, garbage_collection: true) { }
+    GC.unstub(:disable)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'bundler/setup'
+require "benchmark_time"
+require 'mocha/api'
+
+RSpec.configure do |config|
+ 
+end
+
+def capture_stdout &block
+  old_stdout = $stdout
+  fake_stdout = StringIO.new
+  $stdout = fake_stdout
+  block.call
+  fake_stdout.string
+ensure
+  $stdout = old_stdout
+end

metadata

@@ -1,20 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: benchmark_time
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: 1.2.1
 platform: ruby
 authors:
 - ebeland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-03 00:00:00.000000000 Z
+date: 2014-03-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,17 +55,15 @@ dependencies:
 - !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
@@ -51,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -62,31 +86,34 @@ files:
 - lib/benchmark_time/hash_extensions.rb
 - lib/benchmark_time/time.rb
 - lib/benchmark_time/version.rb
+- sample/media_library_benchmark.rb
 - sample/sample_benchmark.rb
+- spec/benchmark_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/ericbeland
 licenses:
 - MIT
+metadata: {}
 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
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Run and benchmark a ruby block with min/max/avg
-test_files: []
-has_rdoc: 
+test_files:
+- spec/benchmark_spec.rb
+- spec/spec_helper.rb