allotment 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1725b9fb8ace6c575075d430991795aee92207d
-  data.tar.gz: b1e799ec1f2f1072399e51ba0784ced21533218f
+  metadata.gz: 45adf43db853faac34a57e8be2b94914c4708e35
+  data.tar.gz: cfdc29f2a8949df3ba3630e314e735f7b1b1d3d7
 SHA512:
-  metadata.gz: c3672fb2aad8b5955d92639dcc8365c53c6324028629dd40ffe6b486527d5c7d0b5486dd49fd616343f1f79d2d700452f118286e4693055a487715e2e3935b50
-  data.tar.gz: 7c66df8f6fc284a61c50ce889f437127e3dbaea13842bad80f89cfaa500a29b564ab6d52dc3ccd485ed6de45019d130d761f845bb4b27ea2700319975f6ff8a6
+  metadata.gz: cc352f7d58035999eaa90c1b591d6f33e139d25ff1d99e93df51b19da7f498a706bbe8171a47c117507eebbf20900a08fa34f1e1999731d0c1185cdc986893bf
+  data.tar.gz: 9c3e98e45a41f40fed4e52a906e1994e2d251303c76ec96f889d498aeab5c9a94f4e5a368f539b5c94d8bc9e7689a8cb45e43b20d4581e6ffa88291f7915c9b7

data/lib/allotment.rb

@@ -1,30 +1,38 @@
+require 'allotment/array'
+require 'allotment/stopwatch'
+require 'json'
+
 module Allotment
 	class << self
-		def record_event name = Time.now.to_s, &block
-			start_time = Time.now
+		def record_event name = 'unnamed', &block
+			start_recording name
 			yield
-			Time.now - start_time
+			stop_recording name
 		end
 
-		def start_recording name = Time.now.to_s
+		def start_recording name = 'unnamed'
 			@watches ||= Hash.new
 			@watches[name] = Stopwatch.new name
-			@watches[name]
 		end
 
 		def stop_recording name
-			watch = @watches.delete(name) {|e| "%s does not exist!" % e }
-			Time.now - watch.start_time
+			watch = @watches.delete(name) { |n| raise NameError, "No recording:" + n }
+			result = watch.stop
+
+			# Dealing with the results
+			@results ||= Hash.new
+			@results[name] ||= Array.new
+			@results[name].push result
+
+			return result
 		end
-	end
 
-	class Stopwatch
-		attr_reader :name, :status, :start_time
+		def results
+			@results
+		end
 
-		def initialize name
-			@name       = name
-			@status     = 'running'
-			@start_time = Time.now
+		def results_string
+			JSON.pretty_generate @results
 		end
 	end
 end

data/lib/allotment/array.rb

@@ -0,0 +1,5 @@
+class Array
+  def average
+    inject(:+).to_f / size
+  end
+end

data/lib/allotment/cucumber.rb

@@ -0,0 +1,13 @@
+require 'allotment'
+
+Before do |scenario|
+	Allotment.start_recording scenario.title
+end
+
+After do |scenario|
+	Allotment.stop_recording scenario.title
+end
+
+at_exit do
+	puts Allotment.results_string
+end

data/lib/allotment/stopwatch.rb

@@ -0,0 +1,37 @@
+require 'allotment/stopwatch'
+
+module Allotment
+	class Stopwatch
+		attr_reader :name, :status, :start_time
+
+		def initialize name = self.class.uniqe_name
+			@name       = name
+			@status     = 'running'
+			@start_time = Time.now
+		end
+
+		def start
+			@start_time = Time.now - (@current_time || 0)
+			@status     = 'running'
+		end
+
+		def stop
+			@status       = 'stopped'
+			@current_time = Time.now - @start_time
+		end
+		
+		def reset
+			@start_time 	= Time.now
+			@current_time = 0
+		end
+
+		def lap
+			Time.now - @start_time
+		end
+
+		private
+		def self.uniqe_name
+			"stopwatch_" + (@id ? @id += 1 : @id = 0).to_s
+		end
+	end
+end

data/spec/allotment_spec.rb

@@ -1,52 +1,102 @@
-require 'coveralls'
-Coveralls.wear!
+require 'helper'
 
-require './lib/allotment'
-
-describe Allotment, "#record_event" do
-  it "records the time for the block" do
-    Allotment.record_event('name') { nil }
+describe Allotment do
+  it "is a module" do
+    Allotment.class.should eq Module
   end
 
-  it "returns a float" do
-    result = Allotment.record_event('name') { nil }
-    result.class.should eq Float
-  end
+  describe ".record_event" do
+    it "records the time for the block" do
+      Allotment.record_event('my_recording0') { sleep 0.01 }
+    end
 
