Class: SleepingKingStudios::Tools::Assertions::Aggregator

Inherits:
Assertions
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/sleeping_king_studios/tools/assertions/aggregator.rb

Overview

Utility for grouping multiple assertion statements.

Examples:

rocket = Struct.new(:fuel, :launched).new(0.0, true)
aggregator = SleepingKingStudios::Tools::Assertions::Aggregator.new
aggregator.empty?
#=> true

aggregator.assert(message: 'is out of fuel') { rocket.fuel > 0 }
aggregator.assert(message: 'has already launched') { !rocket.launched }
aggregator.empty?
#=> false
aggregator.failure_message
#=> 'is out of fuel, has already launched'

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Aggregator

Returns a new instance of Aggregator.



23
24
25
26
27
 
# File 'lib/sleeping_king_studios/tools/assertions/aggregator.rb', line 23

def initialize
  super

  @failures = []
end

Instance Method Details

#<<(message) ⇒ Array

Appends the message to the failure messages.

Parameters:

  • message (String) —

    the message to append.

Returns:

  • (Array) —

    the updated failure messages.

See Also:

  • Array#<<.



# File 'lib/sleeping_king_studios/tools/assertions/aggregator.rb', line 29

#assert_group(error_class: AssertionError, message: nil) {|aggregator| ... } ⇒ void Also known as: aggregate

This method returns an undefined value.

Evaluates a series of assertions and combines all failures.

Examples:

Assertions.assert_group do |group|
  group.assert_name(nil, as: 'label')
  group.assert_instance_of(0.0, expected: Integer, as: 'quantity')
end
# raises an AssertionError with message: "label can't be blank, quantity is not an instance of Integer"

Parameters:

  • error_class (Class) (defaults to: AssertionError) —

    the exception class to raise on a failure.

  • message (String) (defaults to: nil) —

    the exception message to raise on a failure.

Yields:

  • the assertions to evaluate.

Yield Parameters:

  • aggregator (Aggregator) —

    the aggregator object.

Raises:



92
93
94
95
96
97
98
 
# File 'lib/sleeping_king_studios/tools/assertions/aggregator.rb', line 92

def assert_group(error_class: AssertionError, message: nil, &assertions)
  return super if message

  raise ArgumentError, 'no block given' unless block_given?

  assertions.call(self)
end

#clear ⇒ Array

Removes all items from the failure messages.

Returns:

  • (Array) —

    the empty failure messages.

See Also:

  • Array#clear.



# File 'lib/sleeping_king_studios/tools/assertions/aggregator.rb', line 38

#count ⇒ Integer

Returns a count of the failure message.

Returns:

  • (Integer) —

    the number of failure messages.

See Also:

  • Array#count.



# File 'lib/sleeping_king_studios/tools/assertions/aggregator.rb', line 45

#each ⇒ Enumerator #each {|message| ... } ⇒ Object

Iterates over the failure messages.

Overloads:

  • #each ⇒ Enumerator

    Returns an enumerator that iterates over the failure messages.

    Returns:

    • (Enumerator) —

      an enumerator over the messages.

    See Also:

    • Enumerable#each.
  • #each {|message| ... } ⇒ Object

    Yields each failure message to the block.

    Yield Parameters:

    • message (String) —

      the current failure message.

    See Also:

    • Enumerable#each.



# File 'lib/sleeping_king_studios/tools/assertions/aggregator.rb', line 52

#empty? ⇒ true, false

Checks if there are any failure messages.

Returns:

  • (true, false) —

    true if there are no failure messages; otherwise false.

See Also:

  • Enumerable#empty?



# File 'lib/sleeping_king_studios/tools/assertions/aggregator.rb', line 69

#failure_message ⇒ String

Generates a combined failure message from the configured messages.

Examples:

With an empty aggregator.

aggregator = SleepingKingStudios::Tools::Assertions::Aggregator.new

aggregator.failure_message
#=> ''

With an aggregator with failure messages.

aggregator = SleepingKingStudios::Tools::Assertions::Aggregator.new
aggrgator << 'rocket is out of fuel'
aggrgator << 'rocket is not pointed toward space'

aggregator.failure_message
#=> 'rocket is out of fuel, rocket is not pointed toward space'

Returns:

  • (String) —

    the combined messages for each failed assertion.



118
119
120
 
# File 'lib/sleeping_king_studios/tools/assertions/aggregator.rb', line 118

def failure_message
  failures.join(', ')
end

#size ⇒ Integer

Returns a count of the failure message.

Returns:

  • (Integer) —

    the number of failure messages.

See Also:

  • Array#size.


83
84
85
86
87
88
89
 
# File 'lib/sleeping_king_studios/tools/assertions/aggregator.rb', line 83

def_delegators :@failures,
:<<,
:clear,
:count,
:each,
:empty?,
:size