quicky 0.0.3 → 0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    quicky (0.0.2)
+    quicky (0.0.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -0,0 +1,51 @@
+Quicky if for easily timing chunks of code.
+
+## Getting Started
+
+    gem install quicky
+
+## Timing
+
+### Time anything
+
+```ruby
+quicky = Quicky::Timer.new
+quicky.time(:test1) do
+  sleep 2
+end
+# Print average duration for all :test1 timings
+p quicky.results(:test1).duration
+# Print total duration for all :test1 timings
+p quicky.results(:test1).total_duration
+# Print longest duration for all :test1 timings
+p quicky.results(:test1).max_duration
+# Print shortest duration for all :test1 timings
+p quicky.results(:test1).min_duration
+
+### Time in a loop
+
+Good for performance testing.
+
+```ruby
+quicky = Quicky::Timer.new
+# This will loop 10 times
+quicky.loop(:test2, 10) do |i|
+  puts 'sleeping'
+  sleep 1
+end
+```
+
+Or loop for X seconds:
+
+```ruby
+# This will loop for 10 seconds
+quicky.loop_for(:test3, 10) do |i|
+  puts 'sleeping'
+  sleep 0.5
+end
+```
+
+#### Looping Options
+
+- warmup: X -- will throw out the first X results.
+

data/lib/quicky/timer.rb

@@ -52,16 +52,22 @@ module Quicky
   end
 
   class TimeCollector
+    INT_MAX = ( (2 ** (32 - 2)) - 1 )
+
     attr_accessor :name
     def initialize(name)
       @name = name
       @collector = []
       @total_duration = 0.0
+      @max_duration = 0.0
+      @min_duration = INT_MAX
     end
 
     def <<(val)
       # pull out duration for totals
       @total_duration += val.duration
+      @max_duration = val.duration if val.duration > @max_duration
+      @min_duration = val.duration if val.duration < @min_duration
       @collector << val
     end
 
@@ -73,6 +79,14 @@ module Quicky
       @total_duration
     end
 
+    def max_duration
+      @max_duration
+    end
+
+    def min_duration
+      @min_duration
+    end
+
     def count
       @collector.size
     end

data/lib/quicky/version.rb

@@ -1,3 +1,3 @@
 module Quicky
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/test/test_basics.rb

@@ -33,11 +33,15 @@ class TestBasics < TestBase
       puts 'sleeping'
       sleep 0.5
     end
-    p quicky.results(:test3).inspect
-    p quicky.results(:test3).duration
+    result = quicky.results(:test3)
+    p result.inspect
+    p result.duration
     p quicky.results.count
-    assert quicky.results(:test3).duration >= 0.5 && quicky.results(:test3).duration < 1
-    assert quicky.results(:test3).total_duration >= 5
+    assert result.duration >= 0.5 && result.duration < 1
+    assert result.total_duration >= 5
+    assert result.min_duration < 0.55 && result.min_duration > 0.1
+    assert result.max_duration > 0.5 && result.max_duration < 0.7
+
 
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quicky
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-28 00:00:00.000000000 Z
+date: 2012-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit