trick_bag 0.40.0 → 0.41.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDVjMzY3ZGQ2ODZhM2MxOTZkMGQ2NmYyMWQ4NGIzMzQzYTFjZmQ2Mw==
+  data.tar.gz: !binary |-
+    YzNiNzBkMWVjMjVlZjI5NWFhZTRkMDQ4ODY0OTY1YjdhMGFhZGU5OQ==
+SHA512:
+  metadata.gz: !binary |-
+    MjEyNzc0NjBiNGJlODYzY2ZkZGJhMjRiNGU2OWNkMzI0YjBhNjE3NjdjYTIy
+    ZjQwMjBlYTQwN2FjZDg4NTAyMzVmNWEyODJkOTY0OWZjYmZhYmMyYWJjYjc0
+    YjIxMzliZTczZjA5NDZlMTNkYjk3YjlkMDU4MTBlM2IzN2M1ZmM=
+  data.tar.gz: !binary |-
+    MmI0NWNiMjM4MDkxMmI3MzBmMTdhODYwYTM4OGM5ZTJmYTBkOGVmMDczMDVi
+    YzJjNjBlYTM3NTViNjBmODFhNzg3NTY0ODg1MWUyYmQ5NTkxYjA5MWE2MzE3
+    Mjk5ZTVhYzU2MjY3YjUyNGFiMmU2MDlhMTNmNTRhOWIwNjRiZmM=

data/RELEASE_NOTES.md

@@ -1,3 +1,8 @@
+## v0.41.0
+
+*  Added Timing.benchmark().
+
+
 ## v0.40.0
 
 * Added Validations.raise_on_invalid_value.

data/lib/trick_bag/timing/timing.rb

@@ -1,4 +1,5 @@
 require 'trick_bag/io/text_mode_status_updater'
+require 'benchmark'
 
 module TrickBag
 module Timing
@@ -45,5 +46,26 @@ module Timing
     success
   end
 
+
+  # Executes the passed block with the Ruby Benchmark standard library.
+  # Prints the benchmark string to the specified output stream.
+  # Returns the passed block's return value.
+  #
+  # e.g.   benchmark('time to loop 1,000,000 times') { 1_000_000.times { 42 }; 'hi' }
+  # outputs to the specified output stream the following string:
+  #   0.050000   0.000000   0.050000 (  0.042376): time to loop 1,000,000 times
+  #  and returns: 42
+  #
+  # @param caption the text fragment to print after the timing data
+  # @param out_stream object responding to << that will get the output string
+  #   @default $stdout
+  # @block the block to execute and benchmark
+  def benchmark(caption, out_stream = $stdout, &block)
+    return_value = nil
+    bm = Benchmark.measure { return_value = block.call }
+    out_stream << bm.to_s.chomp << ": #{caption}\n"
+    return_value
+  end
+
 end
 end

data/lib/trick_bag/version.rb

@@ -1,3 +1,3 @@
 module TrickBag
-  VERSION = "0.40.0"
+  VERSION = "0.41.0"
 end

data/spec/trick_bag/timing/timing_spec.rb

@@ -6,11 +6,27 @@ module TrickBag
 
   describe Timing do
 
-    it 'returns when the predicate returns true' do
-      count = 0
-      predicate = ->{ count += 1; count == 3 }
-      Timing.retry_until_true_or_timeout(predicate, 0, 1, StringIO.new)
-      expect(count).to eq(3)
+    context '.retry_until_true_or_timeout' do
+      it 'returns when the predicate returns true' do
+        count = 0
+        predicate = ->{ count += 1; count == 3 }
+        Timing.retry_until_true_or_timeout(predicate, 0, 1, StringIO.new)
+        expect(count).to eq(3)
+      end
+    end
+
+
+    context '.benchmark' do
+      it "returns the passed expression's return value" do
+        expect(Timing.benchmark('', '') { 123 }).to eq(123)
+      end
+
+      it 'includes the label in the output string' do
+        label = 'foo'
+        output_string = ''
+        Timing.benchmark(label, output_string) {}
+        expect(output_string).to include(label)
+      end
     end
   end
 

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: trick_bag
 version: !ruby/object:Gem::Version
-  version: 0.40.0
-  prerelease: 
+  version: 0.41.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2014-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -168,27 +155,26 @@ files:
 homepage: https://github.com/keithrbennett/trick_bag
 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.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Miscellaneous general useful tools.
 test_files:
 - spec/spec_helper.rb