Module: Minitest::Spec::DSL

Included in:
BenchSpec, Minitest::Spec
Defined in:
lib/minitest/spec.rb,
lib/spec.rb

Overview

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

Defined Under Namespace

Modules: InstanceMethods

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#desc ⇒ Object (readonly)

:stopdoc:



268
269
270
 
# File 'lib/minitest/spec.rb', line 268

def desc
  @desc
end

Class Method Details

.extended(obj) ⇒ Object 



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

def self.extended obj
  obj.send :include, InstanceMethods
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::Test#teardown.



183
184
185
186
187
188
 
# File 'lib/minitest/spec.rb', line 183

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



169
170
171
172
173
174
 
# File 'lib/minitest/spec.rb', line 169

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

#children ⇒ Object

Returns the children of this spec.



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

def children
  @children ||= []
end

#create(name, desc) ⇒ Object

:nodoc:



246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/minitest/spec.rb', line 246

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

    nuke_test_methods!
  end

  children << cls

  cls
end

#describe_stack ⇒ Object

:nodoc:



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

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



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/minitest/spec.rb', line 201

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.

Raises:

  • (ArgumentError) 


223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/minitest/spec.rb', line 223

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

:nodoc:



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

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

#nuke_test_methods! ⇒ Object

:nodoc:



156
157
158
159
160
 
# File 'lib/minitest/spec.rb', line 156

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



121
122
123
124
125
126
127
128
 
# File 'lib/minitest/spec.rb', line 121

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



135
136
137
138
139
140
141
142
143
 
# File 'lib/minitest/spec.rb', line 135

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.



242
243
244
 
# File 'lib/minitest/spec.rb', line 242

def subject &block
  let :subject, &block
end

#t ⇒ Object 



155
 
# File 'lib/spec.rb', line 155

alias_method :t, :it

#to_s ⇒ Object

:nodoc:



263
264
265
 
# File 'lib/minitest/spec.rb', line 263

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