Module: Minitest::Spec::DSL

Relationships & Source Files
Namespace Children
Modules: `InstanceMethods`
Extension / Inclusion / Inheritance Descendants
Extended In: `::Minitest::BenchSpec`, `::Minitest::Spec`
Defined in:	lib/minitest/spec.rb

Overview

Oh look! A DSL module! Eat your heart out DHH.

Constant Summary

TYPES =

Contains pairs of matchers and ::Minitest::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

# File 'lib/minitest/spec.rb', line 117
```
[[//, Minitest::Spec]]
```

Class Method Summary

.extended(obj) Internal use only

Instance Attribute Summary

#desc readonly Internal use only

Instance Method Summary

#after(_type = nil, &block)

Define an ‘after’ action.
#before(_type = nil, &block)

Define a ‘before’ action.
#it(desc = "anonymous", &block) (also: #specify)

Define an expectation with name #desc.
#let(name, &block)

Essentially, define an accessor for #name with block.
#register_spec_type(*args, &block)

Register a new type of spec that matches the spec’s description.
#spec_type(desc, *additional)

Figure out the spec class to use based on a spec’s description.
#specify(desc = "anonymous", &block)

Alias for #it.
#subject(&block)

Another lazy man’s accessor generator.
#children Internal use only
#create(name, desc) Internal use only
#describe_stack Internal use only
#name Internal use only
#nuke_test_methods! Internal use only
#to_s Internal use only

Class Method Details

.extended(obj)

This method is for internal use only.

[ GitHub ]

# File 'lib/minitest/spec.rb', line 317


def self.extended obj # :nodoc:
  obj.send :include, InstanceMethods
end

Instance Attribute Details

#desc (readonly)

This method is for internal use only.

[ GitHub ]

# File 'lib/minitest/spec.rb', line 280


attr_reader :desc # :nodoc:

Instance Method Details

#after(_type = nil, &block)

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::Test#teardown.

[ GitHub ]

# File 'lib/minitest/spec.rb', line 194


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

#before(_type = nil, &block)

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::Test#setup.

[ GitHub ]

# File 'lib/minitest/spec.rb', line 180


def before _type = nil, &block
  define_method :setup do
    super()
    self.instance_eval(&block)
  end
end

#children

This method is for internal use only.

[ GitHub ]

# File 'lib/minitest/spec.rb', line 163


def children # :nodoc:
  @children ||= []
end

#create(name, desc)

This method is for internal use only.

[ GitHub ]

# File 'lib/minitest/spec.rb', line 259


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

    nuke_test_methods!
  end

  children << cls

  cls
end

#describe_stack

This method is for internal use only.

[ GitHub ]

# File 'lib/minitest/spec.rb', line 159


def describe_stack # :nodoc:
  Thread.current[:describe_stack] ||= []
end

#it(desc = "anonymous", &block) 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 inheritance, 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 inheritance, use minitest/test. You can mix and match between assertions and expectations as much as you want.

[ GitHub ]

# File 'lib/minitest/spec.rb', line 212


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

  @specs ||= 0
  @specs += 1

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

  undef_klasses = self.children.reject { |c| c.public_method_defined? name }

  define_method name, &block

  undef_klasses.each do |undef_klass|
    undef_klass.send :undef_method, name
  end

  name
end

#let(name, &block)

Essentially, define an accessor for #name with block.

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

Raises:

(ArgumentError)

[ GitHub ]

# File 'lib/minitest/spec.rb', line 236


def let name, &block
  name = name.to_s
  pre, post = "let '#{name}' cannot ", ". Please use another name."
  methods = Minitest::Spec.instance_methods.map(&:to_s) - %w[subject]
  raise ArgumentError, "#{pre}begin with 'test'#{post}" if
    name =~ /\Atest/
  raise ArgumentError, "#{pre}override a method in Minitest::Spec#{post}" if
    methods.include? name

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

#name

This method is for internal use only.

[ GitHub ]

# File 'lib/minitest/spec.rb', line 272


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

#nuke_test_methods!

This method is for internal use only.

[ GitHub ]

# File 'lib/minitest/spec.rb', line 167


def 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)

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

[ GitHub ]

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


def 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, *additional)

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

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

[ GitHub ]

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


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

#specify(desc = "anonymous", &block)

Alias for #it.

[ GitHub ]

# File 'lib/minitest/spec.rb', line 281


alias :specify :it

#subject(&block)

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

[ GitHub ]

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


def subject &block
  let :subject, &block
end

#to_s

This method is for internal use only.

[ GitHub ]

# File 'lib/minitest/spec.rb', line 276


def to_s # :nodoc:
  name # Can't alias due to 1.8.7, not sure why
end