Class: Benchmark::Job

Inherits:
Object
  • Object
show all
Defined in:
lib/benchmark.rb

Overview

A Job is a sequence of labelled blocks to be processed by the Benchmark.bmbm method. It is of little direct interest to the user.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(width) ⇒ Job

Returns an initialized Job instance. Usually, one doesn’t call this method directly, as new Job objects are created by the #bmbm method. width is a initial value for the label offset used in formatting; the #bmbm method passes its width argument to this constructor.



331
332
333
334
# File 'lib/benchmark.rb', line 331

def initialize(width)
  @width = width
  @list = []
end

Instance Attribute Details

#listObject (readonly)

An array of 2-element arrays, consisting of label and block pairs.



351
352
353
# File 'lib/benchmark.rb', line 351

def list
  @list
end

#widthObject (readonly)

Length of the widest label in the #list.



354
355
356
# File 'lib/benchmark.rb', line 354

def width
  @width
end

Instance Method Details

#item(label = "", &blk) ⇒ Object Also known as: report

Registers the given label and block pair in the job list.

Raises:

  • (ArgumentError)


339
340
341
342
343
344
345
346
# File 'lib/benchmark.rb', line 339

def item(label = "", &blk) # :yield:
  raise ArgumentError, "no block" unless block_given?
  label = label.to_s
  w = label.length
  @width = w if @width < w
  @list << [label, blk]
  self
end