Module: MiniTest::Spec::DSL

Included in:
MiniTest::Spec
Defined in:
lib/minitest/spec.rb

Overview

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

Constant Summary

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]]

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#descObject (readonly)

:stopdoc:



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

def desc
  @desc
end

Instance 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.



176
177
178
179
180
181
# File 'lib/minitest/spec.rb', line 176

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



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

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

#childrenObject

Returns the children of this spec.



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

def children
  @children ||= []
end

#create(name, desc) ⇒ Object

:nodoc:



231
232
233
234
235
236
237
238
239
240
241
242
# File 'lib/minitest/spec.rb', line 231

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

    nuke_test_methods!
  end

  children << cls

  cls
end

#describe_stackObject

:nodoc:



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

def describe_stack # :nodoc:
  Thread.current[: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 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/unit. You can mix and match between assertions and expectations as much as you want.



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

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

Essentially, define an accessor for name with block.

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



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

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

#nameObject

:nodoc:



244
245
246
# File 'lib/minitest/spec.rb', line 244

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

#nuke_test_methods!Object

:nodoc:



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

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


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

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

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

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


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

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

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



227
228
229
# File 'lib/minitest/spec.rb', line 227

def subject &block
  let :subject, &block
end

#to_sObject

:nodoc:



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

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