Class: MiniTest::Spec

Inherits:
Unit::TestCase show all
Defined in:
lib/minitest/spec.rb,
lib/minitest/benchmark.rb

Overview

MiniTest::Spec – The faster, better, less-magical spec framework!

For a list of expectations, see Object.

Constant Summary collapse

TYPES =

Contains pairs of matchers and Spec classes to be used to calculate the superclass of a top-level describe. This allows for automatically customizable spec types.

See: register_spec_type and spec_type

[[//, MiniTest::Spec]]
@@describe_stack = 
[]

Constants inherited from Unit::TestCase

Unit::TestCase::PASSTHROUGH_EXCEPTIONS, Unit::TestCase::SUPPORTS_INFO_SIGNAL

Constants included from Assertions

Assertions::WINDOZE

Class Attribute Summary collapse

Attributes inherited from Unit::TestCase

#__name__

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Unit::TestCase

add_setup_hook, add_teardown_hook, #assert_performance, #assert_performance_constant, #assert_performance_exponential, #assert_performance_linear, #assert_performance_power, bench_exp, bench_linear, benchmark_methods, benchmark_suites, #fit_error, #fit_exponential, #fit_linear, #fit_power, inherited, #io, #io?, #passed?, reset, reset_setup_teardown_hooks, #run, #run_setup_hooks, #run_teardown_hooks, #setup, setup_hooks, #sigma, #teardown, teardown_hooks, test_methods, test_order, test_suites, #validation_for_fit

Methods included from Assertions

#_assertions, #_assertions=, #assert, #assert_block, #assert_empty, #assert_equal, #assert_in_delta, #assert_in_epsilon, #assert_includes, #assert_instance_of, #assert_kind_of, #assert_match, #assert_nil, #assert_operator, #assert_output, #assert_raises, #assert_respond_to, #assert_same, #assert_send, #assert_silent, #assert_throws, #capture_io, #diff, diff, diff=, #exception_details, #flunk, #message, #mu_pp, #mu_pp_for_diff, #pass, #refute, #refute_empty, #refute_equal, #refute_in_delta, #refute_in_epsilon, #refute_includes, #refute_instance_of, #refute_kind_of, #refute_match, #refute_nil, #refute_operator, #refute_respond_to, #refute_same, #skip

Constructor Details

#initialize(name) ⇒ Spec

:nodoc:



143
144
145
146
 
# File 'lib/minitest/spec.rb', line 143

def initialize name # :nodoc:
  super
  @@current_spec = self
end

Class Attribute Details

.desc ⇒ Object (readonly)

Returns the value of attribute desc.



223
224
225
 
# File 'lib/minitest/spec.rb', line 223

def desc
  @desc
end

.name ⇒ Object (readonly)

Returns the value of attribute name.



223
224
225
 
# File 'lib/minitest/spec.rb', line 223

def name
  @name
end

Class Method Details

.after(type = :each, &block) ⇒ Object

Define an ‘after’ action. Inherits the way normal methods should.

NOTE: type is ignored and is only there to make porting easier.

Equivalent to MiniTest::Unit::TestCase#teardown.



174
175
176
177
178
 
# File 'lib/minitest/spec.rb', line 174

def self.after type = :each, &block
  raise "unsupported after type: #{type}" unless type == :each

  add_teardown_hook {|tc| tc.instance_eval(&block) }
end

.before(type = :each, &block) ⇒ Object

Define a ‘before’ action. Inherits the way normal methods should.

NOTE: type is ignored and is only there to make porting easier.

Equivalent to MiniTest::Unit::TestCase#setup.



161
162
163
164
165
 
# File 'lib/minitest/spec.rb', line 161

def self.before type = :each, &block
  raise "unsupported before type: #{type}" unless type == :each

  add_setup_hook {|tc| tc.instance_eval(&block) }
end

.bench(name, &block) ⇒ Object

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.



311
312
313
 
# File 'lib/minitest/benchmark.rb', line 311

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

.bench_performance_constant(name, threshold = 0.99, &work) ⇒ Object

Create a benchmark that verifies that the performance is constant.

describe "my class" do
  bench_performance_constant "zoom_algorithm!" do
    @obj.zoom_algorithm!
  end
end



346
347
348
349
350
 
# File 'lib/minitest/benchmark.rb', line 346

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) ⇒ Object

Create a benchmark that verifies that the performance is exponential.

describe "my class" do
  bench_performance_exponential "algorithm" do
    @obj.algorithm
  end
end



361
362
363
364
365
 
# File 'lib/minitest/benchmark.rb', line 361

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) ⇒ Object

