Class: Minitest::Runnable
Overview
Represents anything “runnable”, like Test, Spec, Benchmark, or whatever you can dream up.
Subclasses of this are automatically registered and available in Runnable.runnables.
Direct Known Subclasses
Constant Summary collapse
- SIGNALS =
Signal.list
Instance Attribute Summary collapse
-
#assertions ⇒ Object
Number of assertions executed in this run.
-
#failures ⇒ Object
An assertion raised during the run, if any.
Class Method Summary collapse
-
.inherited(klass) ⇒ Object
:nodoc:.
-
.methods_matching(re) ⇒ Object
Returns all instance methods matching the pattern
re
. -
.on_signal(name, action) ⇒ Object
:nodoc:.
-
.reset ⇒ Object
:nodoc:.
-
.run(reporter, options = {}) ⇒ Object
Responsible for running all runnable methods in a given class, each in its own instance.
- .run_one_method(klass, method_name, reporter) ⇒ Object
-
.runnable_methods ⇒ Object
Each subclass of Runnable is responsible for overriding this method to return all runnable methods.
-
.runnables ⇒ Object
Returns all subclasses of Runnable.
-
.with_info_handler(reporter, &block) ⇒ Object
:nodoc:.
Instance Method Summary collapse
-
#failure ⇒ Object
:nodoc:.
-
#initialize(name) ⇒ Runnable
constructor
:nodoc:.
-
#marshal_dump ⇒ Object
:nodoc:.
-
#marshal_load(ary) ⇒ Object
:nodoc:.
-
#name ⇒ Object
Name of the run.
-
#name=(o) ⇒ Object
Set the name of the run.
-
#passed? ⇒ Boolean
Did this run pass?.
-
#result_code ⇒ Object
Returns a single character string to print based on the result of the run.
-
#run ⇒ Object
Runs a single method.
-
#skipped? ⇒ Boolean
Was this run skipped? See #passed? for more information.
Constructor Details
#initialize(name) ⇒ Runnable
:nodoc:
352 353 354 355 356 |
# File 'lib/minitest.rb', line 352 def initialize name # :nodoc: self.name = name self.failures = [] self.assertions = 0 end |
Instance Attribute Details
#assertions ⇒ Object
Number of assertions executed in this run.
234 235 236 |
# File 'lib/minitest.rb', line 234 def assertions @assertions end |
#failures ⇒ Object
An assertion raised during the run, if any.
239 240 241 |
# File 'lib/minitest.rb', line 239 def failures @failures end |
Class Method Details
.inherited(klass) ⇒ Object
:nodoc:
255 256 257 258 |
# File 'lib/minitest.rb', line 255 def self.inherited klass # :nodoc: self.runnables << klass super end |
.methods_matching(re) ⇒ Object
Returns all instance methods matching the pattern re
.
263 264 265 |
# File 'lib/minitest.rb', line 263 def self.methods_matching re public_instance_methods(true).grep(re).map(&:to_s) end |
.on_signal(name, action) ⇒ Object
:nodoc:
312 313 314 315 316 317 318 319 320 321 322 323 |
# File 'lib/minitest.rb', line 312 def self.on_signal name, action # :nodoc: supported = SIGNALS[name] old_trap = trap name do old_trap.call if old_trap.respond_to? :call action.call end if supported yield ensure trap name, old_trap if supported end |
.reset ⇒ Object
:nodoc:
267 268 269 |
# File 'lib/minitest.rb', line 267 def self.reset # :nodoc: @@runnables = [] end |
.run(reporter, options = {}) ⇒ Object
Responsible for running all runnable methods in a given class, each in its own instance. Each instance is passed to the reporter to record.
278 279 280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'lib/minitest.rb', line 278 def self.run reporter, = {} filter = [:filter] || '/./' filter = Regexp.new $1 if filter =~ /\/(.*)\// filtered_methods = self.runnable_methods.find_all { |m| filter === m || filter === "#{self}##{m}" } with_info_handler reporter do filtered_methods.each do |method_name| run_one_method self, method_name, reporter end end end |
.run_one_method(klass, method_name, reporter) ⇒ Object
293 294 295 |
# File 'lib/minitest.rb', line 293 def self.run_one_method klass, method_name, reporter reporter.record Minitest.run_one_method(klass, method_name) end |
.runnable_methods ⇒ Object
Each subclass of Runnable is responsible for overriding this method to return all runnable methods. See #methods_matching.
329 330 331 |
# File 'lib/minitest.rb', line 329 def self.runnable_methods raise NotImplementedError, "subclass responsibility" end |
.runnables ⇒ Object
Returns all subclasses of Runnable.
336 337 338 |
# File 'lib/minitest.rb', line 336 def self.runnables @@runnables end |
.with_info_handler(reporter, &block) ⇒ Object
:nodoc:
297 298 299 300 301 302 303 304 305 306 307 308 |
# File 'lib/minitest.rb', line 297 def self.with_info_handler reporter, &block # :nodoc: handler = lambda do unless reporter.passed? then warn "Current results:" warn "" warn reporter.reporters.first warn "" end end on_signal "INFO", handler, &block end |
Instance Method Details
#failure ⇒ Object
:nodoc:
348 349 350 |
# File 'lib/minitest.rb', line 348 def failure # :nodoc: self.failures.first end |
#marshal_dump ⇒ Object
:nodoc:
340 341 342 |
# File 'lib/minitest.rb', line 340 def marshal_dump # :nodoc: [self.name, self.failures, self.assertions] end |
#marshal_load(ary) ⇒ Object
:nodoc:
344 345 346 |
# File 'lib/minitest.rb', line 344 def marshal_load ary # :nodoc: self.name, self.failures, self.assertions = ary end |
#name=(o) ⇒ Object
Set the name of the run.
251 252 253 |
# File 'lib/minitest.rb', line 251 def name= o @NAME = o end |
#passed? ⇒ Boolean
Did this run pass?
Note: skipped runs are not considered passing, but they don’t cause the process to exit non-zero.
371 372 373 |
# File 'lib/minitest.rb', line 371 def passed? raise NotImplementedError, "subclass responsibility" end |
#result_code ⇒ Object
Returns a single character string to print based on the result of the run. Eg “.”, “F”, or “E”.
379 380 381 |
# File 'lib/minitest.rb', line 379 def result_code raise NotImplementedError, "subclass responsibility" end |
#run ⇒ Object
Runs a single method. Needs to return self.
361 362 363 |
# File 'lib/minitest.rb', line 361 def run raise NotImplementedError, "subclass responsibility" end |
#skipped? ⇒ Boolean
Was this run skipped? See #passed? for more information.
386 387 388 |
# File 'lib/minitest.rb', line 386 def skipped? raise NotImplementedError, "subclass responsibility" end |