Class: ZTK::Benchmark

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

Overview

Benchmark Class

This class contains a benchmarking tool which doubles to supply indications of activity to the console user during long running tasks.

It can be run strictly for benchmarking (the default) or if supplied with the appropriate options it will display output to the user while benchmarking the supplied block.

Examples:

Benchmark a simple sleep statement


message = "I wonder how long this will take?"
mark = " ...looks like it took %0.4f seconds!"
ZTK::Benchmark.bench(:message => message, :mark => mark) do
  sleep(1.5)
end

Author:

Class Method Summary (collapse)

Class Method Details

+ (Float) bench(options = {}) { ... }

Benchmark the supplied block.

If message and mark options are used, then the message text will be displayed to the user. The the supplied block is yielded inside a ZTK::Spinner.spin call. This will provide the spinning cursor while the block executes. It is advisable to not have output sent to the console during this period.

Once the block finishes executing, the mark text is displayed with the benchmark supplied to it as a sprintf option. One could use "%0.4f" in a String for example to get the benchmark time embedded in it

Parameters:

  • options (Hash) (defaults to: {}) —

    Configuration options hash.

Options Hash (options):

  • :message (String) —

    The String to be displayed to the user before the block is yielded.

  • :mark (String) —

    The String to be displayed to the user after the block is yielded. This String should have an sprintf floating point macro in it if the benchmark is desired to be embedded in the given String.

  • :use_spinner (Boolean) — default: true —

    Whether or not to use the ZTK::Spinner while benchmarking.

Yields:

  • Block should execute the tasks to be benchmarked.

Yield Returns:

  • (Object) —

    The return value of the block is ignored.

Returns:

  • (Float) —

    The benchmark time.

See Also:

  • Kernel#sprintf


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/ztk/benchmark.rb', line 60

def bench(options={}, &block)
  options = Base.build_config({
    :use_spinner => true
  }, options)

  !block_given? and Base.log_and_raise(options.ui.logger, BenchmarkError, "You must supply a block!")

  if (!options.message.nil? && !options.message.empty?)
    options.ui.stdout.print(options.message)
    options.ui.logger.info { options.message.strip }
  end

  benchmark = ::Benchmark.realtime do
    if options.
      ZTK::Spinner.spin(options) do
        yield
      end
    else
      yield
    end
  end

  if (!options.mark.nil? && !options.mark.empty?)
    options.ui.stdout.print(options.mark % benchmark)
    options.ui.logger.info { options.mark.strip % benchmark }
  end

  benchmark
end