class Samovar::Output::UsageFormatter

Formats and prints usage information to a terminal.

Dispatches on the type of each output object to apply custom formatting rules.

Public Class Methods

Source

# File vendor/bundle/ruby/4.0.0/gems/samovar-2.5.1/lib/samovar/output/usage_formatter.rb, line 39
def initialize(output)
        @output = output
        @width = 80
        
        @terminal = Console::Terminal.for(@output)
        @terminal[:header] = @terminal.style(nil, nil, :bright)
        @terminal[:description] = @terminal.style(:blue)
        @terminal[:error] = @terminal.style(:red)
end

Initialize a new usage formatter.

@parameter rows [Rows] The rows to format. @parameter output [IO] The output stream to print to.

print (rows, output) { |formatter| ... }

Source

# File vendor/bundle/ruby/4.0.0/gems/samovar-2.5.1/lib/samovar/output/usage_formatter.rb, line 27
def self.print(rows, output)
        formatter = self.new(output)
        
        yield formatter if block_given?
        
        formatter.print(rows)
end

Print usage information to the output.

@parameter rows [Rows] The rows to format and print. @parameter output [IO] The output stream to print to. @yields {|formatter| …} Optional block to customize the formatter.

Public Instance Methods

map (object, *arguments, first: true)

Source

# File vendor/bundle/ruby/4.0.0/gems/samovar-2.5.1/lib/samovar/output/usage_formatter.rb, line 53
def map(object, *arguments, first: true)
        case object
        when InvalidInputError
                # This is a little hack which avoids printing out "--help" if it was part of an incomplete parse. In the future I'd prefer if this was handled explicitly.
                @terminal.puts("#{object.message} in:", style: :error) unless object.help?
        when MissingValueError
                @terminal.puts("#{object.message} in:", style: :error)
        when Header
                header, rows = object, arguments.first
                
                if first
                        first = false
                else
                        @terminal.puts
                end
                
                command_line = header.object.command_line(header.name)
                @terminal.puts "#{rows.indentation}#{command_line}", style: :header
                
                if description = header.object.description
                        @terminal.puts "#{rows.indentation}\t#{description}", style: :description
                        @terminal.puts
                end
        when Row
                row, rows = object, arguments.first
                @terminal.puts "#{rows.indentation}#{row.align(rows.columns)}"
        when Rows
                object.each do |row, rows|
                        first = map(row, rows, first: first)
                end
        else
                raise ArgumentError, "Unable to format #{object.class}!"
        end
        
        return first
end

Format and print the given object according to its type.

@parameter object [Object] The object to format (a {Rows}, {Row}, {Header}, or error). @parameter arguments [Array] Extra context passed through to nested rows (the containing {Rows}).

print (rows, first: true)

Source

# File vendor/bundle/ruby/4.0.0/gems/samovar-2.5.1/lib/samovar/output/usage_formatter.rb, line 91
def print(rows, first: true)
        map(rows, first: first)
end

Print the formatted usage output.