allotment 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6417cf65f6cb61d3ea29b4270ad1c98e66d4945
-  data.tar.gz: 9948aa7f2e371bc100081451ce46607db0c09d69
+  metadata.gz: 260e997e18de045d11302464320c034d157543ea
+  data.tar.gz: d07b300e2acb0bdb7d9441117db692d5e3567cc3
 SHA512:
-  metadata.gz: 2b285e0947b4a97ef2578cfd9706e17f2f480b65b3436d0e8c8593c921b4b34cedfc42f9b014ad6c451c1bc2d0b0ec69cb5156327686133c02ab075c5c07a6f6
-  data.tar.gz: 53f7a0b502ac4d7ee3b5371893c2785c2fdd85e58b10f124338942d657d0f1675d3cfe92e0290f5074b615330f4ec351618a2be7f6a51488fae331832f1c3677
+  metadata.gz: 8cbe37969369a29dcc2b000c42842c043c7d97996aba626b03861f96150d1a58f704ec475d125f66f6165348a6cd5e6e4adbf7809c2e87b92d266b623b60130d
+  data.tar.gz: bbb47b9c27e82b8b1696f9b20766751daf8ba545e6b6714b9283a40e1ff7bebc3f193531ca4554461b5bfe94eb5e5af0ba62eba1f91599a67a1d4fbbf2e14541

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (C) 2013 Ben Slaughter
+
+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

@@ -115,27 +115,3 @@ result = Allotment.results["my_recording"].average
 
 TODO
 
-## Release Notes
-### Version 1.0.0
-###### Major: Inital release version.
- * Allotment has the ablility to record blocks and procs, and to record from two separate points within the code.
- * Stopwatch has been completed and can start, stop, split, lap and restart.
- * There is an extention of Array for an average.
- * There is Cucumber support, a cucumber file has been included that will record scenario and test time.
-
-### Version 1.0.1
-###### Patch: Added instance methods
- * Added instance methods so that the module can be included into a class and allotment does not need to be called every time.
- * Cleaned up stopwatch so that it had lap and split
-
-## Version 1.0.2
-###### Patch: Results returned as Hashie::Mash
- * results methods now return results as a Hashie::Mash
-
-## Planned Releases
-### Version 1.1.0
-###### Minor: Improvements to recording events and stopwatch management
- * Rescue within an event to ensure that the timing is stopped in the event of a failure
- * Complete the readme with updated information on using stopwatches
- * A complete record of all spawned stopwatches
-

data/allotment.gemspec

@@ -15,10 +15,12 @@ Gem::Specification.new do |spec|
   spec.email        = 'b.p.slaughter@gmail.com'
 
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'coveralls'
   spec.add_runtime_dependency 'hashie'
+  spec.add_runtime_dependency 'hooks'
 
-  spec.files        = ['README.md', 'allotment.gemspec']
+  spec.files        = ['README.md', 'LICENSE.md', 'allotment.gemspec']
   spec.files        += Dir.glob("lib/**/*.rb")
   spec.files        += Dir.glob("spec/**/*")
   spec.test_files   = Dir.glob("spec/**/*")

data/lib/allotment/methods.rb

@@ -0,0 +1,23 @@
+class Allotment
+  module Methods
+    def record_event name = 'unnamed', &block
+      Allotment.record_event name, &block
+    end
+
+    def start_recording name = 'unnamed'
+      Allotment.start_recording name
+    end
+
+    def stop_recording name
+      Allotment.stop_recording name
+    end
+
+    def results
+      Allotment.results
+    end
+
+    def results_string
+      Allotment.results_string
+    end
+  end
+end

data/lib/allotment/stopwatch.rb

@@ -1,4 +1,4 @@
-module Allotment
+class Allotment
 	class Stopwatch
 		attr_reader :name, :status
 

data/lib/allotment/version.rb

@@ -1,4 +1,4 @@
-module Allotment
-  VERSION = "1.0.3".freeze
-  DATE = "2013-08-29".freeze
+class Allotment
+  VERSION = "1.0.4".freeze
+  DATE = "2013-09-02".freeze
 end

data/lib/allotment.rb

@@ -1,17 +1,27 @@
 require 'allotment/array'
 require 'allotment/stopwatch'
+
 require 'json'
 require 'hashie'
+require 'hooks'
+
+class Allotment
+  include Hooks
+  define_hooks :before, :after
 