-  it "returns the execute time of the block" do
-    result = Allotment.record_event('name') { sleep 0.1 }
-    result.round(1).should eq 0.1
-  end
-end
+    it "returns a float" do
+      result = Allotment.record_event('my_recording0') { sleep 0.01 }
+      result.class.should eq Float
+    end
 
-describe Allotment, "#start_recording" do
-  it "returns a stopwatch instance" do
-    result = Allotment.start_recording
-    result.class.should eq Allotment::Stopwatch
+    it "returns the execute time of the block" do
+      result = Allotment.record_event('my_recording0') { sleep 0.01 }
+      result.round(2).should eq 0.01
+    end
   end
 
-  it "returns a stopwatch with the given name" do
-    result = Allotment.start_recording
-    result.class.should eq Allotment::Stopwatch
+  describe ".start_recording" do
+    it "returns a stopwatch instance" do
+      result = Allotment.start_recording
+      result.class.should eq Allotment::Stopwatch
+    end
+
+    it "returns an unnamed stopwatch if no name given" do
+      result = Allotment.start_recording
+      result.name.should eq 'unnamed'
+    end
+
+    it "returns a stopwatch with the given name" do
+      result = Allotment.start_recording 'my_recording'
+      result.name.should eq 'my_recording'
+    end
+
+    it "returns a stopwatch that is 'running'" do
+      result = Allotment.start_recording
+      result.status.should eq 'running'
+    end
   end
 
-  it "returns a stopwatch that is 'running'" do
-    result = Allotment.start_recording 'my_recording'
-    result.name.should eq 'my_recording'
+  describe ".stop_recording" do
+    it "returns a float" do
+      Allotment.start_recording 'my_recording1'
+      sleep 0.01
+      result = Allotment.stop_recording 'my_recording1'
+      result.class.should eq Float
+    end
+
+    it "returns the execute time of the code" do
+      Allotment.start_recording 'my_recording2'
+      sleep 0.01
+      result = Allotment.stop_recording 'my_recording2'
+      result.round(2).should eq 0.01
+    end
+
+    it "raises an error if the recording does not exist" do
+      expect { Allotment.stop_recording 'my_recording3' }.to raise_error NameError, "No recording:my_recording3"
+    end
   end
-end
 
-describe Allotment, "#stop_recording" do
-  it "returns a float" do
-    Allotment.start_recording 'my_recording1' 
-    result = Allotment.stop_recording 'my_recording1'
-    result.class.should eq Float
+  describe ".results" do
+    it "returns a hash" do
+      Allotment.record_event('my_recording4') { sleep 0.01 }
+      Allotment.results.class.should eq Hash
+    end
+
+    it "returns a hash with the event in" do
+      Allotment.record_event('my_recording5') { sleep 0.01 }
+      Allotment.results.should include('my_recording5')
+    end
+
+    it "stores the result under the event" do
+      Allotment.record_event('my_recording6') { sleep 0.01 }
+      Allotment.results['my_recording6'][0].round(2).should eq 0.01
+    end
+
+    it "stores each result of each event" do
+      Allotment.record_event('my_recording7') { sleep 0.01 }
+      Allotment.record_event('my_recording7') { sleep 0.02 }
+      Allotment.results['my_recording7'][0].round(2).should eq 0.01
+      Allotment.results['my_recording7'][1].round(2).should eq 0.02
+    end
   end
 
-  it "returns the execute time of the code" do
-    Allotment.start_recording 'my_recording2'
-    sleep 0.1
-    result = Allotment.stop_recording 'my_recording2'
-    result.round(1).should eq 0.1
+  describe ".results_string" do
+    it "returns a string" do
+      Allotment.record_event('my_recording8') { sleep 0.01 }
+      Allotment.results_string.class.should eq String
+    end
+
+    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
 end

data/spec/helper.rb

@@ -0,0 +1,9 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'allotment'
+
+RSpec.configure do |config|
+  config.color_enabled  = true
+  config.formatter      = :documentation
+end

data/spec/stopwatch/array_spec.rb

@@ -0,0 +1,15 @@
+describe Array do
+  describe "#average" do
+    it "returns a float" do
+      [1,2,3,4,5].average.class.should eq Float
+    end
+
+    it "returns the mean of the array" do
+      [1,2,3,4,5,6,7,7].average.should eq 4.375
+    end
+
+    it "raises an error if one of the values is not a fixnum" do
+      expect { [1,2,3,4,5,'invalid'].average }.to raise_error TypeError, "String can't be coerced into Fixnum"
+    end
+  end
+end

