allotment 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebc11149d0e75eab78814f7c06832ba1ebf09550
-  data.tar.gz: ccd06e0b331f68b762c1d3d8363e314f1d7122fd
+  metadata.gz: e6417cf65f6cb61d3ea29b4270ad1c98e66d4945
+  data.tar.gz: 9948aa7f2e371bc100081451ce46607db0c09d69
 SHA512:
-  metadata.gz: 288acb76f032599689b50bd687a683ec77ad6f931ab61f106b8cc5e0d953ac102ca6c1579691111913cdec5d752d9cceda8601ac514f0d4a58b6c8461bd9f187
-  data.tar.gz: d41a2fe690bf038a3f20ff6a74679b555056e2d453bdbba44fd8d76a7919ff24962c213c846f694680c857c04f23e682062760db40021cdef3a822e58c9cdb63
+  metadata.gz: 2b285e0947b4a97ef2578cfd9706e17f2f480b65b3436d0e8c8593c921b4b34cedfc42f9b014ad6c451c1bc2d0b0ec69cb5156327686133c02ab075c5c07a6f6
+  data.tar.gz: 53f7a0b502ac4d7ee3b5371893c2785c2fdd85e58b10f124338942d657d0f1675d3cfe92e0290f5074b615330f4ec351618a2be7f6a51488fae331832f1c3677

data/README.md

