123456789_123456789_123456789_123456789_123456789_

Class: Minitest::Runnable

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
BenchSpec, Benchmark, Spec, Test, Minitest::Unit::TestCase
Inherits: Object
Defined in: lib/minitest.rb

Overview

Represents anything “runnable”, like Test, Spec, Benchmark, or whatever you can dream up.

Subclasses of this are automatically registered and available in .runnables.

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

  • #result_code

    Returns a single character string to print based on the result of the run.

  • #run

    Runs a single method.

Class Method Details

.methods_matching(re)

Returns all instance methods matching the pattern re.

[ GitHub ] 

  


# File 'lib/minitest.rb', line 263



def self.methods_matching re
  public_instance_methods(true).grep(re).map(&:to_s)
end


  








  

    .run(reporter, options = {})  
  



  

    

Responsible for running all runnable methods in a given class, each in its own instance. Each instance is passed to the reporter to record.


  



  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 278



def self.run reporter, options = {}
  filter = options[: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)  
  

  [ GitHub ]


  

  


# 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  
  



  

    

Each subclass of Runnable is responsible for overriding this method to return all runnable methods. See #methods_matching.


  





  
Raises:


    
  
  • 
    (NotImplementedError)
  
    • 





  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 329



def self.runnable_methods
  raise NotImplementedError, "subclass responsibility"
end


  








  

    .runnables  
  



  

    

Returns all subclasses of Runnable.


  



  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 336



def self.runnables
  @@runnables
end


  







Instance Attribute Details



  

    #assertions   (rw)
  



  

    

Number of assertions executed in this run.


  



  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 234



attr_accessor :assertions


  








  

    #failures   (rw)
  



  

    

An assertion raised during the run, if any.


  



  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 239



attr_accessor :failures


  








  

    #name   (rw)
  



  

    

Name of the run.


  



  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 244



def name
  @NAME
end


  








  

    #name=(o)   (rw)
  



  

    

Set the name of the run.


  



  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 251



def name= o
  @NAME = o
end


  








  

    #passed?  ⇒ Boolean  (readonly)
  



  

    

Did this run pass?



Note: skipped runs are not considered passing, but they don't cause the process to exit non-zero.


  





  
Raises:


    
  
  • 
    (NotImplementedError)
  
    • 





  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 371



def passed?
  raise NotImplementedError, "subclass responsibility"
end


  








  

    #skipped?  ⇒ Boolean  (readonly)
  



  

    

Was this run skipped? See #passed? for more information.


  





  
Raises:


    
  
  • 
    (NotImplementedError)
  
    • 





  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 386



def skipped?
  raise NotImplementedError, "subclass responsibility"
end


  







Instance Method Details



  

    #result_code  
  



  

    

Returns a single character string to print based on the result of the run. Eg “.”, “F”, or “E”.


  





  
Raises:


    
  
  • 
    (NotImplementedError)
  
    • 





  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 379



def result_code
  raise NotImplementedError, "subclass responsibility"
end


  








  

    #run  
  



  

    

Runs a single method. Needs to return self.


  





  
Raises:


    
  
  • 
    (NotImplementedError)
  
    • 





  [ GitHub ]


  

  


# File 'lib/minitest.rb', line 361



def run
  raise NotImplementedError, "subclass responsibility"
end