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 MiniTest::Expectations.

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::UNDEFINED

Class Attribute Summary collapse

Attributes inherited from Unit::TestCase

#__name__

Class Method Summary collapse

Methods inherited from Unit::TestCase

#assert_performance, #assert_performance_constant, #assert_performance_exponential, #assert_performance_linear, #assert_performance_power, bench_exp, bench_linear, benchmark_methods, benchmark_suites, current, #fit_error, #fit_exponential, #fit_linear, #fit_power, i_suck_and_my_tests_are_order_dependent!, inherited, #initialize, #io, #io?, make_my_diffs_pretty!, parallelize_me!, #passed?, reset, reset_setup_teardown_hooks, #run, #setup, #sigma, #teardown, test_methods, test_order, test_suites, #validation_for_fit

Methods included from Unit::Guard

#jruby?, #mri?, #rubinius?, #windows?

Methods included from Unit::Deprecated::HooksCM

#add_setup_hook, #add_teardown_hook, #setup_hooks, #teardown_hooks

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_predicate, #assert_raises, #assert_respond_to, #assert_same, #assert_send, #assert_silent, #assert_throws, #capture_io, #capture_subprocess_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_predicate, #refute_respond_to, #refute_same, #skip, #synchronize

Methods included from Unit::Deprecated::Hooks

#_run_hooks, #run_setup_hooks, #run_teardown_hooks

Methods included from Unit::LifecycleHooks

#after_setup, #after_teardown, #before_setup, #before_teardown

Constructor Details

This class inherits a constructor from MiniTest::Unit::TestCase

Class Attribute Details

.descObject (readonly)

Returns the value of attribute desc


253
254
255
# File 'lib/minitest/spec.rb', line 253

def desc
  @desc
end

Class Method Details

.after(type = nil, &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.


179
180
181
182
183
184
# File 'lib/minitest/spec.rb', line 179

def self.after type = nil, &block
  define_method :teardown do
    self.instance_eval(&block)
    super()
  end
end

.before(type = nil, &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.


165
166
167
168
169
170
# File 'lib/minitest/spec.rb', line 165

def self.before type = nil, &block
  define_method :setup do
    super()
    self.instance_eval(&block)
  end
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.


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

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 |n|
    @obj.zoom_algorithm!(n)
  end
end

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

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 |n|
    @obj.algorithm(n)
  end
end

375
376
377
378
379
# File 'lib/minitest/benchmark.rb', line 375

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 |n|
    @obj.fast_algorithm(n)
  end
end

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

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

.bench_range(&block) ⇒ Object

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.


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

def self.bench_range &block
  return super unless block

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

.childrenObject

Returns the children of this spec.


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

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

.create(name, desc) ⇒ Object

:nodoc:


234
235
236
237
238
239
240
241
242
243
244
245
# File 'lib/minitest/spec.rb', line 234

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

    nuke_test_methods!
  end

  children << cls

  cls
end

.describe_stackObject

:nodoc:


141
142
143
# File 'lib/minitest/spec.rb', line 141

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

.it(desc = "anonymous", &block) ⇒ Object Also known as: specify

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.

This is also aliased to #specify and doesn't require a desc arg.

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


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
# File 'lib/minitest/spec.rb', line 197

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

  @specs ||= 0
  @specs += 1

  name = "test_%04d_%s" % [ @specs, desc ]

  define_method name, &block

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

  name
end

.let(name, &block) ⇒ Object

Essentially, define an accessor for name with block.

Why use let instead of def? I honestly don't know.


219
220
221
222
223
224
# File 'lib/minitest/spec.rb', line 219

def self.let name, &block
  define_method name do
    @_memoized ||= {}
    @_memoized.fetch(name) { |k| @_memoized[k] = instance_eval(&block) }
  end
end

.nuke_test_methods!Object

:nodoc:


152
153
154
155
156
# File 'lib/minitest/spec.rb', line 152

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(*args, &block) ⇒ Object

Register a new type of spec that matches the spec's description. This method can take either a Regexp and a spec class or a spec class and a block that takes the description and returns true if it matches.

Eg:

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

or:

register_spec_type(MiniTest::Spec::RailsModel) do |desc|
  desc.superclass == ActiveRecord::Base
end

116
117
118
119
120
121
122
123
# File 'lib/minitest/spec.rb', line 116

def self.register_spec_type(*args, &block)
  if block then
    matcher, klass = block, args.first
  else
    matcher, klass = *args
  end
  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

130
131
132
133
134
135
136
137
138
# File 'lib/minitest/spec.rb', line 130

def self.spec_type desc
  TYPES.find { |matcher, klass|
    if matcher.respond_to? :call then
      matcher.call desc
    else
      matcher === desc.to_s
    end
  }.last
end

.subject(&block) ⇒ Object

Another lazy man's accessor generator. Made even more lazy by setting the name for you to subject.


230
231
232
# File 'lib/minitest/spec.rb', line 230

def self.subject &block
  let :subject, &block
end

.to_sObject Also known as: name

:nodoc:


247
248
249
# File 'lib/minitest/spec.rb', line 247

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