Class: Jinx::Stopwatch

Inherits:

Object

• Object
• Jinx::Stopwatch

Defined in:

lib/jinx/helpers/stopwatch.rb

Overview

Stopwatch is a simple execution time accumulator.

Defined Under Namespace

Classes: Time

Class Method Summary

• .measure(&block) ⇒ Numeric

  Executes the given block.

Instance Method Summary

• #cpu ⇒ Numeric

  The cumulative CPU total time spent in #run executions for the current process and its children.

• #elapsed ⇒ Numeric

  The cumulative elapsed real clock time spent in #run executions.

• #initialize ⇒ Stopwatch constructor

  Creates a new idle Stopwatch.

• #reset ⇒ Object

  Resets this Stopwatch's cumulative time to zero.

• #run(&block) ⇒ Object

  Executes the given block.

Constructor Details

#initialize ⇒ Stopwatch

Creates a new idle Stopwatch.

# File 'lib/jinx/helpers/stopwatch.rb', line 49

def initialize
  @time = Time.new
end

Class Method Details

.measure(&block) ⇒ Numeric

Executes the given block

# File 'lib/jinx/helpers/stopwatch.rb', line 44

def self.measure(&block)
  new.run(&block)
end

Instance Method Details

#cpu ⇒ Numeric

# File 'lib/jinx/helpers/stopwatch.rb', line 67

def cpu
  @time.cpu
end

#elapsed ⇒ Numeric

# File 'lib/jinx/helpers/stopwatch.rb', line 61

def elapsed
  @time.elapsed
end

#reset ⇒ Object

Resets this Stopwatch's cumulative time to zero.

# File 'lib/jinx/helpers/stopwatch.rb', line 72

def reset
  @time.reset
end

#run(&block) ⇒ Object

Executes the given block. Accumulates the execution time in this Stopwatch.

@return [Numeric] the execution run Time

# File 'lib/jinx/helpers/stopwatch.rb', line 56

def run(&block)
  @time.split(&block)
end