-module Allotment
 	class << self
 		def record_event name = 'unnamed', &block
 			start_recording name
-			yield
-			stop_recording name
+			begin
+				yield
+			ensure
+				time = stop_recording name
+			end
+			return time
 		end
 
 		def start_recording name = 'unnamed'
+      run_hook :before
 			@watches ||= Hashie::Mash.new
 			@watches[name] = Stopwatch.new name
 		end
@@ -19,12 +29,12 @@ module Allotment
 		def stop_recording name
 			watch = @watches.delete(name) { |n| raise NameError, "No recording:" + n }
 			result = watch.stop
+      run_hook :after
 
 			# Dealing with the results
 			@results ||= Hashie::Mash.new
 			@results[name] ||= Array.new
 			@results[name] << result
-
 			return result
 		end
 
@@ -36,24 +46,4 @@ module Allotment
 			JSON.pretty_generate @results
 		end
 	end
-
-	def record_event name = 'unnamed', &block
-    Allotment.record_event name, &block
-  end
-
-  def start_recording name = 'unnamed'
-    Allotment.start_recording name
-  end
-
-  def stop_recording name
-    Allotment.stop_recording name
-  end
-
-  def results
-    Allotment.results
-  end
-
-  def results_string
-    Allotment.results_string
-  end
 end

data/spec/allotment_spec.rb

@@ -1,12 +1,8 @@
 require 'helper'
 
-class DummyClass
-  include Allotment
-end
-
 describe Allotment do
-  it "is a module" do
-    Allotment.class.should eq Module
+  it "is a class" do
+    Allotment.class.should eq Class
   end
 
   describe ".record_event" do
@@ -29,31 +25,10 @@ describe Allotment do
       result = Allotment.record_event('my_recording 0.4') { sleep 0.01 }
       result.round(2).should eq 0.01
     end
-  end
-
-  describe "#record_event" do
-    before(:each) do
-      @dummy_class = DummyClass.new
-    end
-
-    it "records the time for the block" do
-      @dummy_class.record_event('my_recording 0.1') { sleep 0.01 }
-    end
-
-    it "records the time for the proc" do
-      @dummy_class.record_event 'my_recording 0.2' do
-        sleep 0.01
-      end
-    end
 
-    it "returns a float" do
-      result = @dummy_class.record_event('my_recording 0.3') { sleep 0.01 }
-      result.class.should eq Float
-    end
-
-    it "returns the execute time of the block" do
-      result = @dummy_class.record_event('my_recording 0.4') { sleep 0.01 }
-      result.round(2).should eq 0.01
+    it "returns still records the performance upon error" do
+      expect { Allotment.record_event('failed_recording') { sleep 0.01; raise 'error' } }.to raise_error RuntimeError, "error"
+      Allotment.results['failed_recording'].first.round(2).should eq 0.01
     end
   end
 
@@ -79,32 +54,6 @@ describe Allotment do
     end
   end
 
-  describe "#start_recording" do
-    before(:each) do
-      @dummy_class = DummyClass.new
-    end
-
-    it "returns a stopwatch instance" do
-      result = @dummy_class.start_recording
-      result.class.should eq Allotment::Stopwatch
-    end
-
-    it "returns an unnamed stopwatch if no name given" do
-      result = @dummy_class.start_recording
-      result.name.should eq 'unnamed'
-    end
-
-    it "returns a stopwatch with the given name" do
-      result = @dummy_class.start_recording 'my_recording'
-      result.name.should eq 'my_recording'
-    end
-
-    it "returns a stopwatch that is 'running'" do
-      result = @dummy_class.start_recording
-      result.status.should eq 'running'
-    end
-  end
-
   describe ".stop_recording" do
     it "returns a float" do
       Allotment.start_recording 'my_recording1'
@@ -125,27 +74,29 @@ describe Allotment do
     end
   end
 
-  describe "#stop_recording" do
-    before(:each) do
-      @dummy_class = DummyClass.new
+  describe ".before" do
+    it "adds a hook to the before hooks array" do
+      hooks = Allotment.before { nil }
+      Allotment._hooks[:before].should eq hooks
     end
 
