class Console::Terminal::Formatter::Progress

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

Constants

BLOCK: The block characters used to render the progress bar.
KEY: The key used to identify this formatter.

Public Class Methods

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/terminal/formatter/progress.rb, line 30
def initialize(terminal)
        @terminal = terminal
        @terminal[:progress_bar] ||= terminal.style(:blue, :white)
end

Create a new progress formatter.

@param terminal [Terminal::Text] The terminal to use for formatting.

Public Instance Methods

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

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/terminal/formatter/progress.rb, line 41
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

Format the given event.

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