Class: Bolt::Outputter::Human
- Inherits:
-
Bolt::Outputter
- Object
- Bolt::Outputter
- Bolt::Outputter::Human
- Defined in:
- lib/bolt/outputter/human.rb
Direct Known Subclasses
Constant Summary collapse
- COLORS =
{ dim: "2", # Dim, the other color of the rainbow red: "31", green: "32", yellow: "33", cyan: "36" }.freeze
Instance Method Summary collapse
- #colorize(color, string) ⇒ Object
- #duration_to_string(duration) ⇒ Object
- #enabled? ⇒ Boolean
- #fatal_error(err) ⇒ Object
- #format_log(log) ⇒ Object
- #format_table(results, padding_left = 0, padding_right = 3) ⇒ Object
- #handle_event(event) ⇒ Object
-
#initialize(color, verbose, trace, spin, stream = $stdout) ⇒ Human
constructor
A new instance of Human.
- #plan_logging? ⇒ Boolean
- #print_action_error(error) ⇒ Object
- #print_action_step(step) ⇒ Object
- #print_apply_result(apply_result, elapsed_time) ⇒ Object
- #print_container_finish(event) ⇒ Object
- #print_container_result(result) ⇒ Object
- #print_container_start(image:, **_kwargs) ⇒ Object
- #print_error(message) ⇒ Object
- #print_groups(groups) ⇒ Object
- #print_guide(guide, _topic) ⇒ Object
- #print_head ⇒ Object
- #print_message(message) ⇒ Object
- #print_module_list(module_list) ⇒ Object
- #print_plan_finish(event) ⇒ Object
- #print_plan_info(plan) ⇒ Object
- #print_plan_result(plan_result) ⇒ Object
- #print_plan_start(event) ⇒ Object
- #print_plans(plans, modulepath) ⇒ Object
- #print_prompt(prompt) ⇒ Object
- #print_prompt_error(message) ⇒ Object
- #print_puppetfile_result(success, puppetfile, moduledir) ⇒ Object
- #print_result(result) ⇒ Object
- #print_result_set(result_set) ⇒ Object
- #print_start(target) ⇒ Object
- #print_step_finish(description:, result:, duration:, **_kwargs) ⇒ Object
- #print_step_start(description:, targets:, **_kwargs) ⇒ Object
- #print_summary(results, elapsed_time = nil) ⇒ Object
- #print_target_info(target_list, inventoryfile) ⇒ Object
- #print_targets(target_list, inventoryfile) ⇒ Object
- #print_task_info(task) ⇒ Object
- #print_tasks(tasks, modulepath) ⇒ Object
- #print_topics(topics) ⇒ Object
- #remove_trail(string) ⇒ Object
- #start_spin ⇒ Object
- #stop_spin ⇒ Object
-
#truncate(string, width = 80) ⇒ Object
Trims a string to a specified width, adding an ellipsis if it’s longer.
-
#wrap(string, width = 80) ⇒ Object
Wraps a string to the specified width.
Methods inherited from Bolt::Outputter
Constructor Details
#initialize(color, verbose, trace, spin, stream = $stdout) ⇒ Human
Returns a new instance of Human.
18 19 20 21 22 23 24 25 |
# File 'lib/bolt/outputter/human.rb', line 18 def initialize(color, verbose, trace, spin, stream = $stdout) super # Plans and without_default_logging() calls can both be nested, so we # track each of them with a "stack" consisting of an integer. @plan_depth = 0 @disable_depth = 0 @pinwheel = %w[- \\ | /] end |
Instance Method Details
#colorize(color, string) ⇒ Object
27 28 29 30 31 32 33 |
# File 'lib/bolt/outputter/human.rb', line 27 def colorize(color, string) if @color && @stream.isatty "\033[#{COLORS[color]}m#{string}\033[0m" else string end end |
#duration_to_string(duration) ⇒ Object
661 662 663 664 665 666 667 668 669 670 671 672 673 |
# File 'lib/bolt/outputter/human.rb', line 661 def duration_to_string(duration) hrs = (duration / 3600).floor mins = ((duration % 3600) / 60).floor secs = (duration % 60) if hrs > 0 "#{hrs} hr, #{mins} min, #{secs.round} sec" elsif mins > 0 "#{mins} min, #{secs.round} sec" else # Include 2 decimal places if the duration is under a minute "#{secs.round(2)} sec" end end |
#enabled? ⇒ Boolean
108 109 110 |
# File 'lib/bolt/outputter/human.rb', line 108 def enabled? @disable_depth == 0 end |
#fatal_error(err) ⇒ Object
609 610 611 612 613 614 615 616 617 618 619 620 |
# File 'lib/bolt/outputter/human.rb', line 609 def fatal_error(err) @stream.puts(colorize(:red, err.)) if err.is_a? Bolt::RunFailure @stream.puts ::JSON.pretty_generate(err.result_set) end if @trace && err.backtrace err.backtrace.each do |line| @stream.puts(colorize(:red, "\t#{line}")) end end end |
#format_log(log) ⇒ Object
187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'lib/bolt/outputter/human.rb', line 187 def format_log(log) color = case log['level'] when 'warn' :yellow when 'err' :red end source = "#{log['source']}: " if log['source'] = "#{log['level'].capitalize}: #{source}#{log['message']}" = colorize(color, ) if color end |
#format_table(results, padding_left = 0, padding_right = 3) ⇒ Object
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 |
# File 'lib/bolt/outputter/human.rb', line 277 def format_table(results, padding_left = 0, padding_right = 3) # lazy-load expensive gem code require 'terminal-table' Terminal::Table.new( rows: results, style: { border_x: '', border_y: '', border_i: '', padding_left: padding_left, padding_right: padding_right, border_top: false, border_bottom: false } ) end |
#handle_event(event) ⇒ Object
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 |
# File 'lib/bolt/outputter/human.rb', line 72 def handle_event(event) case event[:type] when :enable_default_output @disable_depth -= 1 when :disable_default_output @disable_depth += 1 when :message (event[:message]) end if enabled? case event[:type] when :node_start print_start(event[:target]) if @verbose when :node_result print_result(event[:result]) if @verbose when :step_start print_step_start(**event) if plan_logging? when :step_finish print_step_finish(**event) if plan_logging? when :plan_start print_plan_start(event) when :plan_finish print_plan_finish(event) when :container_start print_container_start(event) if plan_logging? when :container_finish print_container_finish(event) if plan_logging? when :start_spin start_spin when :stop_spin stop_spin end end end |
#plan_logging? ⇒ Boolean
112 113 114 |
# File 'lib/bolt/outputter/human.rb', line 112 def plan_logging? @plan_depth > 0 end |
#print_action_error(error) ⇒ Object
648 649 650 651 652 653 654 655 656 657 658 659 |
# File 'lib/bolt/outputter/human.rb', line 648 def print_action_error(error) # Running everything through 'wrap' messes with newlines. Separating # into lines and wrapping each individually ensures separate errors are # distinguishable. first, *remaining = error.lines first = colorize(:red, indent(2, "→ #{wrap(first, 76)}")) wrapped = remaining.map { |l| wrap(l) } to_print = wrapped.map { |line| colorize(:red, indent(4, line)) } step = [first, *to_print, "\n"].join @stream.puts(step) end |
#print_action_step(step) ⇒ Object
638 639 640 641 642 643 644 645 646 |
# File 'lib/bolt/outputter/human.rb', line 638 def print_action_step(step) first, *remaining = wrap(step, 76).lines first = indent(2, "→ #{first}") remaining = remaining.map { |line| indent(4, line) } step = [first, *remaining, "\n"].join @stream.puts(step) end |
#print_apply_result(apply_result, elapsed_time) ⇒ Object
573 574 575 |
# File 'lib/bolt/outputter/human.rb', line 573 def print_apply_result(apply_result, elapsed_time) print_summary(apply_result, elapsed_time) end |
#print_container_finish(event) ⇒ Object
220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
# File 'lib/bolt/outputter/human.rb', line 220 def print_container_finish(event) result = if event[:result].is_a?(Bolt::ContainerFailure) event[:result].result else event[:result] end if result.success? @stream.puts(colorize(:green, "Finished: run container '#{result.object}' succeeded.")) else @stream.puts(colorize(:red, "Finished: run container '#{result.object}' failed.")) end print_container_result(result) if @verbose end |
#print_container_result(result) ⇒ Object
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 |
# File 'lib/bolt/outputter/human.rb', line 120 def print_container_result(result) if result.success? @stream.puts(colorize(:green, "Finished running container #{result.object}:")) else @stream.puts(colorize(:red, "Failed running container #{result.object}:")) end if result.error_hash @stream.puts(colorize(:red, remove_trail(indent(2, result.error_hash['msg'])))) return 0 end # Only print results if there's something other than empty string and hash safe_value = result.safe_value if safe_value['stdout'].strip.empty? && safe_value['stderr'].strip.empty? @stream.puts(indent(2, "Running container #{result.object} completed successfully with no result")) else unless safe_value['stdout'].strip && safe_value['stdout'].strip.empty? @stream.puts(indent(2, "STDOUT:")) @stream.puts(indent(4, safe_value['stdout'])) end unless safe_value['stderr'].strip.empty? @stream.puts(indent(2, "STDERR:")) @stream.puts(indent(4, safe_value['stderr'])) end end end |
#print_container_start(image:, **_kwargs) ⇒ Object
216 217 218 |
# File 'lib/bolt/outputter/human.rb', line 216 def print_container_start(image:, **_kwargs) @stream.puts(colorize(:green, "Starting: run container '#{image}'")) end |
#print_error(message) ⇒ Object
626 627 628 |
# File 'lib/bolt/outputter/human.rb', line 626 def print_error() @stream.puts(colorize(:red, )) end |
#print_groups(groups) ⇒ Object
566 567 568 569 570 |
# File 'lib/bolt/outputter/human.rb', line 566 def print_groups(groups) count = "#{groups.count} group#{'s' unless groups.count == 1}" @stream.puts groups.join("\n") @stream.puts colorize(:green, count) end |
#print_guide(guide, _topic) ⇒ Object
454 455 456 |
# File 'lib/bolt/outputter/human.rb', line 454 def print_guide(guide, _topic) @stream.puts(guide) end |
#print_head ⇒ Object
16 |
# File 'lib/bolt/outputter/human.rb', line 16 def print_head; end |
#print_message(message) ⇒ Object
622 623 624 |
# File 'lib/bolt/outputter/human.rb', line 622 def () @stream.puts() end |
#print_module_list(module_list) ⇒ Object
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 |
# File 'lib/bolt/outputter/human.rb', line 458 def print_module_list(module_list) module_list.each do |path, modules| if (mod = modules.find { |m| m[:internal_module_group] }) @stream.puts(colorize(:cyan, mod[:internal_module_group])) else @stream.puts(colorize(:cyan, path)) end if modules.empty? @stream.puts('(no modules installed)') else module_info = modules.map do |m| version = if m[:version].nil? m[:internal_module_group].nil? ? '(no metadata)' : '(built-in)' else m[:version] end [m[:name], version] end @stream.puts format_table(module_info, 2, 1) end @stream.write("\n") end end |
#print_plan_finish(event) ⇒ Object
245 246 247 248 249 250 |
# File 'lib/bolt/outputter/human.rb', line 245 def print_plan_finish(event) @plan_depth -= 1 plan = event[:plan] duration = event[:duration] @stream.puts(colorize(:green, "Finished: plan #{plan} in #{duration_to_string(duration)}")) end |
#print_plan_info(plan) ⇒ Object
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 |
# File 'lib/bolt/outputter/human.rb', line 375 def print_plan_info(plan) params = plan['parameters'].sort info = +'' # Add plan name and description info << colorize(:cyan, "#{plan['name']}\n") info << if plan['description'] indent(2, plan['description'].chomp) else indent(2, 'No description') end info << "\n\n" # Build the usage string usage = +'' usage << if Bolt::Util.powershell? "Invoke-BoltPlan -Name #{plan['name']}" else "bolt plan run #{plan['name']}" end params.each do |name, data| usage << (data.include?('default_value') ? " [#{name}=<value>]" : " #{name}=<value>") end # Add usage info << colorize(:cyan, "Usage\n") info << indent(2, wrap(usage)) info << "\n" # Add parameters, if any if params.any? info << colorize(:cyan, "Parameters\n") params.each do |name, data| info << indent(2, "#{colorize(:yellow, name)} #{colorize(:dim, data['type'])}\n") info << indent(4, "#{wrap(data['description']).chomp}\n") if data['description'] info << indent(4, "Default: #{data['default_value']}\n") unless data['default_value'].nil? info << "\n" end end # Add module location info << colorize(:cyan, "Module\n") info << if plan['module'].start_with?(Bolt::Config::Modulepath::MODULES_PATH) indent(2, 'built-in module') else indent(2, plan['module']) end @stream.puts info end |
#print_plan_result(plan_result) ⇒ Object
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 |
# File 'lib/bolt/outputter/human.rb', line 578 def print_plan_result(plan_result) value = plan_result.value case value when nil @stream.puts("Plan completed successfully with no result") when Bolt::ApplyFailure, Bolt::RunFailure print_result_set(value.result_set) when Bolt::ContainerResult print_container_result(value) when Bolt::ContainerFailure print_container_result(value.result) when Bolt::ResultSet print_result_set(value) else @stream.puts(::JSON.pretty_generate(plan_result, quirks_mode: true)) end end |
#print_plan_start(event) ⇒ Object
235 236 237 238 239 240 241 242 243 |
# File 'lib/bolt/outputter/human.rb', line 235 def print_plan_start(event) @plan_depth += 1 # We use this event to both mark the start of a plan _and_ to enable # plan logging for `apply`, so only log the message if we were called # with a plan if event[:plan] @stream.puts(colorize(:green, "Starting: plan #{event[:plan]}")) end end |
#print_plans(plans, modulepath) ⇒ Object
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 |
# File 'lib/bolt/outputter/human.rb', line 428 def print_plans(plans, modulepath) command = Bolt::Util.powershell? ? 'Get-BoltPlan -Name <PLAN NAME>' : 'bolt plan show <PLAN NAME>' plans = plans.map do |name, description| description = truncate(description, 72) [name, description] end @stream.puts colorize(:cyan, 'Plans') @stream.puts plans.any? ? format_table(plans, 2) : indent(2, 'No available plans') @stream.puts @stream.puts colorize(:cyan, 'Modulepath') @stream.puts indent(2, modulepath.join(File::PATH_SEPARATOR)) @stream.puts @stream.puts colorize(:cyan, 'Additional information') @stream.puts indent(2, "Use '#{command}' to view details and parameters for a specific plan.") end |
#print_prompt(prompt) ⇒ Object
630 631 632 |
# File 'lib/bolt/outputter/human.rb', line 630 def print_prompt(prompt) @stream.print(colorize(:cyan, indent(4, prompt))) end |
#print_prompt_error(message) ⇒ Object
634 635 636 |
# File 'lib/bolt/outputter/human.rb', line 634 def print_prompt_error() @stream.puts(colorize(:red, indent(4, ))) end |
#print_puppetfile_result(success, puppetfile, moduledir) ⇒ Object
601 602 603 604 605 606 607 |
# File 'lib/bolt/outputter/human.rb', line 601 def print_puppetfile_result(success, puppetfile, moduledir) if success @stream.puts("Successfully synced modules from #{puppetfile} to #{moduledir}") else @stream.puts(colorize(:red, "Failed to sync modules from #{puppetfile} to #{moduledir}")) end end |
#print_result(result) ⇒ Object
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 |
# File 'lib/bolt/outputter/human.rb', line 148 def print_result(result) if result.success? @stream.puts(colorize(:green, "Finished on #{result.target.safe_name}:")) else @stream.puts(colorize(:red, "Failed on #{result.target.safe_name}:")) end if result.error_hash @stream.puts(colorize(:red, remove_trail(indent(2, result.error_hash['msg'])))) end if result.is_a?(Bolt::ApplyResult) && @verbose result.resource_logs.each do |log| # Omit low-level info/debug messages next if %w[info debug].include?(log['level']) = format_log(log) @stream.puts(indent(2, )) end end # Only print results if there's something other than empty string and hash if result.value.empty? || (result.value.keys == ['_output'] && !result.) @stream.puts(indent(2, "#{result.action.capitalize} completed successfully with no result")) else # Only print messages that have something other than whitespace if result. @stream.puts(remove_trail(indent(2, result.))) end # Use special handling if the result looks like a command or script result if result.generic_value.keys == %w[stdout stderr merged_output exit_code] safe_value = result.safe_value @stream.puts(indent(2, safe_value['merged_output'])) unless safe_value['merged_output'].strip.empty? elsif result.generic_value.any? @stream.puts(indent(2, ::JSON.pretty_generate(result.generic_value))) end end end |
#print_result_set(result_set) ⇒ Object
596 597 598 599 |
# File 'lib/bolt/outputter/human.rb', line 596 def print_result_set(result_set) result_set.each { |result| print_result(result) } print_summary(result_set) end |
#print_start(target) ⇒ Object
116 117 118 |
# File 'lib/bolt/outputter/human.rb', line 116 def print_start(target) @stream.puts(colorize(:green, "Started on #{target.safe_name}...")) end |
#print_step_finish(description:, result:, duration:, **_kwargs) ⇒ Object
209 210 211 212 213 214 |
# File 'lib/bolt/outputter/human.rb', line 209 def print_step_finish(description:, result:, duration:, **_kwargs) failures = result.error_set.length plural = failures == 1 ? '' : 's' = "Finished: #{description} with #{failures} failure#{plural} in #{duration.round(2)} sec" @stream.puts(colorize(:green, )) end |
#print_step_start(description:, targets:, **_kwargs) ⇒ Object
200 201 202 203 204 205 206 207 |
# File 'lib/bolt/outputter/human.rb', line 200 def print_step_start(description:, targets:, **_kwargs) target_str = if targets.length > 5 "#{targets.count} targets" else targets.map(&:safe_name).join(', ') end @stream.puts(colorize(:green, "Starting: #{description} on #{target_str}")) end |
#print_summary(results, elapsed_time = nil) ⇒ Object
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/bolt/outputter/human.rb', line 252 def print_summary(results, elapsed_time = nil) ok_set = results.ok_set unless ok_set.empty? @stream.puts format('Successful on %<size>d target%<plural>s: %<names>s', size: ok_set.size, plural: ok_set.size == 1 ? '' : 's', names: ok_set.targets.map(&:safe_name).join(',')) end error_set = results.error_set unless error_set.empty? @stream.puts colorize(:red, format('Failed on %<size>d target%<plural>s: %<names>s', size: error_set.size, plural: error_set.size == 1 ? '' : 's', names: error_set.targets.map(&:safe_name).join(','))) end total_msg = format('Ran on %<size>d target%<plural>s', size: results.size, plural: results.size == 1 ? '' : 's') total_msg << " in #{duration_to_string(elapsed_time)}" unless elapsed_time.nil? @stream.puts total_msg end |
#print_target_info(target_list, inventoryfile) ⇒ Object
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 |
# File 'lib/bolt/outputter/human.rb', line 513 def print_target_info(target_list, inventoryfile) adhoc_targets = target_list[:adhoc].map(&:name).to_set inventory_targets = target_list[:inventory].map(&:name).to_set targets = target_list.values.flatten.sort_by(&:name) info = +'' if targets.any? adhoc = colorize(:yellow, " (Not found in inventory file)") targets.each do |target| info << colorize(:cyan, target.name) info << adhoc if adhoc_targets.include?(target.name) info << "\n" info << indent(2, target.detail.to_yaml.lines.drop(1).join) info << "\n" end else info << colorize(:cyan, "Targets\n") info << indent(2, "No targets\n\n") end @stream.puts info print_inventory_summary( inventory_targets.count, adhoc_targets.count, inventoryfile ) end |
#print_targets(target_list, inventoryfile) ⇒ Object
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 |
# File 'lib/bolt/outputter/human.rb', line 486 def print_targets(target_list, inventoryfile) adhoc = colorize(:yellow, "(Not found in inventory file)") targets = [] targets += target_list[:inventory].map { |target| [target.name, nil] } targets += target_list[:adhoc].map { |target| [target.name, adhoc] } info = +'' # Add target list info << colorize(:cyan, "Targets\n") info << if targets.any? format_table(targets, 2, 2).to_s else indent(2, 'No targets') end info << "\n\n" @stream.puts info print_inventory_summary( target_list[:inventory].count, target_list[:adhoc].count, inventoryfile ) end |
#print_task_info(task) ⇒ Object
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 |
# File 'lib/bolt/outputter/human.rb', line 316 def print_task_info(task) params = (task.parameters || []).sort info = +'' # Add task name and description info << colorize(:cyan, "#{task.name}\n") info << if task.description indent(2, task.description.chomp) else indent(2, 'No description') end info << "\n\n" # Build usage string usage = +'' usage << if Bolt::Util.powershell? "Invoke-BoltTask -Name #{task.name} -Targets <targets>" else "bolt task run #{task.name} --targets <targets>" end usage << (Bolt::Util.powershell? ? ' [-Noop]' : ' [--noop]') if task.supports_noop params.each do |name, data| usage << if data['type']&.start_with?('Optional') " [#{name}=<value>]" else " #{name}=<value>" end end # Add usage info << colorize(:cyan, "Usage\n") info << indent(2, wrap(usage)) info << "\n" # Add parameters, if any if params.any? info << colorize(:cyan, "Parameters\n") params.each do |name, data| info << indent(2, "#{colorize(:yellow, name)} #{colorize(:dim, data['type'] || 'Any')}\n") info << indent(4, "#{wrap(data['description']).chomp}\n") if data['description'] info << indent(4, "Default: #{data['default'].inspect}\n") if data.key?('default') info << "\n" end end # Add module location path = task.files.first['path'].chomp("/tasks/#{task.files.first['name']}") info << colorize(:cyan, "Module\n") info << if path.start_with?(Bolt::Config::Modulepath::MODULES_PATH) indent(2, 'built-in module') else indent(2, path) end @stream.puts info end |
#print_tasks(tasks, modulepath) ⇒ Object
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 |
# File 'lib/bolt/outputter/human.rb', line 295 def print_tasks(tasks, modulepath) command = Bolt::Util.powershell? ? 'Get-BoltTask -Task <TASK NAME>' : 'bolt task show <TASK NAME>' tasks = tasks.map do |name, description| description = truncate(description, 72) [name, description] end @stream.puts colorize(:cyan, 'Tasks') @stream.puts tasks.any? ? format_table(tasks, 2) : indent(2, 'No available tasks') @stream.puts @stream.puts colorize(:cyan, 'Modulepath') @stream.puts indent(2, modulepath.join(File::PATH_SEPARATOR)) @stream.puts @stream.puts colorize(:cyan, 'Additional information') @stream.puts indent(2, "Use '#{command}' to view details and parameters for a specific task.") end |
#print_topics(topics) ⇒ Object
448 449 450 451 452 |
# File 'lib/bolt/outputter/human.rb', line 448 def print_topics(topics) ("Available topics are:") (topics.join("\n")) ("\nUse 'bolt guide <TOPIC>' to view a specific guide.") end |
#remove_trail(string) ⇒ Object
53 54 55 |
# File 'lib/bolt/outputter/human.rb', line 53 def remove_trail(string) string.sub(/\s\z/, '') end |
#start_spin ⇒ Object
35 36 37 38 39 40 41 42 43 44 |
# File 'lib/bolt/outputter/human.rb', line 35 def start_spin return unless @spin && @stream.isatty && !@spinning @spinning = true @spin_thread = Thread.new do loop do sleep(0.1) @stream.print(colorize(:cyan, @pinwheel.rotate!.first + "\b")) end end end |
#stop_spin ⇒ Object
46 47 48 49 50 51 |
# File 'lib/bolt/outputter/human.rb', line 46 def stop_spin return unless @spin && @stream.isatty && @spinning @spinning = false @spin_thread.terminate @stream.print("\b") end |
#truncate(string, width = 80) ⇒ Object
Trims a string to a specified width, adding an ellipsis if it’s longer.
67 68 69 70 |
# File 'lib/bolt/outputter/human.rb', line 67 def truncate(string, width = 80) return string unless string.is_a?(String) && string.length > width string.lines.first[0...width].gsub(/\s\w+\s*$/, '...') end |
#wrap(string, width = 80) ⇒ Object
Wraps a string to the specified width. Lines only wrap at whitespace.
60 61 62 63 |
# File 'lib/bolt/outputter/human.rb', line 60 def wrap(string, width = 80) return string unless string.is_a?(String) string.gsub(/(.{1,#{width}})(\s+|\Z)/, "\\1\n") end |