generated from athena-framework/component-template
-
Notifications
You must be signed in to change notification settings - Fork 1
/
athena.cr
426 lines (356 loc) · 11.7 KB
/
athena.cr
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
require "./output"
# Default implementation of `ACON::Style::Interface` that provides a slew of helpful methods for formatting output.
#
# Uses `ACON::Helper::AthenaQuestion` to improve the appearance of questions.
#
# ```
# protected def execute(input : ACON::Input::Interface, output : ACON::Output::Interface) : ACON::Command::Status
# style = ACON::Style::Athena.new input, output
#
# style.title "Some Fancy Title"
#
# # ...
#
# ACON::Command::Status::SUCCESS
# end
# ```
class Athena::Console::Style::Athena < Athena::Console::Style::Output
private MAX_LINE_LENGTH = 120
protected getter question_helper : ACON::Helper::Question { ACON::Helper::AthenaQuestion.new }
@input : ACON::Input::Interface
@buffered_output : ACON::Output::SizedBuffer
@line_length : Int32
def initialize(@input : ACON::Input::Interface, output : ACON::Output::Interface)
width = ACON::Terminal.new.width || MAX_LINE_LENGTH
@buffered_output = ACON::Output::SizedBuffer.new {{flag?(:windows) ? 4 : 2}}, output.verbosity, false, output.formatter.dup
@line_length = Math.min(width - {{flag?(:windows) ? 1 : 0}}, MAX_LINE_LENGTH)
super output
end
# :inherit:
def ask(question : String, default : _)
self.ask ACON::Question.new question, default
end
# :ditto:
def ask(question : ACON::Question::Base)
if @input.interactive?
self.auto_prepend_block
end
answer = self.question_helper.ask @input, self, question
if @input.interactive?
self.new_line
@buffered_output.print "\n"
end
answer
end
# :inherit:
def ask_hidden(question : String)
question = ACON::Question(String?).new question, nil
question.hidden = true
self.ask question
end
# Helper method for outputting blocks of *messages* that powers the `#caution`, `#success`, `#note`, etc. methods.
# It includes various optional parameters that can be used to print customized blocks.
#
# If *type* is provided, its value will be printed within `[]`. E.g. `[TYPE]`.
#
# If *style* is provided, each of the *messages* will be printed in that style.
#
# *prefix* represents what each of the *messages* should be prefixed with.
#
# If *padding* is `true`, empty lines will be added before/after the block.
#
# If *escape* is `true`, each of the *messages* will be escaped via `ACON::Formatter::Output.escape`.
def block(messages : String | Enumerable(String), type : String? = nil, style : String? = nil, prefix : String = " ", padding : Bool = false, escape : Bool = true) : Nil
messages = messages.is_a?(Enumerable(String)) ? messages : {messages}
self.auto_prepend_block
self.puts self.create_block(messages, type, style, prefix, padding, escape)
self.new_line
end
# :inherit:
#
# ```text
# !
# ! [CAUTION] Some Message
# !
# ```
#
# White text on a 3 line red background block with an empty line above/below the block.
def caution(messages : String | Enumerable(String)) : Nil
self.block messages, "CAUTION", "fg=white;bg=red", " ! ", true
end
# :inherit:
#
# ```text
# ----- -------
# Foo Bar
# ----- -------
# Biz Baz
# 12 false
# ----- -------
#
# ```
def table(headers : Enumerable, rows : Enumerable) : Nil
self.create_table
.headers(headers)
.rows(rows)
.render
self.new_line
end
# Sames as `#table`, but horizontal
def horizontal_table(headers : Enumerable, rows : Enumerable) : Nil
self.create_table
.headers(headers)
.rows(rows)
.horizontal
.render
self.new_line
end
# Sames as `#table`, but vertical
def vertical_table(headers : Enumerable, rows : Enumerable) : Nil
self.create_table
.headers(headers)
.rows(rows)
.vertical
.render
self.new_line
end
# Formats a list of key/value pairs horizontally.
#
# TODO: `Mappable` when/if https://github.com/crystal-lang/crystal/issues/10886 is implemented.
def definition_list(*rows : String | ACON::Helper::Table::Separator | Enumerable({K, V})) : Nil forall K, V
table_headers = [] of String | ACON::Helper::Table::Cell
table_row = [] of String | ACON::Helper::Table::Cell | Nil
rows.each do |row|
case row
in String
table_headers << ACON::Helper::Table::Cell.new row, colspan: 2
table_row << nil
in ACON::Helper::Table::Cell
table_headers << row
table_row << row
in Enumerable
table_headers << row.first_key.to_s
table_row << row.first_value.to_s
end
end
self.horizontal_table table_headers, {table_row}
end
# Creates and returns an Athena styled `ACON::Helper::Table` instance.
def create_table : ACON::Helper::Table
style = ACON::Helper::Table.style_definition("suggested").clone
style.cell_header_format "<info>%s</info>"
ACON::Helper::Table.new(
(output = @output).is_a?(ACON::Output::ConsoleOutputInterface) ? output.section : @output
)
.style(style)
end
# :inherit:
def choice(question : String, choices : Indexable | Hash, default = nil)
self.ask ACON::Question::Choice.new question, choices, default
end
# :inherit:
#
# ```text
# // Some Message
# ```
#
# White text with one empty line above/below the message(s).
def comment(messages : String | Enumerable(String)) : Nil
self.block messages, prefix: "<fg=default;bg=default> // </>", escape: false
end
# :inherit:
def confirm(question : String, default : Bool = true) : Bool
self.ask ACON::Question::Confirmation.new question, default
end
# :inherit:
#
# ```text
# [ERROR] Some Message
# ```
#
# White text on a 3 line red background block with an empty line above/below the block.
def error(messages : String | Enumerable(String)) : Nil
self.block messages, "ERROR", "fg=white;bg=red", padding: true
end
# Returns a new instance of `self` that outputs to the error output.
def error_style : self
self.class.new @input, self.error_output
end
# :inherit:
#
# ```text
# [INFO] Some Message
# ```
#
# Green text with two empty lines above/below the message(s).
def info(messages : String | Enumerable(String)) : Nil
self.block messages, "INFO", "fg=green", padding: true
end
# :inherit:
#
# ```text
# * Item 1
# * Item 2
# * Item 3
# ```
#
# White text with one empty line above/below the list.
def listing(elements : Enumerable) : Nil
self.auto_prepend_text
elements.each do |element|
self.puts " * #{element}"
end
self.new_line
end
# :ditto:
def listing(*elements : String) : Nil
self.listing elements
end
# :inherit:
def new_line(count : Int32 = 1) : Nil
super
@buffered_output.print "\n" * count
end
# :inherit:
#
# ```text
# ! [NOTE] Some Message
# ```
#
# Green text with one empty line above/below the message(s).
def note(messages : String | Enumerable(String)) : Nil
self.block messages, "NOTE", "fg=yellow", " ! "
end
# :inherit:
def puts(messages : String | Enumerable(String), verbosity : ACON::Output::Verbosity = :normal, output_type : ACON::Output::Type = :normal) : Nil
messages = messages.is_a?(String) ? {messages} : messages
messages.each do |message|
super message, verbosity, output_type
self.write_buffer message, true, verbosity, output_type
end
end
# :inherit:
def print(messages : String | Enumerable(String), verbosity : ACON::Output::Verbosity = :normal, output_type : ACON::Output::Type = :normal) : Nil
messages = messages.is_a?(String) ? {messages} : messages
messages.each do |message|
super message, verbosity, output_type
self.write_buffer message, false, verbosity, output_type
end
end
# :inherit:
#
# ```text
# Some Message
# ------------
# ```
#
# Orange text with one empty line above/below the section.
def section(message : String) : Nil
self.auto_prepend_block
self.puts "<comment>#{ACON::Formatter::Output.escape_trailing_backslash message}</>"
self.puts %(<comment>#{"-" * ACON::Helper.width(ACON::Helper.remove_decoration(self.formatter, message))}</>)
self.new_line
end
# :inherit:
#
# ```text
# [OK] Some Message
# ```
#
# Black text on a 3 line green background block with an empty line above/below the block.
def success(messages : String | Enumerable(String)) : Nil
self.block messages, "OK", "fg=black;bg=green", padding: true
end
# def table(headers : Enumerable, rows : Enumerable(Enumerable)) : Nil
# end
# :inherit:
#
# Same as `#puts` but indented one space and an empty line above the message(s).
def text(messages : String | Enumerable(String)) : Nil
self.auto_prepend_text
messages = messages.is_a?(Enumerable(String)) ? messages : {messages}
messages.each do |message|
self.puts " #{message}"
end
end
# :inherit:
#
# ```text
# Some Message
# ============
# ```
#
# Orange text with one empty line above/below the title.
def title(message : String) : Nil
self.auto_prepend_block
self.puts "<comment>#{ACON::Formatter::Output.escape_trailing_backslash message}</>"
self.puts %(<comment>#{"=" * ACON::Helper.width(ACON::Helper.remove_decoration(self.formatter, message))}</>)
self.new_line
end
# :inherit:
#
# ```text
# [WARNING] Some Message
# ```
#
# Black text on a 3 line orange background block with an empty line above/below the block.
def warning(messages : String | Enumerable(String)) : Nil
self.block messages, "WARNING", "fg=black;bg=yellow", padding: true
end
# def progress_start(max : Int32 = 0) : Nil
# end
# def progress_advance(step : Int32 = 1) : Nil
# end
# def progress_finish : Nil
# end
private def auto_prepend_block : Nil
chars = @buffered_output.fetch
if chars.empty?
return self.new_line
end
self.new_line 2 - chars.count '\n'
end
private def auto_prepend_text : Nil
fetched = @buffered_output.fetch
self.new_line unless fetched.ends_with? "\n"
end
private def create_block(messages : Enumerable(String), type : String? = nil, style : String? = nil, prefix : String = " ", padding : Bool = false, escape : Bool = true) : Array(String)
indent_length = 0
prefix_length = ACON::Helper.width ACON::Helper.remove_decoration self.formatter, prefix
lines = [] of String
unless type.nil?
type = "[#{type}] "
indent_length = type.size
line_indentation = " " * indent_length
end
messages.each_with_index do |message, idx|
message = ACON::Formatter::Output.escape message if escape
decoration_length = ACON::Helper.width(message) - ACON::Helper.width(ACON::Helper.remove_decoration(self.formatter, message))
message_line_length = Math.min(@line_length - prefix_length - indent_length + decoration_length, @line_length)
message.gsub(/(.{1,#{message_line_length}})( +|$\n?)|(.{1,#{message_line_length}})/, "\\0\n").split "\n", remove_empty: true do |match|
lines << match.strip
end
lines << "" if messages.size > 1 && idx < (messages.size - 1)
end
first_line_index = 0
if padding && self.decorated?
first_line_index = 1
lines.unshift ""
lines << ""
end
lines.map_with_index do |line, idx|
unless type.nil?
line = first_line_index == idx ? "#{type}#{line}" : "#{line_indentation}#{line}"
end
line = "#{prefix}#{line}"
line += " " * Math.max @line_length - ACON::Helper.width(ACON::Helper.remove_decoration(self.formatter, line)), 0
if style
line = "<#{style}>#{line}</>"
end
line
end
end
private def write_buffer(message : String | Enumerable(String), new_line : Bool, verbosity : ACON::Output::Verbosity = :normal, output_type : ACON::Output::Type = :normal) : Nil
@buffered_output.write message, new_line, verbosity, output_type
end
end