public
Description: Provides a simple API for instrumenting Ruby method invocations
Homepage: http://fiveruns.com
Clone URL: git://github.com/fiveruns/instrument.git
commit  b67e2b2badbd53663293d211a1596c4fb8d03caf
tree    45ff7e9e954c49736bf1112d96c2c19ff99d4a3f
parent  aed7909106423947751a08f21dce909e041b75d1
name age message
file CHANGELOG Thu May 15 21:21:09 -0700 2008 Rename to 'instrument' to match method name [bruce]
file Manifest Thu May 15 21:28:10 -0700 2008 Change gem details [bruce]
file README.rdoc Thu May 15 21:21:09 -0700 2008 Rename to 'instrument' to match method name [bruce]
file Rakefile Loading commit data...
directory lib/ Fri May 16 15:44:16 -0700 2008 Remove Instrument.clear since we don't support ... [bruce]
directory test/ Fri May 16 15:44:16 -0700 2008 Remove Instrument.clear since we don't support ... [bruce]
README.rdoc

Instrument Library

Description

Provides a simple API for instrumenting Ruby method invocations

Features/Problems

Simply wraps methods, times invocations, and yields to the given handler.

SYNOPSIS:

  class Foo
    def go
      sleep(rand(10) / 10)
    end
  end

  invocations = []
  instrument 'Foo#go' do |obj, time, *args|
    invocations << time
  end

  foo = Foo.new
  5.times { foo.go }
  invocations.size # => 5
  invocations.max # => the max time spent invoking Foo#go

REQUIREMENTS:

  • activesupport

INSTALL:

  • sudo gem install instrument

LICENSE:

(The FiveRuns License)

Copyright © 2008 FiveRuns Corporation

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.