allotment 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45adf43db853faac34a57e8be2b94914c4708e35
-  data.tar.gz: cfdc29f2a8949df3ba3630e314e735f7b1b1d3d7
+  metadata.gz: ebc11149d0e75eab78814f7c06832ba1ebf09550
+  data.tar.gz: ccd06e0b331f68b762c1d3d8363e314f1d7122fd
 SHA512:
-  metadata.gz: cc352f7d58035999eaa90c1b591d6f33e139d25ff1d99e93df51b19da7f498a706bbe8171a47c117507eebbf20900a08fa34f1e1999731d0c1185cdc986893bf
-  data.tar.gz: 9c3e98e45a41f40fed4e52a906e1994e2d251303c76ec96f889d498aeab5c9a94f4e5a368f539b5c94d8bc9e7689a8cb45e43b20d4581e6ffa88291f7915c9b7
+  metadata.gz: 288acb76f032599689b50bd687a683ec77ad6f931ab61f106b8cc5e0d953ac102ca6c1579691111913cdec5d752d9cceda8601ac514f0d4a58b6c8461bd9f187
+  data.tar.gz: d41a2fe690bf038a3f20ff6a74679b555056e2d453bdbba44fd8d76a7919ff24962c213c846f694680c857c04f23e682062760db40021cdef3a822e58c9cdb63

data/lib/allotment/stopwatch.rb

@@ -1,11 +1,10 @@
-require 'allotment/stopwatch'
-
 module Allotment
 	class Stopwatch
-		attr_reader :name, :status, :start_time
+		attr_reader :name, :status
 
-		def initialize name = self.class.uniqe_name
-			@name       = name
+		def initialize name = nil
+			@stopwatch  = self.class.uniqe_name
+			@name       = name || @stopwatch
 			@status     = 'running'
 			@start_time = Time.now
 		end
@@ -19,13 +18,19 @@ module Allotment
 			@status       = 'stopped'
 			@current_time = Time.now - @start_time
 		end
-		
+
 		def reset
 			@start_time 	= Time.now
-			@current_time = 0
+			@current_time = nil
 		end
 
 		def lap
+			@new_lap = Time.now - (@lap_time || @start_time)
+			@lap_time = Time.now
+			return @new_lap
+		end
+
+		def split
 			Time.now - @start_time
 		end
 

data/lib/allotment.rb

@@ -35,4 +35,24 @@ 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,5 +1,9 @@
 require 'helper'
 
+class DummyClass
+  include Allotment
+end
+
 describe Allotment do
   it "is a module" do
     Allotment.class.should eq Module
@@ -7,16 +11,48 @@ describe Allotment do
 
   describe ".record_event" do
     it "records the time for the block" do
-      Allotment.record_event('my_recording0') { sleep 0.01 }
+      Allotment.record_event('my_recording 0.1') { sleep 0.01 }
+    end
+
+    it "records the time for the proc" do
+      Allotment.record_event 'my_recording 0.2' do
+        sleep 0.01
+      end
+    end
+
+    it "returns a float" do
+      result = Allotment.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 = 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 = Allotment.record_event('my_recording0') { sleep 0.01 }
+      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 = Allotment.record_event('my_recording0') { sleep 0.01 }
+      result = @dummy_class.record_event('my_recording 0.4') { sleep 0.01 }
       result.round(2).should eq 0.01
     end
   end
@@ -43,6 +79,32 @@ 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'
@@ -63,6 +125,30 @@ describe Allotment do
     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
     it "returns a hash" do
       Allotment.record_event('my_recording4') { sleep 0.01 }
@@ -87,6 +173,34 @@ 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 Hash
+    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 }
@@ -99,4 +213,21 @@ describe Allotment do
       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')
+    end
+  end
 end

data/spec/stopwatch/stopwatch_spec.rb

@@ -99,6 +99,28 @@ describe Allotment::Stopwatch do
     end
   end
 
+  describe "#split" do
+    it "returns a float" do
+      sw = Allotment::Stopwatch.new
+      sw.split.class.should eq Float
+    end
+
+    it "returns the correct time" do
+      sw = Allotment::Stopwatch.new
+      sleep 0.01
+      sw.split.round(2).should eq 0.01
+      sleep 0.01
+      sw.split.round(2).should eq 0.02
+      sw.stop.round(2).should eq 0.02
+    end
+
+    it "keeps its stopwatch name" do
+      sw = Allotment::Stopwatch.new('stopwatch')
+      sw.split
+      sw.name.should eq 'stopwatch'
+    end
+  end
+
   describe "#lap" do
     it "returns a float" do
       sw = Allotment::Stopwatch.new
@@ -110,7 +132,8 @@ describe Allotment::Stopwatch do
       sleep 0.01
       sw.lap.round(2).should eq 0.01
       sleep 0.01
-      sw.lap.round(2).should eq 0.02
+      sw.lap.round(2).should eq 0.01
+      sw.stop.round(2).should eq 0.02
     end
 
     it "keeps its stopwatch name" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allotment
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Ben Slaughter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-05 00:00:00.000000000 Z
+date: 2013-08-28 00:00:00.000000000 Z
 dependencies: []
 description: A gem for recording performance and timings of blocks or from point to
   point
@@ -25,7 +25,7 @@ files:
 - spec/helper.rb
 - spec/stopwatch/array_spec.rb
 - spec/stopwatch/stopwatch_spec.rb
-homepage: https://github.com/benSlaughter/allotment
+homepage: http://benslaughter.github.io/allotment/
 licenses:
 - MIT
 metadata: {}