module Minitest::Spec::DSL - minitest-5.0.7 Documentation

# module Minitest::Spec::DSL

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

### Constants

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

### Public Instance Methods

after(type = nil, &block) click to toggle source

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

Calls superclass method

    # File lib/minitest/spec.rb, line 185
    def after type = nil, &block
      define_method :teardown do
        self.instance_eval(&block)
        super()
      end
    end

before(type = nil, &block) click to toggle source

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

Calls superclass method

    # File lib/minitest/spec.rb, line 171
    def before type = nil, &block
      define_method :setup do
        super()
        self.instance_eval(&block)
      end
    end

children() click to toggle source

Returns the children of this spec.

    # File lib/minitest/spec.rb, line 154
    def children
      @children ||= []
    end

it(desc = "anonymous", &block) click to toggle source

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 inheritence, use minitest/test. You can mix and match between assertions and expectations as much as you want.

    # File lib/minitest/spec.rb, line 203
    def 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) click to toggle source

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 225
    def let name, &block
      raise ArgumentError, 'name cannot begin with "test"' if name.to_s =~ /\Atest/
      define_method name do
        @_memoized ||= {}
        @_memoized.fetch(name) { |k| @_memoized[k] = instance_eval(&block) }
      end
    end

register_spec_type(*args, &block) click to toggle source

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 123
    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) click to toggle source

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 137
    def 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) click to toggle source

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

    # File lib/minitest/spec.rb, line 237
    def subject &block
      let :subject, &block
    end