@@ -0,0 +1,141 @@
+# Allotment
+
+[![Code Climate](https://codeclimate.com/github/benSlaughter/allotment.png)](https://codeclimate.com/github/benSlaughter/allotment)
+[![Build Status](https://travis-ci.org/benSlaughter/allotment.png?branch=master)](https://travis-ci.org/benSlaughter/allotment)
+[![Dependency Status](https://gemnasium.com/benSlaughter/allotment.png)](https://gemnasium.com/benSlaughter/allotment)
+[![Coverage Status](https://coveralls.io/repos/benSlaughter/allotment/badge.png?branch=master)](https://coveralls.io/r/benSlaughter/allotment)
+[![Gem Version](https://badge.fury.io/rb/allotment.png)](http://badge.fury.io/rb/allotment)
+
+Allotment is a performance rubygem that records and stores the performance timing of running a block of code,
+or from a from a chosen point, until a task or action is complete.
+
+Each performance recording is stored with a recording name,
+each following recording is added so that multiple recordings can be queried and assesed.
+
+Allotment also stores all the results so that they can be easily accessed at any time.
+
+## Setup
+
+Allotment has been tested with Ruby 1.9.2 and later.
+To install, type:
+
+```bash
+gem install allotment
+```
+
+## Using Allotment with Cucumber
+
+If you are using Cucumber you can record each scenario, and report the results to the console, add this line into your env.rb file:
+
+```ruby
+require 'allotment/cucumber'
+```
+
+## Using Allotment
+
+Allotments main features are: the ability to record performance of ruby blocks; and record from point to point.
+
+Require Allotment at the start of your code:
+
+```ruby
+require 'allotment'
+```
+
+### Recording a Block
+
+The basic way of recording a block is as follows:
+
+```ruby
+Allotment.record_event('my_recording') { # code here }
+```
+```ruby
+Allotment.record_event('my_recording') do
+  # code here
+end
+```
+
+When an event has been completed the performance timing is returned by the method:
+
+```ruby
+performance = Allotment.record_event { # code here }
+```
+```ruby
+performance = Allotment.record_event do
+  # code here
+end
+```
+
+### Record point to point:
+
+The basic way of recording point to point is as follows:
+
+```ruby
+require 'allotment'
+
+Allotment.start_recording 'my_recording'
+# code here
+Allotment.stop_recording 'my_recording'
+```
+
+When stop recording is called the performance timing is returned by the method:
+
+```ruby
+performance = Allotment.stop_recording 'my_recording'
+```
+
+When start recording is called the timing stopwatch is returned by the method:
+
+```ruby
+stopwatch = Allotment.start_recording 'my_recording'
+```
+
+_More on [stopwatches](#allotment-stopwatches)_
+
+If a recording name does not exists, then a NameError shall be raised.
+
+### Accessing performance results
+
+Performance recordings are stored within a hash. The reperformance results are logged to an array under the recording name.
+They can be access from Allotment at any time:
+
+```ruby
+hash = Allotment.results
+```
+```ruby
+array = Allotment.results["my_recording"]
+```
+```ruby
+result = Allotment.results["my_recording"].first
+```
+```ruby
+result = Allotment.results["my_recording"].average
+```
+
+### Allotment Stopwatches
+
+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

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'allotment/version'
+
+Gem::Specification.new do |spec|
+  spec.name         = 'allotment'
+  spec.summary      = 'Allotment: Performance recording'
+  spec.description  = 'Simple performance recordings of blocks, procs or point to point'
+  spec.homepage     = 'http://benslaughter.github.io/allotment/'
+  spec.version      = Allotment::VERSION
+  spec.date         = Allotment::DATE
+  spec.license      = 'MIT'
+
+  spec.author       = 'Ben Slaughter'
+  spec.email        = 'b.p.slaughter@gmail.com'
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'coveralls'
+  spec.add_runtime_dependency 'hashie'
+
+  spec.files        = ['README.md', 'allotment.gemspec']
+  spec.files        += Dir.glob("lib/**/*.rb")
+  spec.files        += Dir.glob("spec/**/*")
+  spec.test_files   = Dir.glob("spec/**/*")
+  spec.require_path = 'lib'
+
+end

data/lib/allotment.rb

@@ -1,6 +1,7 @@
 require 'allotment/array'
 require 'allotment/stopwatch'
 require 'json'
+require 'hashie'
 
 module Allotment
 	class << self
@@ -11,7 +12,7 @@ module Allotment
 		end
 
 		def start_recording name = 'unnamed'
-			@watches ||= Hash.new
+			@watches ||= Hashie::Mash.new
 			@watches[name] = Stopwatch.new name
 		end
 
@@ -20,9 +21,9 @@ module Allotment
 			result = watch.stop
 
 			# Dealing with the results
-			@results ||= Hash.new
+			@results ||= Hashie::Mash.new
 			@results[name] ||= Array.new
-			@results[name].push result
+			@results[name] << result
 
 			return result
 		end

data/lib/allotment/version.rb

@@ -0,0 +1,4 @@
+module Allotment
+  VERSION = "1.0.3".freeze
+  DATE = "2013-08-29".freeze
+end

data/spec/allotment_spec.rb

@@ -152,7 +152,7 @@ describe Allotment do
   describe ".results" do
     it "returns a hash" do
       Allotment.record_event('my_recording4') { sleep 0.01 }
-      Allotment.results.class.should eq Hash
+      Allotment.results.class.should eq Hashie::Mash
     end
 
     it "returns a hash with the event in" do
@@ -180,7 +180,7 @@ describe Allotment do
 
     it "returns a hash" do
       @dummy_class.record_event('my_recording4') { sleep 0.01 }
-      @dummy_class.results.class.should eq Hash
+      @dummy_class.results.class.should eq Hashie::Mash
     end
 
     it "returns a hash with the event in" do

metadata

@@ -1,25 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: allotment
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Ben Slaughter
 autorequire: 
 bindir: bin
 cert_chain: []
-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
+date: 2013-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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
+    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: hashie
+  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: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- allotment.gemspec
 - lib/allotment/array.rb
 - lib/allotment/cucumber.rb
 - lib/allotment/stopwatch.rb
+- lib/allotment/version.rb
 - lib/allotment.rb
 - spec/allotment_spec.rb
 - spec/helper.rb
@@ -48,7 +92,7 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Performance recording
+summary: 'Allotment: Performance recording'
 test_files:
 - spec/allotment_spec.rb
 - spec/helper.rb