clockblock 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in clockblock.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jack A Ross
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+clockblock
+==========
+
+Wrap your code in a Clock Block to measure execution duration.

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/clockblock'
+  t.test_files = FileList['spec/lib/clockblock/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/clockblock.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/clockblock/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jack A Ross"]
+  gem.email         = ["jack.ross@technekes.com"]
+  gem.description   = %q{Enables easy and DRY code timing capabilities.}
+  gem.summary       = %q{Wrap your code in a Clock Block to measure execution duration.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "clockblock"
+  gem.require_paths = ["lib"]
+  gem.version       = Clockblock::VERSION
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "turn"
+end

data/lib/clockblock.rb

@@ -0,0 +1,6 @@
+require "clockblock/version"
+require "clockblock/timer"
+
+module Clockblock
+  # Your code goes here...
+end

data/lib/clockblock/timer.rb

@@ -0,0 +1,62 @@
+module Clockblock
+  class Timer
+    attr_reader :started_at, :finished_at, :stage
+ 
+    def initialize(opts = {})
+      @stage = :initialized
+    end
+
+    def clock(name = "Anonymous Timer")
+      begin
+        start
+        @stage = :executing
+        result = yield
+        stop
+      rescue => ex
+        @stage = :error
+        raise TimerException.new("Error while executing '#{name}': '#{ex.message}'!")
+      end
+      result
+    end
+
+    def start
+      @finished_at = nil
+      @stage = :started
+      @started_at = Time.now
+    end
+
+    def stop
+      @stage = :finished
+      @finished_at = Time.now
+    end
+
+    def finish
+      stop
+    end
+
+    def duration
+      begin
+        @finished_at - @started_at
+      rescue
+        nil
+      end
+    end
+    
+    def attributes
+      { :started_at => started_at, :finished_at => finished_at, :duration => duration, :stage => stage }
+    end
+
+    def inspect
+      attributes
+    end
+
+    def to_s
+      attributes
+    end
+
+    class TimerException < Exception
+    end
+
+  end
+  
+end

data/lib/clockblock/version.rb

@@ -0,0 +1,3 @@
+module Clockblock
+  VERSION = "0.0.1"
+end

data/spec/lib/clockblock/timer_spec.rb

@@ -0,0 +1,128 @@
+require_relative '../../spec_helper'
+
+describe Clockblock::Timer do
+
+  subject { Clockblock::Timer.new }
+
+  describe "timer characteristics" do
+
+    it "must be able to start" do
+      subject.must_respond_to(:start)
+    end
+
+    it "must be able to stop" do
+      subject.must_respond_to(:stop)
+    end
+
+    it "must have a started_at accessor" do
+      subject.must_respond_to(:started_at)
+    end
+
+    it "must have a finished_at accessor" do
+      subject.must_respond_to(:finished_at)
+    end
+
+    it "must have a duration accessor" do
+      subject.must_respond_to(:duration)
+    end
+
+    it "must be able to clock" do
+      subject.must_respond_to(:clock)
+    end
+
+    it "must have an attributes accessor" do
+      subject.must_respond_to(:attributes)
+    end
+
+    it "must have a stage accessor" do
+      subject.must_respond_to(:stage)
+    end
+
+  end
+
+  describe "starting the timer" do
+    before do
+      @start_return_value = subject.start
+    end
+
+    let(:start_return_value) { @start_return_value }
+    
+    it "must return Time" do
+      start_return_value.must_be_kind_of Time
+    end
+
+    it "must return the start time through the started_at accessor" do
+      start_return_value.must_equal subject.started_at
+    end
+
+    it "must reset finished at and duration when it starts" do
+      subject.finished_at.must_be_nil
+      subject.duration.must_be_nil
+    end
+
+    it "must have a stage of :started" do
+      subject.stage.must_equal :started
+    end
+
+  end
+
+  describe "stopping the timer" do
+    before do
+      subject.start
+      sleep 0.1
+      @stop_return_value  = subject.stop
+    end
+
+    let(:started_at)        { subject.started_at }
+    let(:stop_return_value) { @stop_return_value }
+    let(:finished_at)       { subject.finished_at }
+
+    it "must return an instance of Time" do
+      stop_return_value.must_be_kind_of Time
+    end
+
+    it "must return the finish time through the finished_at accessor" do
+      stop_return_value.must_equal finished_at
+    end
+
+    it "must have a stage of :finished" do
+      subject.stage.must_equal :finished
+    end
+
+    specify "duration must be equal to the difference between start and finish" do
+      subject.duration.must_equal finished_at - started_at
+    end
+
+  end
+
+  describe "timer attributes" do
+    let(:attributes)  { subject.attributes }
+
+    it "must be a hash" do
+      attributes.must_be_instance_of(Hash)
+    end
+
+    it "must have :started_at, :finished_at and :duration keys" do
+      attributes.must_include(:started_at)
+      attributes.must_include(:finished_at)
+      attributes.must_include(:duration)
+      attributes.must_include(:stage)
+    end
+
+  end
+
+  describe "clocking a code block" do
+
+    it "must return the result of the block" do
+      expected = Random.rand(1)
+      subject.clock{ expected }.must_equal expected
+    end
+
+    specify "stage must equal :error if the code block raises an error" do
+      lambda{ subject.clock { raise } }.must_raise Clockblock::Timer::TimerException
+      subject.stage.must_equal :error
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+
+begin; require 'turn/autorun'; rescue LoadError; end
+
+require File.expand_path('../../lib/clockblock.rb', __FILE__)
+
+Turn.config.format = :pretty

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: clockblock
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jack A Ross
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70101676678120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70101676678120
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70101676677580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70101676677580
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: &70101676676840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70101676676840
+description: Enables easy and DRY code timing capabilities.
+email:
+- jack.ross@technekes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- clockblock.gemspec
+- lib/clockblock.rb
+- lib/clockblock/timer.rb
+- lib/clockblock/version.rb
+- spec/lib/clockblock/timer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+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.15
+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/spec_helper.rb