Class: StateMachine::WhitelistMatcher

Inherits:

Matcher

• Object
• Matcher
• StateMachine::WhitelistMatcher

Defined in:

lib/state_machine/matcher.rb

Overview

Matches a specific set of values

Instance Attribute Summary

Attributes inherited from Matcher

#values

Instance Method Summary

• #description ⇒ Object

  A human-readable description of this matcher.

• #matches?(value, context = {}) ⇒ Boolean

  Checks whether the given value exists within the whitelist configured for this matcher.

Methods inherited from Matcher

#filter, #initialize

Constructor Details

This class inherits a constructor from StateMachine::Matcher

Instance Method Details

#description ⇒ Object

A human-readable description of this matcher

# File 'lib/state_machine/matcher.rb', line 70

def description
  values.length == 1 ? values.first.inspect : values.inspect
end

#matches?(value, context = {}) ⇒ Boolean

Checks whether the given value exists within the whitelist configured for this matcher.

Examples

matcher = StateMachine::WhitelistMatcher.new([:parked, :idling])
matcher.matches?(:parked)       # => true
matcher.matches?(:first_gear)   # => false

Returns:

• (Boolean)

# File 'lib/state_machine/matcher.rb', line 65

def matches?(value, context = {})
  values.include?(value)
end