Module: GHI::Formatting
Defined Under Namespace
Modules: Colors
Constant Summary
collapse
- CURSOR =
{
:up => lambda { |n| "\e[#{n}A" },
:column => lambda { |n| "\e[#{n}G" },
:hide => "\e[?25l",
:show => "\e[?25h"
}
- THROBBERS =
[
%w(⠋ ⠙ ⠹ ⠸ ⠼ ⠴ ⠦ ⠧ ⠇ ⠏),
%w(⠋ ⠙ ⠚ ⠞ ⠖ ⠦ ⠴ ⠲ ⠳ ⠓),
%w(⠄ ⠆ ⠇ ⠋ ⠙ ⠸ ⠰ ⠠ ⠰ ⠸ ⠙ ⠋ ⠇ ⠆ ),
%w(⠋ ⠙ ⠚ ⠒ ⠂ ⠂ ⠒ ⠲ ⠴ ⠦ ⠖ ⠒ ⠐ ⠐ ⠒ ⠓ ⠋),
%w(⠁ ⠉ ⠙ ⠚ ⠒ ⠂ ⠂ ⠒ ⠲ ⠴ ⠤ ⠄ ⠄ ⠤ ⠴ ⠲ ⠒ ⠂ ⠂ ⠒ ⠚ ⠙ ⠉ ⠁),
%w(⠈ ⠉ ⠋ ⠓ ⠒ ⠐ ⠐ ⠒ ⠖ ⠦ ⠤ ⠠ ⠠ ⠤ ⠦ ⠖ ⠒ ⠐ ⠐ ⠒ ⠓ ⠋ ⠉ ⠈),
%w(⠁ ⠁ ⠉ ⠙ ⠚ ⠒ ⠂ ⠂ ⠒ ⠲ ⠴ ⠤ ⠄ ⠄ ⠤ ⠠ ⠠ ⠤ ⠦ ⠖ ⠒ ⠐ ⠐ ⠒ ⠓ ⠋ ⠉ ⠈ ⠈ ⠉)
Constants included
from Colors
Colors::ANSI, Colors::WEB
Class Attribute Summary collapse
Instance Attribute Summary collapse
Instance Method Summary
collapse
-
#columns ⇒ Object
-
#dimensions ⇒ Object
-
#format_comment(c, width = columns) ⇒ Object
-
#format_comment_editor(issue, comment = nil) ⇒ Object
-
#format_comments_and_events(elements) ⇒ Object
-
#format_date(date, suffix = true) ⇒ Object
-
#format_editor(issue = nil) ⇒ Object
– TODO: DRY up editor formatters.
-
#format_event(e, width = columns) ⇒ Object
-
#format_event_type(event) ⇒ Object
-
#format_issue(i, width = columns) ⇒ Object
TODO: Show milestone, number of comments, pull request attached.
-
#format_issues(issues, include_repo) ⇒ Object
-
#format_issues_header ⇒ Object
-
#format_labels(labels) ⇒ Object
-
#format_markdown(string, indent = 4) ⇒ Object
-
#format_milestone(m, width = columns) ⇒ Object
-
#format_milestone_editor(milestone = nil) ⇒ Object
-
#format_milestones(milestones) ⇒ Object
-
#format_number(n) ⇒ Object
-
#format_state(state, string = state, layer = :fg) ⇒ Object
-
#format_tag(tag) ⇒ Object
-
#format_username(username) ⇒ Object
– Specific formatters: ++.
-
#indent(string, level = 4, maxwidth = columns) ⇒ Object
-
#page(header = nil, throttle = 0) ⇒ Object
-
#paginate? ⇒ Boolean
-
#paging? ⇒ Boolean
-
#past_due?(milestone) ⇒ Boolean
-
#percent(milestone, string = nil) ⇒ Object
-
#puts(*strings) ⇒ Object
-
#throb(position = 0, redraw = ) ⇒ Object
-
#truncate(string, reserved) ⇒ Object
Methods included from Colors
#bg, #blink, #bright, #colorize?, colorize?, #fg, #highlight, #inverse, #no_color, #to_hex, #underline
Class Attribute Details
.paginate ⇒ Object
Returns the value of attribute paginate.
8
9
10
|
# File 'lib/ghi/formatting.rb', line 8
def paginate
@paginate
end
|
Instance Attribute Details
#paging ⇒ Object
Returns the value of attribute paging.
12
13
14
|
# File 'lib/ghi/formatting.rb', line 12
def paging
@paging
end
|
Instance Method Details
#columns ⇒ Object
105
106
107
|
# File 'lib/ghi/formatting.rb', line 105
def columns
dimensions[1] || 80
end
|
#dimensions ⇒ Object
109
110
111
|
# File 'lib/ghi/formatting.rb', line 109
def dimensions
`stty size 2>/dev/null`.chomp.split(' ').map { |n| n.to_i }
end
|
254
255
256
257
258
259
260
261
262
|
# File 'lib/ghi/formatting.rb', line 254
def c, width = columns
<<EOF
@#{c['user']['login']} commented \
#{format_date DateTime.parse(c['created_at'])}:
#{indent c['body'], 4, width}
EOF
end
|
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
|
# File 'lib/ghi/formatting.rb', line 413
def issue, = nil
message = ERB.new(<<EOF).result binding
Leave a comment. Trailing lines starting with '#' (like these) will be ignored,
and empty messages will not be submitted. Comments are formatted with GitHub
Flavored Markdown (GFM):
http://github.github.com/github-flavored-markdown
On <%= repo %> issue #<%= issue['number'] %>
<%= no_color { format_issue issue } if verbose %>\
<%= no_color { format_comment comment, columns - 2 } if comment %>
EOF
message.rstrip!
message.gsub!(/(?!\A)^.*$/) { |line| "# #{line}".rstrip }
message.insert 0, ['body'] if
message
end
|
243
244
245
246
247
248
249
250
251
252
|
# File 'lib/ghi/formatting.rb', line 243
def format_comments_and_events elements
return 'None.' if elements.empty?
elements.map do |element|
if event = element['event']
format_event(element) unless unimportant_event?(event)
else
(element)
end
end.compact
end
|
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
|
# File 'lib/ghi/formatting.rb', line 474
def format_date date, suffix = true
days = (interval = DateTime.now - date).to_i.abs
string = if days.zero?
seconds, _ = interval.divmod Rational(1, 86400)
hours, seconds = seconds.divmod 3600
minutes, seconds = seconds.divmod 60
if hours > 0
"#{hours} hour#{'s' unless hours == 1}"
elsif minutes > 0
"#{minutes} minute#{'s' unless minutes == 1}"
else
"#{seconds} second#{'s' unless seconds == 1}"
end
else
"#{days} day#{'s' unless days == 1}"
end
ago = interval < 0 ? 'from now' : 'ago' if suffix
[string, ago].compact.join ' '
end
|
– TODO: DRY up editor formatters. ++
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
|
# File 'lib/ghi/formatting.rb', line 367
def format_editor issue = nil
message = ERB.new(<<EOF).result binding
Please explain the issue. The first line will become the title. Trailing
lines starting with '#' (like these) will be ignored, and empty messages will
not be submitted. Issues are formatted with GitHub Flavored Markdown (GFM):
http://github.github.com/github-flavored-markdown
On <%= repo %>
<%= no_color { format_issue issue, columns - 2 if issue } %>
EOF
message.rstrip!
message.gsub!(/(?!\A)^.*$/) { |line|
"# #{line}".rstrip
}
message.insert 0, "\n"
message.insert 0, [
issue['title'] || issue[:title], issue['body'] || issue[:body]
].compact.join("\n\n") if issue
message
end
|
264
265
266
267
268
269
270
271
272
|
# File 'lib/ghi/formatting.rb', line 264
def format_event e, width = columns
reference = e['commit_id']
<<EOF
#{bright { '⁕' }} #{format_event_type(e['event'])} by @#{e['actor']['login']}\
#{" through #{underline { reference[0..6] }}" if reference} \
#{format_date DateTime.parse(e['created_at'])}
EOF
end
|
349
350
351
352
353
354
355
356
357
358
|
# File 'lib/ghi/formatting.rb', line 349
def format_event_type(event)
color_codes = {
'reopened' => '2cc200',
'closed' => 'ff0000',
'merged' => '9677b1',
'assigned' => 'e1811d',
'referenced' => 'aaaaaa'
}
fg(color_codes[event]) { event }
end
|
TODO: Show milestone, number of comments, pull request attached.
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
|
# File 'lib/ghi/formatting.rb', line 211
def format_issue i, width = columns
return unless i['created_at']
ERB.new(<<EOF).result binding
<% p = i['pull_request']['html_url'] %>\
<%= bright { no_color { indent '%s%s: %s' % [p ? '↑' : '#', \
*i.values_at('number', 'title')], 0, width } } %>
@<%= i['user']['login'] %> opened this <%= p ? 'pull request' : 'issue' %> \
<%= format_date DateTime.parse(i['created_at']) %>. \
<% if i['merged'] %><%= format_state 'merged', format_tag('merged'), :bg %><% end %> \
<%= format_state i['state'], format_tag(i['state']), :bg %> \
<% unless i['comments'] == 0 %>\
<%= fg('aaaaaa'){
template = "%d comment"
template << "s" unless i['comments'] == 1
'(' << template % i['comments'] << ')'
} %>\
<% end %>\
<% if i['assignee'] || !i['labels'].empty? %>
<% if i['assignee'] %>@<%= i['assignee']['login'] %> is assigned. <% end %>\
<% unless i['labels'].empty? %><%= format_labels(i['labels']) %><% end %>\
<% end %>\
<% if i['milestone'] %>
Milestone #<%= i['milestone']['number'] %>: <%= i['milestone']['title'] %>\
<%= " \#{bright{fg(:yellow){'⚠'}}}" if past_due? i['milestone'] %>\
<% end %>
<% if i['body'] && !i['body'].empty? %>
<%= indent i['body'], 4, width %>
<% end %>
EOF
end
|
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
|
# File 'lib/ghi/formatting.rb', line 170
def format_issues issues, include_repo
return 'None.' if issues.empty?
include_repo and issues.each do |i|
%r{/repos/[^/]+/([^/]+)} === i['url'] and i['repo'] = $1
end
nmax, rmax = %w(number repo).map { |f|
issues.sort_by { |i| i[f].to_s.size }.last[f].to_s.size
}
issues.map { |i|
n, title, labels = i['number'], i['title'], i['labels']
l = 9 + nmax + rmax + no_color { format_labels labels }.to_s.length
a = i['assignee']
a_is_me = a && a['login'] == Authorization.username
l += a['login'].to_s.length + 2 if a
p = i['pull_request']['html_url'] and l += 2 if i['pull_request']
c = i['comments']
l += c.to_s.length + 1 unless c == 0
m = i['milestone']
[
" ",
(i['repo'].to_s.rjust(rmax) if i['repo']),
format_number(n.to_s.rjust(nmax)),
truncate(title, l),
(format_labels(labels) unless assigns[:dont_print_labels]),
(fg(:green) { m['title'] } if m),
(fg('aaaaaa') { c } unless c == 0),
(fg('aaaaaa') { '↑' } if p),
(fg(a_is_me ? :yellow : :gray) { "@#{a['login']}" } if a),
(fg('aaaaaa') { '‡' } if m)
].compact.join ' '
}
end
|
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
|
# File 'lib/ghi/formatting.rb', line 121
def
state = assigns[:state] ||= 'open'
org = assigns[:org] ||= nil
= "# #{repo || org || 'Global,'} #{state} issues"
if repo
if milestone = assigns[:milestone]
case milestone
when '*' then << ' with a milestone'
when 'none' then << ' without a milestone'
else
.sub! repo, "#{repo} milestone ##{milestone}"
end
end
if assignee = assigns[:assignee]
<< case assignee
when '*' then ', assigned'
when 'none' then ', unassigned'
else
", assigned to #{format_username assignee}"
end
end
if mentioned = assigns[:mentioned]
<< ", mentioning #{format_username mentioned}"
end
else
<< case assigns[:filter]
when 'created' then ' you created'
when 'mentioned' then ' that mention you'
when 'subscribed' then " you're subscribed to"
when 'all' then ' that you can see'
else
' assigned to you'
end
end
if creator = assigns[:creator]
<< " #{format_username creator} created"
end
if labels = assigns[:labels]
<< ", labeled #{labels.gsub ',', ', '}"
end
if excluded_labels = assigns[:exclude_labels]
<< ", excluding those labeled #{excluded_labels.gsub ',', ', '}"
end
if sort = assigns[:sort]
<< ", by #{sort} #{reverse ? 'ascending' : 'descending'}"
end
format_state assigns[:state],
end
|
340
341
342
343
|
# File 'lib/ghi/formatting.rb', line 340
def format_labels labels
return if labels.empty?
[*labels].map { |l| bg(l['color']) { format_tag l['name'] } }.join ' '
end
|
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
|
# File 'lib/ghi/formatting.rb', line 433
def format_markdown string, indent = 4
c = '268bd2'
string.gsub!(/^( {#{indent}}\#{1,6} .+)$/, bright{'\1'})
string.gsub!(
/(^ {#{indent}}.+$\n^ {#{indent}}[-=]+$)/, bright{'\1'}
)
string.gsub!(
/(^|\s)(\*{2}\w(?:[^*]*\w)?\*{2})(\s|$)/m, '\1' + bright{'\2'} + '\3'
)
string.gsub!(
/(^|\s)(_{2}\w(?:[^_]*\w)?_{2})(\s|$)/m, '\1' + bright {'\2'} + '\3'
)
string.gsub!(
/(^|\s)(\*\w(?:[^*]*\w)?\*)(\s|$)/m, '\1' + underline{'\2'} + '\3'
)
string.gsub!(
/(^|\s)(_\w(?:[^_]*\w)?_)(\s|$)/m, '\1' + underline{'\2'} + '\3'
)
string.gsub!(/(^ {#{indent}}(?:[*>-]|\d+\.) )/, fg(c){'\1'})
string.gsub!(
%r{\b(<)?(https?://\S+|[^@\s]+@[^@\s]+)(>)?\b},
fg(c){'\1' + underline{'\2'} + '\3'}
)
string.gsub!(/`([^`].+?)`(?=[^`])/, inverse { ' \1 ' })
string.gsub!(/(?<indent>^\ {#{indent}})(```)\s*(?<lang>\w*$)(\n)(?<code>.+?)(\n)(^\ {#{indent}}```$)/m) do |m|
highlight(Regexp.last_match)
end
string
end
|
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
|
# File 'lib/ghi/formatting.rb', line 290
def format_milestone m, width = columns
ERB.new(<<EOF).result binding
<%= bright { no_color { \
indent '#%s: %s' % m.values_at('number', 'title'), 0, width } } %>
@<%= m['creator']['login'] %> created this milestone \
<%= format_date DateTime.parse(m['created_at']) %>. \
<%= format_state m['state'], format_tag(m['state']), :bg %>
<% if m['due_on'] %>\
<% due_on = DateTime.parse m['due_on'] %>\
<% if past_due? m %>\
<%= bright{fg(:yellow){"⚠"}} %> \
<%= bright{fg(:red){"Past due by \#{format_date due_on, false}."}} %>
<% else %>\
Due in <%= format_date due_on, false %>.
<% end %>\
<% end %>\
<%= percent m %>
<% if m['description'] && !m['description'].empty? %>
<%= indent m['description'], 4, width %>
<% end %>
EOF
end
|
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
|
# File 'lib/ghi/formatting.rb', line 392
def format_milestone_editor milestone = nil
message = ERB.new(<<EOF).result binding
Describe the milestone. The first line will become the title. Trailing lines
starting with '#' (like these) will be ignored, and empty messages will not be
submitted. Milestones are formatted with GitHub Flavored Markdown (GFM):
http://github.github.com/github-flavored-markdown
On <%= repo %>
<%= no_color { format_milestone milestone, columns - 2 } if milestone %>
EOF
message.rstrip!
message.gsub!(/(?!\A)^.*$/) { |line| "# #{line}".rstrip }
message.insert 0, [
milestone['title'], milestone['description']
].join("\n\n") if milestone
message
end
|
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
# File 'lib/ghi/formatting.rb', line 274
def format_milestones milestones
return 'None.' if milestones.empty?
max = milestones.sort_by { |m|
m['number'].to_s.size
}.last['number'].to_s.size
milestones.map { |m|
line = [" #{m['number'].to_s.rjust max }:"]
space = past_due?(m) ? 6 : 4
line << truncate(m['title'], max + space)
line << '⚠' if past_due? m
percent m, line.join(' ')
}
end
|
206
207
208
|
# File 'lib/ghi/formatting.rb', line 206
def format_number n
colorize? ? "#{bright { n }}:" : "#{n} "
end
|
331
332
333
334
335
336
337
338
|
# File 'lib/ghi/formatting.rb', line 331
def format_state state, string = state, layer = :fg
color_codes = {
'closed' => 'ff0000',
'open' => '2cc200',
'merged' => '511c7d',
}
send(layer, color_codes[state]) { string }
end
|
345
346
347
|
# File 'lib/ghi/formatting.rb', line 345
def format_tag tag
(colorize? ? ' %s ' : '[%s]') % tag
end
|
– Specific formatters: ++
117
118
119
|
# File 'lib/ghi/formatting.rb', line 117
def format_username username
username == Authorization.username ? 'you' : username
end
|
#indent(string, level = 4, maxwidth = columns) ⇒ Object
94
95
96
97
98
99
100
101
102
103
|
# File 'lib/ghi/formatting.rb', line 94
def indent string, level = 4, maxwidth = columns
string = string.gsub(/\r/, '')
string.gsub!(/[\t ]+$/, '')
string.gsub!(/\n{3,}/, "\n\n")
width = maxwidth - level - 1
lines = string.scan(
/.{0,#{width}}(?:\s|\Z)|[\S]{#{width},}/ ).map { |line| " " * level + line.chomp }
format_markdown lines.join("\n").rstrip, level
end
|
#page(header = nil, throttle = 0) ⇒ Object
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
|
# File 'lib/ghi/formatting.rb', line 47
def page = nil, throttle = 0
if paginate?
= GHI.config('ghi.pager') || GHI.config('core.pager')
||= ENV['PAGER']
||= 'less'
+= ' -EKRX -b1' if =~ /^less( -[EKRX]+)?$/
if && !.empty? && != 'cat'
$stdout = IO.popen , 'w'
end
puts if
self.paging = true
end
loop do
yield
sleep throttle
end
rescue Errno::EPIPE
exit
ensure
unless $stdout == STDOUT
$stdout.close_write
$stdout = STDOUT
print CURSOR[:show]
exit
end
end
|
#paginate? ⇒ Boolean
77
78
79
|
# File 'lib/ghi/formatting.rb', line 77
def paginate?
($stdout.tty? && $stdout == STDOUT && Formatting.paginate) || paging?
end
|
#paging? ⇒ Boolean
81
82
83
|
# File 'lib/ghi/formatting.rb', line 81
def paging?
!!paging
end
|
#past_due?(milestone) ⇒ Boolean
314
315
316
317
|
# File 'lib/ghi/formatting.rb', line 314
def past_due? milestone
return false unless milestone['due_on']
DateTime.parse(milestone['due_on']) <= DateTime.now
end
|
#percent(milestone, string = nil) ⇒ Object
319
320
321
322
323
324
325
326
327
328
329
|
# File 'lib/ghi/formatting.rb', line 319
def percent milestone, string = nil
open, closed = milestone.values_at('open_issues', 'closed_issues')
complete = closed.to_f / (open + closed)
complete = 0 if complete.nan?
i = (columns * complete).round
if string.nil?
string = ' %d%% (%d closed, %d open)' % [complete * 100, closed, open]
end
string = string.ljust columns
[bg('2cc200'){string[0, i]}, string[i, columns - i]].join
end
|
#puts(*strings) ⇒ Object
34
35
36
37
38
39
40
41
42
43
44
45
|
# File 'lib/ghi/formatting.rb', line 34
def puts *strings
strings = strings.flatten.map { |s|
s.gsub(/(^| *)@(\w+)/) {
if $2 == Authorization.username
bright { fg(:yellow) { "#$1@#$2" } }
else
bright { "#$1@#$2" }
end
}
}
super strings
end
|
#throb(position = 0, redraw = ) ⇒ Object
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
|
# File 'lib/ghi/formatting.rb', line 494
def throb position = 0, redraw = CURSOR[:up][1]
return yield unless paginate?
throb = THROBBERS[rand(THROBBERS.length)]
throb.reverse! if rand > 0.5
i = rand throb.length
thread = Thread.new do
dot = lambda do
print "\r#{CURSOR[:column][position]}#{throb[i]}#{CURSOR[:hide]}"
i = (i + 1) % throb.length
sleep 0.1 and dot.call
end
dot.call
end
yield
ensure
if thread
thread.kill
puts "\r#{CURSOR[:column][position]}#{redraw}#{CURSOR[:show]}"
end
end
|
#truncate(string, reserved) ⇒ Object
85
86
87
88
89
90
91
92
|
# File 'lib/ghi/formatting.rb', line 85
def truncate string, reserved
return string unless paginate?
space=columns - reserved
space=5 if space < 5
result = string.scan(/.{0,#{space}}(?:\s|\Z)/).first.strip
result << "..." if result != string
result
end
|