module

Athena::Console::Style::Interface

Represents a "style" that provides a way to abstract how to format console input/output data such that you can reduce the amount of code needed, and to standardize the appearance.

See ACON::Style::Athena.

Custom Styles

Custom styles can also be created by implementing this interface, and optionally extending from ACON::Style::Output which makes the style an ACON::Output::Interface as well as defining part of this interface. Then you could simply instantiate your custom style within a command as you would ACON::Style::Athena.

Instance methods

ask(question : String, default : _)

Helper method for asking ACON::Question questions.

ask_hidden(question : String)

Helper method for asking hidden ACON::Question questions.

caution(messages : String | Enumerable(String)) : Nil

Formats and prints the provided messages within a caution block.

choice(question : String, choices : Indexable | Hash, default = nil)

Helper method for asking ACON::Question::Choice questions.

comment(messages : String | Enumerable(String)) : Nil

Formats and prints the provided messages within a comment block.

confirm(question : String, default : Bool = true) : Bool

Helper method for asking ACON::Question::Confirmation questions.

error(messages : String | Enumerable(String)) : Nil

Formats and prints the provided messages within a error block.

info(messages : String | Enumerable(String)) : Nil

Formats and prints the provided messages within a info block.

listing(elements : Enumerable) : Nil

Formats and prints a bulleted list containing the provided elements.

new_line(count : Int32 = 1) : Nil

Prints count empty new lines.

note(messages : String | Enumerable(String)) : Nil

Formats and prints the provided messages within a note block.

progress_advance(by step : Int32 = 1) : Nil

Advances the internal ACON::Helper::ProgressBar by the provided amount of steps.

progress_finish

Completes the internal ACON::Helper::ProgressBar.

progress_start(max : Int32 | Nil = nil) : Nil

Starts an internal ACON::Helper::ProgressBar, optionally with the provided max amount of steps.

section(message : String) : Nil

Creates a section header with the provided message.

success(messages : String | Enumerable(String)) : Nil

Formats and prints the provided messages within a success block.

table(headers : Enumerable, rows : Enumerable) : Nil

Formats and prints a table based on the provided headers and rows, followed by a new line.

text(messages : String | Enumerable(String)) : Nil

Formats and prints the provided messages as text.

title(message : String) : Nil

Formats and prints message as a title.

warning(messages : String | Enumerable(String)) : Nil

Formats and prints the provided messages within a warning block.