Module: Test::Unit::Util::Observable

### Home Classes Methods

### In Files

- lib/test/unit/util/observable.rb

### Methods

- #add_listener
- #notify_listeners
- #remove_listener

### Class/Module Index

Quicksearch

- Test
- Test::Unit
- Test::Unit::AssertionFailedError
- Test::Unit::Assertions
- Test::Unit::Attribute
- Test::Unit::Attribute::BaseClassMethods
- Test::Unit::Attribute::ClassMethods
- Test::Unit::Attribute::StringifyKeyHash
- Test::Unit::AttributeMatcher
- Test::Unit::AutoRunner
- 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::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::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
- Object

No matching classes.

# Test::Unit::Util::Observable

This is a utility class that allows anything mixing it in to notify a set of listeners about interesting events.

### Constants

NOTHING

  We use this for defaults since nil might mean something

### Public Instance Methods

add_listener(channel_name, listener_key=NOTHING) click to toggle source

Adds the passed proc as a listener on the channel indicated by channel_name. listener_key is used to remove the listener later; if none is specified, the proc itself is used.

Whatever is used as the listener_key is returned, making it very easy to use the proc itself as the listener_key:

    listener = add_listener("Channel") { ... }
    remove_listener("Channel", listener)

    # File lib/test/unit/util/observable.rb, line 31
    def add_listener(channel_name, listener_key=NOTHING, &listener) # :yields: value
      unless(block_given?)
        raise ArgumentError.new("No callback was passed as a listener")
      end

      key = listener_key
      if (listener_key == NOTHING)
        listener_key = listener
        key = ProcWrapper.new(listener)
      end

      channels[channel_name] ||= {}
      channels[channel_name][key] = listener
      return listener_key
    end

notify_listeners(channel_name, *arguments) click to toggle source

Calls all the procs registered on the channel indicated by channel_name. If value is specified, it is passed in to the procs, otherwise they are called with no arguments.

    # File lib/test/unit/util/observable.rb, line 74
    def notify_listeners(channel_name, *arguments)
      channel = channels[channel_name]
      return 0 unless (channel)
      listeners = channel.values
      listeners.each { |listener| listener.call(*arguments) }
      return listeners.size
    end

remove_listener(channel_name, listener_key) click to toggle source

Removes the listener indicated by listener_key from the channel indicated by channel_name. Returns the registered proc, or nil if none was found.

    # File lib/test/unit/util/observable.rb, line 51
    def remove_listener(channel_name, listener_key)
      channel = channels[channel_name]
      return nil unless (channel)
      key = listener_key
      if (listener_key.instance_of?(Proc))
        key = ProcWrapper.new(listener_key)
      end
      if (channel.has_key?(key))
        return channel.delete(key)
      end
      return nil
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.