-    it "returns a float" do
-      @dummy_class.start_recording 'my_recording1'
-      sleep 0.01
-      result = @dummy_class.stop_recording 'my_recording1'
-      result.class.should eq Float
+    it "runs the hook before the performance recording" do
+      Allotment.before { @before = Time.now.to_f }
+      Allotment.record_event('before') { @record = Time.now.to_f }
+      @record.should be > Allotment.instance_variable_get("@before")
     end
+  end
 
-    it "returns the execute time of the code" do
-      @dummy_class.start_recording 'my_recording2'
-      sleep 0.01
-      result = @dummy_class.stop_recording 'my_recording2'
-      result.round(2).should eq 0.01
+  describe ".after" do
+    it "adds a hook to the after hooks array" do
+      hooks = Allotment.after { nil }
+      Allotment._hooks[:after].should eq hooks
     end
 
-    it "raises an error if the recording does not exist" do
-      expect { @dummy_class.stop_recording 'my_recording3' }.to raise_error NameError, "No recording:my_recording3"
+    it "runs the hook after the performance recording" do
+      Allotment.after { @after = Time.now.to_f }
+      Allotment.record_event('after') { @record = Time.now.to_f }
+      @record.should be < Allotment.instance_variable_get("@after")
     end
   end
 
@@ -173,34 +124,6 @@ describe Allotment do
     end
   end
 
-  describe "#results" do
-    before(:each) do
-      @dummy_class = DummyClass.new
-    end
-
-    it "returns a hash" do
-      @dummy_class.record_event('my_recording4') { sleep 0.01 }
-      @dummy_class.results.class.should eq Hashie::Mash
-    end
-
-    it "returns a hash with the event in" do
-      @dummy_class.record_event('my_recording5') { sleep 0.01 }
-      @dummy_class.results.should include('my_recording5')
-    end
-
-    it "stores the result under the event" do
-      @dummy_class.record_event('my_recording6') { sleep 0.01 }
-      @dummy_class.results['my_recording6'][0].round(2).should eq 0.01
-    end
-
-    it "stores each result of each event" do
-      @dummy_class.record_event('my_recording7') { sleep 0.01 }
-      @dummy_class.record_event('my_recording7') { sleep 0.02 }
-      @dummy_class.results['my_recording7'][0].round(2).should eq 0.01
-      @dummy_class.results['my_recording7'][1].round(2).should eq 0.02
-    end
-  end
-
   describe ".results_string" do
     it "returns a string" do
       Allotment.record_event('my_recording8') { sleep 0.01 }
@@ -209,25 +132,8 @@ describe Allotment do
 
     it "returns a string with the event in" do
       Allotment.record_event('my_recording9') { sleep 0.03 }
-      Allotment.results_string.should include('my_recording9')
-      Allotment.results_string.should include('0.03')
-    end
-  end
-
-  describe "#results_string" do
-    before(:each) do
-      @dummy_class = DummyClass.new
-    end
-
-    it "returns a string" do
-      @dummy_class.record_event('my_recording8') { sleep 0.01 }
-      @dummy_class.results_string.class.should eq String
-    end
-
-    it "returns a string with the event in" do
-      @dummy_class.record_event('my_recording9') { sleep 0.03 }
-      @dummy_class.results_string.should include('my_recording9')
-      @dummy_class.results_string.should include('0.03')
+      Allotment.results_string.should include 'my_recording9'
+      Allotment.results_string.should include '0.03'
     end
   end
 end

data/spec/helper.rb

@@ -1,7 +1,10 @@
 require 'coveralls'
-Coveralls.wear!
+require 'pry'
 
 require 'allotment'
+require 'allotment/methods'
+
+Coveralls.wear!
 
 RSpec.configure do |config|
   config.color_enabled  = true

data/spec/stopwatch/methods_spec.rb

