Class: Krane::DeferredSummaryLogging::DeferredSummary
- Inherits:
-
Object
- Object
- Krane::DeferredSummaryLogging::DeferredSummary
- Defined in:
- lib/krane/deferred_summary_logging.rb
Instance Attribute Summary collapse
-
#paragraphs ⇒ Object
readonly
Returns the value of attribute paragraphs.
Instance Method Summary collapse
- #actions_sentence ⇒ Object
-
#add_action(sentence_fragment) ⇒ Object
Saves a sentence fragment to be displayed in the first sentence of the summary section.
-
#add_paragraph(paragraph) ⇒ Object
Adds a paragraph to be displayed in the summary section Paragraphs will be printed in the order they were added, separated by a blank line This can be used to log a block of data on a particular topic, e.g.
-
#initialize ⇒ DeferredSummary
constructor
A new instance of DeferredSummary.
Constructor Details
#initialize ⇒ DeferredSummary
Returns a new instance of DeferredSummary.
67 68 69 70 |
# File 'lib/krane/deferred_summary_logging.rb', line 67 def initialize @actions_taken = [] @paragraphs = [] end |
Instance Attribute Details
#paragraphs ⇒ Object (readonly)
Returns the value of attribute paragraphs.
65 66 67 |
# File 'lib/krane/deferred_summary_logging.rb', line 65 def paragraphs @paragraphs end |
Instance Method Details
#actions_sentence ⇒ Object
72 73 74 75 |
# File 'lib/krane/deferred_summary_logging.rb', line 72 def actions_sentence return unless @actions_taken.present? @actions_taken.to_sentence.capitalize end |
#add_action(sentence_fragment) ⇒ Object
Saves a sentence fragment to be displayed in the first sentence of the summary section
Example: # The resulting summary will begin with “Created 3 secrets and failed to deploy 2 resources” @logger.summary.add_action(“created 3 secrets”) @logger.summary.add_action(“failed to deploy 2 resources”)
83 84 85 |
# File 'lib/krane/deferred_summary_logging.rb', line 83 def add_action(sentence_fragment) @actions_taken << sentence_fragment end |
#add_paragraph(paragraph) ⇒ Object
Adds a paragraph to be displayed in the summary section Paragraphs will be printed in the order they were added, separated by a blank line This can be used to log a block of data on a particular topic, e.g. debug info for a particular failed resource
90 91 92 |
# File 'lib/krane/deferred_summary_logging.rb', line 90 def add_paragraph(paragraph) paragraphs << paragraph end |