Create a benchmark that verifies that the performance is linear.

describe "my class" do
  bench_performance_linear "fast_algorithm", 0.9999 do
    @obj.fast_algorithm
  end
end



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

def self.bench_performance_linear name, threshold = 0.99, &work
  bench name do
    assert_performance_linear threshold, &work
  end
end

.bench_range(&block) ⇒ Object 



315
316
317
318
319
320
 
# File 'lib/minitest/benchmark.rb', line 315

def self.bench_range &block
  return super unless block

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

.children ⇒ Object 



139
140
141
 
# File 'lib/minitest/spec.rb', line 139

def self.children
  @children ||= []
end

.create(name, desc) ⇒ Object

:nodoc:



204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/minitest/spec.rb', line 204

def self.create(name, desc) # :nodoc:
  cls = Class.new(self) do
    @name = name
    @desc = desc

    nuke_test_methods!
  end

  children << cls

  cls
end

.current ⇒ Object

:nodoc:



135
136
137
 
# File 'lib/minitest/spec.rb', line 135

def self.current # :nodoc:
  @@current_spec
end

.describe_stack ⇒ Object

:nodoc:



131
132
133
 
# File 'lib/minitest/spec.rb', line 131

def self.describe_stack # :nodoc:
  @@describe_stack
end

.it(desc, &block) ⇒ Object

Define an expectation with name desc. Name gets morphed to a proper test method name. For some freakish reason, people who write specs don’t like class inheritence, so this goes way out of its way to make sure that expectations aren’t inherited.

Hint: If you do want inheritence, use minitest/unit. You can mix and match between assertions and expectations as much as you want.



189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/minitest/spec.rb', line 189

def self.it desc, &block
  block ||= proc { skip "(no tests defined)" }

  @specs ||= 0
  @specs += 1

  name = "test_%04d_%s" % [ @specs, desc.gsub(/\W+/, '_').downcase ]

  define_method name, &block

  self.children.each do |mod|
    mod.send :undef_method, name if mod.public_method_defined? name
  end
end

.nuke_test_methods! ⇒ Object

:nodoc:



148
149
150
151
152
 
# File 'lib/minitest/spec.rb', line 148

def self.nuke_test_methods! # :nodoc:
  self.public_instance_methods.grep(/^test_/).each do |name|
    self.send :undef_method, name
  end
end

.register_spec_type(matcher, klass) ⇒ Object

Register a new type of spec that matches the spec’s description. Eg:

register_spec_plugin(/Controller$/, MiniTest::Spec::Rails)



116
117
118
 
# File 'lib/minitest/spec.rb', line 116

def self.register_spec_type matcher, klass
  TYPES.unshift [matcher, klass]
end

.spec_type(desc) ⇒ Object

Figure out the spec class to use based on a spec’s description. Eg:

spec_type("BlahController") # => MiniTest::Spec::Rails



125
126
127
128
 
# File 'lib/minitest/spec.rb', line 125

def self.spec_type desc
  desc = desc.to_s
  TYPES.find { |re, klass| re === desc }.last
end

.to_s ⇒ Object

:nodoc:



217
218
219
 
# File 'lib/minitest/spec.rb', line 217

def self.to_s # :nodoc:
  defined?(@name) ? @name : super
end