module Test::Unit::TestCaseOmissionSupport - Ruby 4.0.6 API Documentation

Public Class Methods

Source

# File bundled-src/test-unit-3.7.5/lib/test/unit/omission.rb, line 58
def included(base)
  base.class_eval do
    include OmissionHandler
  end
end

Public Instance Methods

omit (message=nil, &block)

Source

# File bundled-src/test-unit-3.7.5/lib/test/unit/omission.rb, line 80
def omit(message=nil, &block)
  message ||= "omitted."
  if block_given?
    omission = Omission.new(name, filter_backtrace(caller), message,
                            :method_name => @method_name)
    add_omission(omission)
  else
    raise OmittedError.new(message)
  end
end

Omit the test or part of the test.

Example:

def test_omission
  omit
  # Not reached here
end

def test_omission_with_here
  omit do
    # Not ran here
  end
  # Reached here
end

omit_if (condition, *args, &block)

Source

# File bundled-src/test-unit-3.7.5/lib/test/unit/omission.rb, line 110
def omit_if(condition, *args, &block)
  if condition
    omit(*args, &block)
  else
    block.call if block
  end
end

Omit the test or part of the test if condition is true.

Example:

def test_omission
  omit_if("".empty?)
  # Not reached here
end

def test_omission_with_here
  omit_if(true) do
    # Not ran here
  end
  omit_if(false) do
    # Reached here
  end
  # Reached here too
end

omit_unless (condition, *args, &block)

Source

# File bundled-src/test-unit-3.7.5/lib/test/unit/omission.rb, line 137
def omit_unless(condition, *args, &block)
  if condition
    block.call if block
  else
    omit(*args, &block)
  end
end

Omit the test or part of the test if condition is not true.

Example:

def test_omission
  omit_unless("string".empty?)
  # Not reached here
end

def test_omission_with_here
  omit_unless(true) do
    # Reached here
  end
  omit_unless(false) do
    # Not ran here
  end
  # Reached here too
end

Private Instance Methods

add_omission (omission)

Source

# File bundled-src/test-unit-3.7.5/lib/test/unit/omission.rb, line 146
def add_omission(omission)
  current_result.add_omission(omission)
end