@@ -0,0 +1,130 @@
+class DummyClass
+  include Allotment::Methods
+end
+
+describe Allotment::Methods do
+  it "is a module" do
+    Allotment::Methods.class.should eq Module
+  end
+
+  describe "#record_event" do
+    before(:each) do
+      @dummy_class = DummyClass.new
+    end
+
+    it "records the time for the block" do
+      @dummy_class.record_event('my_recording 0.1') { sleep 0.01 }
+    end
+
+    it "records the time for the proc" do
+      @dummy_class.record_event 'my_recording 0.2' do
+        sleep 0.01
+      end
+    end
+
+    it "returns a float" do
+      result = @dummy_class.record_event('my_recording 0.3') { sleep 0.01 }
+      result.class.should eq Float
+    end
+
+    it "returns the execute time of the block" do
+      result = @dummy_class.record_event('my_recording 0.4') { sleep 0.01 }
+      result.round(2).should eq 0.01
+    end
+  end
+
+  describe "#start_recording" do
+    before(:each) do
+      @dummy_class = DummyClass.new
+    end
+
+    it "returns a stopwatch instance" do
+      result = @dummy_class.start_recording
+      result.class.should eq Allotment::Stopwatch
+    end
+
+    it "returns an unnamed stopwatch if no name given" do
+      result = @dummy_class.start_recording
+      result.name.should eq 'unnamed'
+    end
+
+    it "returns a stopwatch with the given name" do
+      result = @dummy_class.start_recording 'my_recording'
+      result.name.should eq 'my_recording'
+    end
+
+    it "returns a stopwatch that is 'running'" do
+      result = @dummy_class.start_recording
+      result.status.should eq 'running'
+    end
+  end
+
+  describe "#stop_recording" do
+    before(:each) do
+      @dummy_class = DummyClass.new
+    end
+
+    it "returns a float" do
+      @dummy_class.start_recording 'my_recording1'
+      sleep 0.01
+      result = @dummy_class.stop_recording 'my_recording1'
+      result.class.should eq Float
+    end
+
+    it "returns the execute time of the code" do
+      @dummy_class.start_recording 'my_recording2'
+      sleep 0.01
+      result = @dummy_class.stop_recording 'my_recording2'
+      result.round(2).should eq 0.01
+    end
+
+    it "raises an error if the recording does not exist" do
+      expect { @dummy_class.stop_recording 'my_recording3' }.to raise_error NameError, "No recording:my_recording3"
+    end
+  end
+
+  describe "#results" do
+    before(:each) do
+      @dummy_class = DummyClass.new
+    end
+
+    it "returns a hash" do
+      @dummy_class.record_event('my_recording4') { sleep 0.01 }
+      @dummy_class.results.class.should eq Hashie::Mash
+    end
+
+    it "returns a hash with the event in" do
+      @dummy_class.record_event('my_recording5') { sleep 0.01 }
+      @dummy_class.results.should include('my_recording5')
+    end
+
+    it "stores the result under the event" do
+      @dummy_class.record_event('my_recording6') { sleep 0.01 }
+      @dummy_class.results['my_recording6'][0].round(2).should eq 0.01
+    end
+
+    it "stores each result of each event" do
+      @dummy_class.record_event('my_recording7') { sleep 0.01 }
+      @dummy_class.record_event('my_recording7') { sleep 0.02 }
+      @dummy_class.results['my_recording7'][0].round(2).should eq 0.01
+      @dummy_class.results['my_recording7'][1].round(2).should eq 0.02
+    end
+  end
+
+  describe "#results_string" do
+    before(:each) do
+      @dummy_class = DummyClass.new
+    end
+
+    it "returns a string" do
+      @dummy_class.record_event('my_recording8') { sleep 0.01 }
+      @dummy_class.results_string.class.should eq String
+    end
+
+    it "returns a string with the event in" do
+      @dummy_class.record_event('my_recording9') { sleep 0.03 }
+      @dummy_class.results_string.should include('my_recording9')
+      @dummy_class.results_string.should include('0.03')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allotment
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Ben Slaughter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-29 00:00:00.000000000 Z
+date: 2013-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple performance recordings of blocks, procs or point to point
 email: b.p.slaughter@gmail.com
 executables: []
@@ -59,15 +87,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- LICENSE.md
 - allotment.gemspec
 - lib/allotment/array.rb
 - lib/allotment/cucumber.rb
+- lib/allotment/methods.rb
 - lib/allotment/stopwatch.rb
 - lib/allotment/version.rb
 - lib/allotment.rb
 - spec/allotment_spec.rb
 - spec/helper.rb
 - spec/stopwatch/array_spec.rb
+- spec/stopwatch/methods_spec.rb
 - spec/stopwatch/stopwatch_spec.rb
 homepage: http://benslaughter.github.io/allotment/
 licenses:
@@ -97,5 +128,5 @@ test_files:
 - spec/allotment_spec.rb
 - spec/helper.rb
 - spec/stopwatch/array_spec.rb
+- spec/stopwatch/methods_spec.rb
 - spec/stopwatch/stopwatch_spec.rb
-has_rdoc: