Class: Brut::TUI::Script::Events::StepStarted

Inherits:

Events::BaseEvent

• Object
• Events::BaseEvent
• Brut::TUI::Script::Events::StepStarted

Defined in:

lib/brut/tui/script/events/step_started.rb

Overview

Fired when a step is about to execute

Direct Known Subclasses

StepCompleted

Instance Method Summary

• #deconstruct_keys(keys = nil) ⇒ Object

  Adds description to the keyword arguments.

• #initialize(step:) ⇒ StepStarted constructor

  A new instance of StepStarted.

• #to_s ⇒ Object

Methods inherited from Events::BaseEvent

#drain_then_exit?, #exit?, handler_method_name

Constructor Details

#initialize(step:) ⇒ StepStarted

Returns a new instance of StepStarted.

# File 'lib/brut/tui/script/events/step_started.rb', line 3

def initialize(step:)
  @step = step
end

Instance Method Details

#deconstruct_keys(keys = nil) ⇒ Object

Adds description to the keyword arguments

# File 'lib/brut/tui/script/events/step_started.rb', line 8

def deconstruct_keys(keys=nil)
  super.merge({ description: @step.description })
end

#to_s ⇒ Object

# File 'lib/brut/tui/script/events/step_started.rb', line 11

def to_s = @description