MiniTest::Spec – The faster, better, less-magical spec framework!
For a list of expectations, see MiniTest::Expectations.
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
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.
# File lib/minitest/spec.rb, line 171 def self.after type = :each, &block raise "unsupported after type: #{type}" unless type == :each add_teardown_hook {|tc| tc.instance_eval(&block) } end
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.
# File lib/minitest/spec.rb, line 158 def self.before type = :each, &block raise "unsupported before type: #{type}" unless type == :each add_setup_hook {|tc| tc.instance_eval(&block) } end
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 lib/minitest/benchmark.rb, line 309 def self.bench name, &block define_method "bench_#{name.gsub(/\W+/, '_')}", &block end
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 lib/minitest/benchmark.rb, line 353 def self.bench_performance_constant name, threshold = 0.99, &work bench name do assert_performance_constant threshold, &work end end
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 lib/minitest/benchmark.rb, line 368 def self.bench_performance_exponential name, threshold = 0.99, &work bench name do assert_performance_exponential threshold, &work end end
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 lib/minitest/benchmark.rb, line 338 def self.bench_performance_linear name, threshold = 0.99, &work bench name do assert_performance_linear threshold, &work end end
Specifies the ranges used for benchmarking for that class.
bench_range do bench_exp(2, 16, 2) end
See MiniTest::Unit::TestCase.bench_range for more details.
# File lib/minitest/benchmark.rb, line 322 def self.bench_range &block return super unless block meta = (class << self; self; end) meta.send :define_method, "bench_range", &block end
Returns the children of this spec.
# File lib/minitest/spec.rb, line 141 def self.children @children ||= [] end
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.
# File lib/minitest/spec.rb, line 194 def self.it desc = "anonymous", &block block ||= proc { skip "(no tests defined)" } @specs ||= 0 @specs += 1 name = "test_%04d_%s" % [ @specs, desc.gsub(NAME_RE, '_').downcase ] define_method name, &block self.children.each do |mod| mod.send :undef_method, name if mod.public_method_defined? name end name end
Essentially, define an accessor for name
with
block
.
Why use let instead of def? I honestly don’t know.
# File lib/minitest/spec.rb, line 216 def self.let name, &block define_method name do @_memoized ||= {} @_memoized.fetch(name) { |k| @_memoized[k] = instance_eval(&block) } end end
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
# File lib/minitest/spec.rb, line 109 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
Figure out the spec class to use based on a spec’s description. Eg:
spec_type("BlahController") # => MiniTest::Spec::Rails
# File lib/minitest/spec.rb, line 123 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
Another lazy man’s accessor generator. Made even more lazy by setting the
name for you to subject
.
# File lib/minitest/spec.rb, line 227 def self.subject &block let :subject, &block end