data/spec/stopwatch/stopwatch_spec.rb

@@ -0,0 +1,122 @@
+describe Allotment::Stopwatch do
+  it "is a class" do
+    Allotment::Stopwatch.class.should eq Class
+  end
+
+  describe ".new" do
+    it "returns a class of Stopwatch" do
+      Allotment::Stopwatch.new.class.should eq Allotment::Stopwatch
+    end
+
+    it "sets the stopwatch status to running" do
+      Allotment::Stopwatch.new.status.should eq 'running'
+    end
+
+    it "gives the stopwatch a name if none given" do
+      Allotment::Stopwatch.new.name.should =~ /stopwatch_\d+/
+    end
+
+    it "sets the name of the stopwatch" do
+      Allotment::Stopwatch.new('stopwatch').name.should eq 'stopwatch'
+    end
+  end
+
+  describe "#stop" do
+    it "returns a float" do
+      sw = Allotment::Stopwatch.new
+      sw.stop.class.should eq Float
+    end
+
+    it "returns the correct time" do
+      sw = Allotment::Stopwatch.new
+      sleep 0.01
+      sw.stop.round(2).should eq 0.01
+    end
+
+    it "sets the stopwatch status to stopped" do
+      sw = Allotment::Stopwatch.new
+      sw.stop
+      sw.status.should eq 'stopped'
+    end
+
+    it "keeps its stopwatch name" do
+      sw = Allotment::Stopwatch.new('stopwatch')
+      sw.stop
+      sw.name.should eq 'stopwatch'
+    end
+  end
+
+  describe "#start" do
+    it "sets the stopwatch status to running" do
+      sw = Allotment::Stopwatch.new
+      sw.stop
+      sw.start
+      sw.status.should eq 'running'
+    end
+
+    it "keeps track of total time" do
+      sw = Allotment::Stopwatch.new
+      sleep 0.01
+      sw.stop
+      sw.start
+      sleep 0.01
+      sw.stop.round(2).should eq 0.02
+    end
+
+    it "keeps its stopwatch name" do
+      sw = Allotment::Stopwatch.new('stopwatch')
+      sw.stop
+      sw.start
+      sw.name.should eq 'stopwatch'
+    end
+  end
+
+  describe "#reset" do
+    it "resets the stopwatch total time when stopped" do
+      sw = Allotment::Stopwatch.new
+      sleep 0.01
+      sw.stop
+      sw.status.should eq 'stopped'
+      sw.reset
+      sw.start
+      sleep 0.01
+      sw.stop.round(2).should eq 0.01
+    end
+
+    it "resets the stopwatch total time when running" do
+      sw = Allotment::Stopwatch.new
+      sleep 0.01
+      sw.status.should eq 'running'
+      sw.reset
+      sleep 0.01
+      sw.stop.round(2).should eq 0.01
+    end
+
+    it "keeps its stopwatch name" do
+      sw = Allotment::Stopwatch.new('stopwatch')
+      sw.reset
+      sw.name.should eq 'stopwatch'
+    end
+  end
+
+  describe "#lap" do
+    it "returns a float" do
+      sw = Allotment::Stopwatch.new
+      sw.lap.class.should eq Float
+    end
+
+    it "returns the correct time" do
+      sw = Allotment::Stopwatch.new
+      sleep 0.01
+      sw.lap.round(2).should eq 0.01
+      sleep 0.01
+      sw.lap.round(2).should eq 0.02
+    end
+
+    it "keeps its stopwatch name" do
+      sw = Allotment::Stopwatch.new('stopwatch')
+      sw.lap
+      sw.name.should eq 'stopwatch'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allotment
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Ben Slaughter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-18 00:00:00.000000000 Z
+date: 2013-08-05 00:00:00.000000000 Z
 dependencies: []
 description: A gem for recording performance and timings of blocks or from point to
   point
@@ -17,8 +17,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/allotment/array.rb
+- lib/allotment/cucumber.rb
+- lib/allotment/stopwatch.rb
 - lib/allotment.rb
 - spec/allotment_spec.rb
+- spec/helper.rb
+- spec/stopwatch/array_spec.rb
+- spec/stopwatch/stopwatch_spec.rb
 homepage: https://github.com/benSlaughter/allotment
 licenses:
 - MIT
@@ -42,6 +48,10 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Allotment - performance recording
+summary: Performance recording
 test_files:
 - spec/allotment_spec.rb
+- spec/helper.rb
+- spec/stopwatch/array_spec.rb
+- spec/stopwatch/stopwatch_spec.rb
+has_rdoc: