benchmark_time 1.0.0 → 1.0.1

data/README.md

@@ -1,7 +1,7 @@
 # BenchmarkTime
 
 Benchmark the execution time of an arbitrary block of code. Specify concurrent
-threads and number of execution loops for more robust sampling.
+threads and number of execution loops.
 
 ## Installation
 
@@ -18,26 +18,36 @@ Or install it yourself as:
     $ gem install benchmark_time
 
 ## Usage
+
   require 'benchmark_time'
+  require 'bunny'
 
-    benchmark_time(threads: 10, loops: 2) do
+    # Benchmark connecting and filing an item into rabbitmq with bunny
+    benchmark_time(num_threads: 10, num_loops: 5) do
       conn = Bunny.new
       conn.start
       ch  = conn.create_channel
       q   = ch.queue("test1")
-      q.publish(@data)
+      q.publish('hello bunny')
       conn.stop
     end
 
   ->
+  --------------------------------------------------------------
+
+  Samples:                    50
+
+  Min time (ms):              6
+
+  Max time (ms):              157
+
+  Average time (ms):          32.6
+
+  Standard Deviation (ms):    25.33046886777315
+
+  --------------------------------------------------------------
+
 
-  "----------------------------------------"
-  "Samples:               20"
-  "Min time:              0.059449195861816406"
-  "Max time:              0.15325689315795898"
-  "Average time:          0.10354292392730713"
-  "Standard Deviation:    0.027390028761805192"
-  "----------------------------------------"
 
 ## Contributing
 

data/lib/benchmark_time/benchmark_time.rb

@@ -14,13 +14,14 @@ 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 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.
+      # 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.
     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)
+      # experiment: auto-create instance variables from hash...
+      options.to_instance_variables(binding, define: :attr_reader) 
       @threads            = []
       @results            = []
       @results.extend(EnumerableStatistics)

data/lib/benchmark_time/hash_extensions.rb

@@ -1,4 +1,6 @@
 module HashExtensions
+
+  # experiment to make hash arguments into instance variables
   def to_instance_variables(bind, opts={})
     each do |key, val|
       bind.eval("@#{key}=#{val.inspect}")

data/lib/benchmark_time/version.rb

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

data/sample/sample_benchmark.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: benchmark_time
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors: