timeit 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6b30891cb1314f13e404d3af8d2f7ba4917417dd
+  data.tar.gz: ccb3885fb4d59994045fe698845ca632895303c0
+SHA512:
+  metadata.gz: 2dfd6f807264406db2b06d7ea8225bdd8f0fb2d0efae3f82dfb82a0af02db2b75d6c47061375ab466000f12c4003604fc12854b6be7b3386711e4b24b928a94f
+  data.tar.gz: 9bb1f6fabf0c008a652dcf3f9eb216efa88fdc1bad3b2408fe434c77bd3d225765de30d00e8481c58901ef53e6c8c7246e7c6042607d48337b07089f1f01b1c6

data/README.md

@@ -1,8 +1,52 @@
-timeit
-======
+# timeit
 
-Simple ruby timer
+Simple ruby timer.
 
+## Usage
+
+* Calculate the total duration
+```ruby
+timer = Timeit.ti do
+  sleep 1
+end
+puts "Completed in #{timer.total_duration}"
+```
+
+
+* Log the rate and count 'iterations'
+```ruby
+timer = Timeit.ti do |ti|
+  1.upto(100) do |i|
+    if i % 10 == 0
+      ti.tick!(10)
+      puts "#{ti.count} of 1000 in #{ti.duration} #{ti.rate} items/s" 
+    end
+    sleep(0.1)
+  end
+end
+puts "Completed in #{timer.total_duration} "
+```
+
+* Splits
+```ruby
+timer = Timeit.ti do |ti|
+
+  total_iterations = 100
+  1.upto(total_iterations) do |i|
+    if i % 10 == 0
+      ti.tick!(10)
+      puts "#{i} of #{total_iterations} in #{ti.duration} #{ti.rate} item/s" 
+    end
+
+    if i % 20 == 0
+      puts "Split for the last 20 items was #{ti.split}, split rate #{ti.split_rate} items/s"
+    end
+
+    sleep(0.1)
+  end
+end
+puts "Completed in #{timer.total_duration} "
+```
 
 ## Installation
 
@@ -18,9 +62,6 @@ Or install it yourself as:
 
     $ gem install timeit
 
-## Usage
-
-TODO: Write usage instructions here
 
 ## Contributing
 

data/examples/duration.rb

@@ -1,14 +1,13 @@
 $:.unshift File.expand_path("../../lib", __FILE__)
 require 'timeit'
 
-Timeit.ti do |timer|
+timer = Timeit.ti do |ti|
   1.upto(100) do |i|
     if i % 10 == 0
-      timer.tick!(10)
-      puts "#{timer.count} of 1000 in #{timer.duration} #{timer.rate} items/s" 
+      ti.tick!(10)
+      puts "#{ti.count} of 1000 in #{ti.duration} #{ti.rate} items/s" 
     end
     sleep(0.1)
-    # timer.split! if i % 300 == 0
   end
-  puts "Completed in #{timer.total_duration} "
 end
+puts "Completed in #{timer.total_duration} "

data/examples/splits.rb

@@ -1,8 +1,7 @@
 $:.unshift File.expand_path("../../lib", __FILE__)
 require 'timeit'
 
-Timeit.ti do |ti|
-
+timer = Timeit.ti do |ti|
   total_iterations = 100
   1.upto(total_iterations) do |i|
     if i % 10 == 0
@@ -16,7 +15,7 @@ Timeit.ti do |ti|
 
     sleep(0.1)
   end
-  puts "Completed in #{ti.total_duration} "
 end
+puts "Completed in #{timer.total_duration} "
 
 

data/examples/total_duration.rb

@@ -0,0 +1,8 @@
+$:.unshift File.expand_path("../../lib", __FILE__)
+require 'timeit'
+
+timer = Timeit.ti do
+  sleep 1
+end
+puts "Completed in #{timer.total_duration} "
+

data/lib/timeit.rb

@@ -5,18 +5,28 @@ module Timeit
 
   class Timer
 
+    IllegalStateError = Class.new(RuntimeError)
+
     attr_reader :start_time, :count
 
-    def initialize(start = Time.now)
-      @start_time = start
+    def initialize
+      @start_time = nil
       @count = 0
       @rate = 0
 
-      @split_time = start
+      @split_time = nil
       @split_count = 0
       @split_rate = 0
     end
 
+    def start
+      @start_time = @split_time = Time.now
+    end
+
+    def stop
+      @stop_time = Time.now
+    end
+
     def duration
       duration = Time.now - @start_time
       @rate = @count / duration
@@ -24,7 +34,11 @@ module Timeit
     end
 
     def total_duration
-      Time.now - @start_time
+      if @stop_time
+        @stop_time - @start_time
+      else
+        raise(IllegalStateError, "Timer must be stopped for total duration")
+      end
     end
 
     def split
@@ -56,10 +70,12 @@ module Timeit
 
   end
 
-
-  def ti(&block)
+  def ti(autostart = true, &block)
     t = Timer.new
+    t.start if autostart
     yield t
+    t.stop
+    t
   end
 
 end

data/lib/timeit/version.rb

@@ -1,3 +1,3 @@
 module Timeit
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: timeit
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - rainkinz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-01 00:00:00.000000000 Z
+date: 2013-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,21 +27,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "    Very basic ruby timer for keeping track of the duration, splits
-  and rate of\n    a block of code.\n"
+description: |2
+      Very basic ruby timer for keeping track of the duration, splits and rate of
+      a block of code.
 email:
 - brendan.grainger@gmail.com
 executables: []
@@ -58,32 +54,32 @@ files:
 - Rakefile
 - examples/duration.rb
 - examples/splits.rb
+- examples/total_duration.rb
 - lib/timeit.rb
 - lib/timeit/version.rb
 - timeit.gemspec
 homepage: https://github.com/rainkinz/timeit
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Track duration of a block of code
 test_files: []