class Console::Terminal::Formatter::Progress

Format a progress event, including the current progress and total.

def bar(value, width)

Render a progress bar with the given value and width. 
def bar(value, width)
	blocks = width * value
	full_blocks = blocks.floor
	partial_block = ((blocks - full_blocks) * BLOCK.size).floor
	
	if partial_block.zero?
		BLOCK.last * full_blocks
	else
		"#{BLOCK.last * full_blocks}#{BLOCK[partial_block]}"
	end.ljust(width)
end

def format(event, stream, verbose: false, width: 80)

@parameter width [Integer] The width of the progress bar.
@parameter verbose [Boolean] Whether to include additional information.
@parameter stream [IO] The stream to write the formatted event to.
@parameter event [Hash] The event to format.

Format the given event. 
def format(event, stream, verbose: false, width: 80)
	current = event[:current].to_f
	total = event[:total].to_f
	value = current / total
	
	# Clamp value to 1.0 to avoid rendering issues:
	if value > 1.0
		value = 1.0
	end
	
	stream.puts "#{@terminal[:progress_bar]}#{self.bar(value, width-10)}#{@terminal.reset} #{sprintf('%6.2f', value * 100)}%"
end

def initialize(terminal)

Parameters:
  • terminal (Terminal::Text) -- The terminal to use for formatting. 
def initialize(terminal)
	@terminal = terminal
	@terminal[:progress_bar] ||= terminal.style(:blue, :white)
end