Module: Test::Unit::TestCaseOmissionSupport (Ruby 2.7.5)
Description: Module : Test::Unit::TestCaseOmissionSupport - Ruby 2.7.5

### Home Classes Methods

### In Files

- test-unit-3.3.4/lib/test/unit/omission.rb

### Methods

- ::included
- #omit
- #omit_if
- #omit_unless

### Included Modules

- Test::Unit::OmissionHandler

### Class/Module Index

Quicksearch

- Object
- Test
- Test::Unit
- Test::Unit::AssertionFailedError
- Test::Unit::Assertions
- Test::Unit::Assertions::AssertExceptionHelper
- Test::Unit::Assertions::AssertExceptionHelper::WrappedException
- Test::Unit::Assertions::AssertionMessage
- Test::Unit::Assertions::AssertionMessage::ArrayInspector
- Test::Unit::Assertions::AssertionMessage::DelayedLiteral
- Test::Unit::Assertions::AssertionMessage::HashInspector
- Test::Unit::Assertions::AssertionMessage::Inspector
- Test::Unit::Assertions::AssertionMessage::Literal
- Test::Unit::Assertions::AssertionMessage::MaybeContainer
- Test::Unit::Assertions::AssertionMessage::NumericInspector
- Test::Unit::Assertions::AssertionMessage::Template
- Test::Unit::Assertions::ThrowTagExtractor
- Test::Unit::Attribute
- Test::Unit::Attribute::BaseClassMethods
- Test::Unit::Attribute::ClassMethods
- Test::Unit::Attribute::StringifyKeyHash
- Test::Unit::AttributeMatcher
- Test::Unit::AutoRunner
- Test::Unit::AutoRunner::StopOnFailureListener
- Test::Unit::AutoRunnerLoader
- Test::Unit::CodeSnippetFetcher
- Test::Unit::Collector
- Test::Unit::Collector::Descendant
- Test::Unit::Collector::Dir
- Test::Unit::Collector::Load
- Test::Unit::Collector::ObjectSpace
- Test::Unit::Collector::XML
- Test::Unit::Collector::XML::Listener
- Test::Unit::Color
- Test::Unit::Color::Error
- Test::Unit::Color::ParseError
- Test::Unit::ColorScheme
- Test::Unit::Data
- Test::Unit::Data::ClassMethods
- Test::Unit::Data::ClassMethods::Loader
- Test::Unit::DataSets
- Test::Unit::Diff
- Test::Unit::Diff::Differ
- Test::Unit::Diff::ReadableDiffer
- Test::Unit::Diff::SequenceMatcher
- Test::Unit::Diff::UTF8Line
- Test::Unit::Diff::UnifiedDiffer
- Test::Unit::Error
- Test::Unit::ErrorHandler
- Test::Unit::ExceptionHandler
- Test::Unit::ExceptionHandler::ClassMethods
- Test::Unit::Failure
- Test::Unit::FailureHandler
- Test::Unit::FaultLocationDetector
- Test::Unit::Fixture
- Test::Unit::Fixture::ClassMethods
- Test::Unit::Fixture::Fixture
- Test::Unit::Fixture::HookPoint
- Test::Unit::MixColor
- Test::Unit::Notification
- Test::Unit::NotificationHandler
- Test::Unit::NotifiedError
- Test::Unit::NullResultContainerInitializer
- Test::Unit::Omission
- Test::Unit::OmissionHandler
- Test::Unit::OmittedError
- Test::Unit::PendedError
- Test::Unit::Pending
- Test::Unit::PendingHandler
- Test::Unit::Priority
- Test::Unit::Priority::Checker
- Test::Unit::Priority::ClassMethods
- Test::Unit::TestCase
- Test::Unit::TestCase::InternalData
- Test::Unit::TestCaseNotificationSupport
- Test::Unit::TestCaseOmissionSupport
- Test::Unit::TestCasePendingSupport
- Test::Unit::TestResult
- Test::Unit::TestResultErrorSupport
- Test::Unit::TestResultFailureSupport
- Test::Unit::TestResultNotificationSupport
- Test::Unit::TestResultOmissionSupport
- Test::Unit::TestResultPendingSupport
- Test::Unit::TestSuite
- Test::Unit::UI
- Test::Unit::UI::Console
- Test::Unit::UI::Console::ColorizedReadableDiffer
- Test::Unit::UI::Console::OutputLevel
- Test::Unit::UI::Console::TestRunner
- Test::Unit::UI::Emacs
- Test::Unit::UI::Emacs::TestRunner
- Test::Unit::UI::TestRunner
- Test::Unit::UI::TestRunnerMediator
- Test::Unit::UI::TestRunnerUtilities
- Test::Unit::UI::XML
- Test::Unit::UI::XML::TestRunner
- Test::Unit::Util
- Test::Unit::Util::BacktraceFilter
- Test::Unit::Util::MethodOwnerFinder
- Test::Unit::Util::Observable
- Test::Unit::Util::Output
- Test::Unit::Util::ProcWrapper

No matching classes.

# Test::Unit::TestCaseOmissionSupport

### Public Class Methods

included(base) click to toggle source

                   # File test-unit-3.3.4/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) click to toggle source

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

                   # File test-unit-3.3.4/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_if(condition, *args, &block) click to toggle source

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

                   # File test-unit-3.3.4/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_unless(condition, *args, &block) click to toggle source

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

                   # File test-unit-3.3.4/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