MiniTest::Spec

Public Class Methods

bench(name, &block) click to toggle source

This is used to define a new benchmark method. You usually don’t use this directly and is intended for those needing to write new performance curve fits (eg: you need a specific polynomial fit).

See ::bench_performance_linear for an example of how to use this.

 
               # File minitest/benchmark.rb, line 358
def self.bench name, &block
  define_method "bench_#{name.gsub(/\W+/, '_')}", &block
end

bench_performance_constant(name, threshold = 0.99, &work) click to toggle source

Create a benchmark that verifies that the performance is constant.

describe "my class" do
  bench_performance_constant "zoom_algorithm!" do |n|
    @obj.zoom_algorithm!(n)
  end
end

 
               # File minitest/benchmark.rb, line 402
def self.bench_performance_constant name, threshold = 0.99, &work
  bench name do
    assert_performance_constant threshold, &work
  end
end

bench_performance_exponential(name, threshold = 0.99, &work) click to toggle source

Create a benchmark that verifies that the performance is exponential.

describe "my class" do
  bench_performance_exponential "algorithm" do |n|
    @obj.algorithm(n)
  end
end

 
               # File minitest/benchmark.rb, line 417
def self.bench_performance_exponential name, threshold = 0.99, &work
  bench name do
    assert_performance_exponential threshold, &work
  end
end

bench_performance_linear(name, threshold = 0.99, &work) click to toggle source

Create a benchmark that verifies that the performance is linear.

describe "my class" do
  bench_performance_linear "fast_algorithm", 0.9999 do |n|
    @obj.fast_algorithm(n)
  end
end

 
               # File minitest/benchmark.rb, line 387
def self.bench_performance_linear name, threshold = 0.99, &work
  bench name do
    assert_performance_linear threshold, &work
  end
end

bench_range(&block) click to toggle source

Specifies the ranges used for benchmarking for that class.

bench_range do
  bench_exp(2, 16, 2)
end

See Unit::TestCase.bench_range for more details.

 
               # File minitest/benchmark.rb, line 371
def self.bench_range &block
  return super unless block

  meta = (class << self; self; end)
  meta.send :define_method, "bench_range", &block
end

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please see Improve the docs, or visit Documenting-ruby.org.

Home Classes Methods

In Files

Parent

Methods

Class/Module Index

MiniTest::Spec

Public Class Methods