clockblock 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode
+# uncomment this line if your project needs to run something other than `rake`:
+# script: bundle exec rspec spec

data/README.md

@@ -1,29 +1,35 @@
-ClockBlock
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jackross/clockblock)
+[![Build Status](https://secure.travis-ci.org/jackross/clockblock.png)](http://travis-ci.org/jackross/clockblock)
+
+
+Clockblock
 ==========
 
-Wrap your code in a Clock Block to measure execution duration.
+Extend Clockblock::Timing in your class definition to add timers to your methods:
 
 ````ruby
 require 'clockblock'
 
 class Foo
   extend Clockblock::Timing
+  add_timing_to :bar
 
   def bar
     sleep 2
   end
-  add_timing_to :bar
 
 end
 
 f = Foo.new
 f.bar
 
-f.clockblock_timers
-# => {:bar=>{:started_at=>2012-07-26 16:04:03 -0400, :finished_at=>2012-07-26 16:04:05 -0400, :duration=>2.001059, :stage=>:finished}}
+f.clockblock_timers[:bar]
+# => {:started_at=>2012-07-26 16:04:03 -0400, :finished_at=>2012-07-26 16:04:05 -0400, :duration=>2.001059, :stage=>:finished}
 
 ````
 
+Extend your instances with Clockblock::Timing to add timers to your methods:
+
 ````ruby
 require 'clockblock'
 
@@ -38,56 +44,50 @@ f.extend Clockblock::Timing
 f.add_timing_to :bar
 f.bar
 
-f.clockblock_timers
-# => {:bar=>{:started_at=>2012-07-26 16:04:03 -0400, :finished_at=>2012-07-26 16:04:05 -0400, :duration=>2.001059, :stage=>:finished}}
+f.clockblock_timers[:bar]
+# => {:started_at=>2012-07-26 16:04:03 -0400, :finished_at=>2012-07-26 16:04:05 -0400, :duration=>2.001059, :stage=>:finished}
 
 ````
 
+Extend your classes with Clockblock::Timing to add timers to your methods:
+
 ````ruby
-class Foo1
-  extend Clockblock::Timing
-  add_timing_to :baz
+require 'clockblock'
 
+class Foo
   def bar
-    sleep 1
-  end
-  add_timing_to :bar
-
-  def baz
-    sleep 1
+    sleep 2
   end
 end
 
-class Foo2
-  def bar
-    sleep 1
-  end
-end
+Foo.extend Clockblock::Timing
+Foo.add_timing_to :bar, :baz
+puts Foo.instance_variable_get(:@future_timer_methods)
+class Foo; def baz; sleep 1; end; end
+f = Foo.new
+f.bar
+f.baz
+puts f.clockblock_timers
+# => {:bar=>{:started_at=>2012-07-30 10:43:48 -0400, :finished_at=>2012-07-30 10:43:49 -0400, :duration=>1.0004, :stage=>:finished}, :baz=>{:started_at=>2012-07-30 10:43:49 -0400, :finished_at=>2012-07-30 10:43:50 -0400, :duration=>1.000906, :stage=>:finished}}
+
+````
+
+Wrap your code in a Clockblock clock block to measure execution duration.
+
+````ruby
+require 'clockblock'
+
+class Foo
 
-class Foo3
   def bar
-    sleep 1
+    t = Clockblock::Timer.new
+    result = t.clock do
+      sleep 2 # replace 'sleep 2' with your code!
+    end
+    puts t.attributes
+    result
   end
 end
 
-f1 = Foo1.new
-f1.bar
-puts f1.clockblock_timers
-puts Foo1.instance_variable_get(:@future_timer_methods)
-
-f2 = Foo2.new
-f2.extend Clockblock::Timing
-f2.add_timing_to :bar, :baz
-f2.bar
-puts f2.clockblock_timers
-puts f2.instance_variable_get(:@future_timer_methods)
-
-Foo3.extend Clockblock::Timing
-Foo3.add_timing_to :bar, :baz
-puts Foo3.instance_variable_get(:@future_timer_methods)
-class Foo3; def baz; sleep 1; end; end
-f3 = Foo3.new
-f3.bar
-f3.baz
-puts f3.clockblock_timers
-````
+````
+

data/lib/clockblock/timer.rb

@@ -1,22 +1,23 @@
 module Clockblock
   class Timer
-    attr_reader :started_at, :finished_at, :stage
+    attr_reader :started_at, :finished_at, :stage, :clockblock_result
  
     def initialize(opts = {})
       @stage = :initialized
+      yield self if block_given?
     end
 
     def clock(name = "Anonymous Timer")
       begin
         start
         @stage = :executing
-        result = yield
+        @clockblock_result = yield
         stop
       rescue => ex
         @stage = :error
         raise TimerException.new("Error while executing '#{name}': '#{ex.message}'!")
       end
-      result
+      @clockblock_result
     end
 
     def start
@@ -47,11 +48,11 @@ module Clockblock
     end
 
     def inspect
-      attributes
+      to_s
     end
 
     def to_s
-      attributes
+      attributes.to_s
     end
 
     class TimerException < Exception

data/lib/clockblock/timing.rb

@@ -2,11 +2,14 @@ module Clockblock
   module Timing
 
     module ClassMethods
+      def receiver
+        self.is_a?(Class) ? self : (class << self; self; end)
+      end
+
       def add_timing_to *methods
         methods.each do |method|
-          klass = self.is_a?(Class) ? self : (class << self; self; end)
-          if klass.method_defined? method
-            add_timing_to_method method, klass
+          if receiver.method_defined? method
+            add_timing_to_method method
           else
             @future_timer_methods ||= []
             @future_timer_methods << method
@@ -14,9 +17,19 @@ module Clockblock
         end
       end
 
-      def add_timing_to_method(method, klass)
+      def method_added(method)
+        if @future_timer_methods && @future_timer_methods.include?(method)
+          unless @added_by_clockblock
+            @added_by_clockblock = true
+            add_timing_to_method method
+          end
+          @added_by_clockblock = false
+        end
+      end
+
+      def add_timing_to_method(method)
         stashed_method = "#{method}_stashed_by_clockblock".to_sym
-        klass.class_eval do
+        receiver.class_eval do
           alias_method stashed_method, method
           define_method method do |*args, &block|
             @clockblock_timers ||= {}
@@ -28,17 +41,6 @@ module Clockblock
           end
         end
       end
-
-      def method_added(method)
-        if @future_timer_methods && @future_timer_methods.include?(method)
-          unless @added_by_clockblock
-            @added_by_clockblock = true
-            klass = self.is_a?(Class) ? self : (class << self; self; end)
-            add_timing_to_method method, klass
-          end
-          @added_by_clockblock = false
-        end
-      end
     end
 
     def self.extended(base)

data/lib/clockblock/version.rb

@@ -1,3 +1,3 @@
 module Clockblock
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/lib/clockblock/timer_spec.rb

@@ -1,4 +1,4 @@
-require_relative '../../spec_helper'
+require File.expand_path('../../../spec_helper', __FILE__)
 
 describe Clockblock::Timer do
 

data/spec/lib/clockblock/timing_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+describe "extending Clockblock::Timing in a class definition" do
+  it "wraps an already defined method in a clock block" do
+    
+    foo_klass = Class.new do
+      extend Clockblock::Timing
+
+      def bar
+        sleep 1
+      end
+      add_timing_to :bar
+
+    end
+
+    f = foo_klass.new
+    f.bar.must_equal 1
+    f.clockblock_timers.must_be_kind_of Hash
+    f.clockblock_timers.keys.must_include :bar
+    f.clockblock_timers[:bar].must_be_instance_of Clockblock::Timer
+
+  end
+
+  it "wraps an undefined method in a clock block" do
+    
+    foo_klass = Class.new do
+      extend Clockblock::Timing
+      add_timing_to :bar
+
+      def bar
+        sleep 1
+      end
+
+    end
+
+    f = foo_klass.new
+    f.bar.must_equal 1
+    f.clockblock_timers.must_be_kind_of Hash
+    f.clockblock_timers.keys.must_include :bar
+    f.clockblock_timers[:bar].must_be_instance_of Clockblock::Timer
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clockblock
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-27 00:00:00.000000000 Z
+date: 2012-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70341854789020 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70341854789020
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70341854773700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70341854773700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &70341854772740 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70341854772740
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Enables easy and DRY code timing capabilities.
 email:
 - jack.ross@technekes.com
@@ -52,6 +67,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -62,6 +78,7 @@ files:
 - lib/clockblock/timing.rb
 - lib/clockblock/version.rb
 - spec/lib/clockblock/timer_spec.rb
+- spec/lib/clockblock/timing_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
@@ -83,10 +100,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Wrap your code in a Clock Block to measure execution duration.
 test_files:
 - spec/lib/clockblock/timer_spec.rb
+- spec/lib/clockblock/timing_spec.rb
 - spec/spec_helper.rb