class Console::Output::Terminal

Represents a terminal output, and formats log messages for display.

Constants

CONSOLE_START_AT: The environment variable used to store the start time of the console terminal output.
UNKNOWN: The default severity for log messages, if not specified.

Attributes

start [R]

@attribute [Time] The start time of the terminal output.

stream [R]

@attribute [IO] The output stream.

terminal [R]

@attribute [Console::Terminal::Format] The format to use for terminal output.

verbose [RW]

@attribute [Boolean] Whether to print verbose output.

Public Class Methods

new (stream, verbose: nil, start_at: Terminal.start_at!, format: nil, **options)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/terminal.rb, line 71
def initialize(stream, verbose: nil, start_at: Terminal.start_at!, format: nil, **options)
        @stream = stream
        @start_at = start_at
        
        @terminal = format.nil? ? Console::Terminal.for(@stream) : format.new(@stream)
        
        if verbose.nil?
                @verbose = !@terminal.colors?
        else
                @verbose = verbose
        end
        
        @terminal[:logger_suffix] ||= @terminal.style(:white, nil, :faint)
        @terminal[:subject] ||= @terminal.style(nil, nil, :bold)
        @terminal[:debug] = @terminal.style(:cyan)
        @terminal[:info] = @terminal.style(:green)
        @terminal[:warn] = @terminal.style(:yellow)
        @terminal[:error] = @terminal.style(:red)
        @terminal[:fatal] = @terminal[:error]
        
        @terminal[:annotation] = @terminal.reset
        @terminal[:value] = @terminal.style(:blue)
        
        @formatters = {}
        self.register_formatters
end

Create a new terminal output.

@parameter stream [IO] The output stream. @parameter verbose [Boolean] Whether to print verbose output. @parameter start_at [Time] The start time of the terminal output. @parameter format [Console::Terminal::Format] The format to use for terminal output. @parameter options [Hash] Additional options to customize the output.

start_at! (env = ENV)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/terminal.rb, line 51
def self.start_at!(env = ENV)
        if time_string = env[CONSOLE_START_AT]
                start_at = Time.parse(time_string) rescue nil
        end
        
        unless start_at
                start_at = Time.now
                env[CONSOLE_START_AT] = start_at.to_s
        end
        
        return start_at
end

Exports CONSOLE_START_AT which can be used to synchronize the start times of all child processes when they log using delta time.

Public Instance Methods

call (subject = nil, *arguments, name: nil, severity: UNKNOWN, event: nil, **options) { || ... }

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/terminal.rb, line 144
def call(subject = nil, *arguments, name: nil, severity: UNKNOWN, event: nil, **options, &block)
        width = @terminal.width
        
        prefix = build_prefix(name || severity.to_s)
        indent = " " * prefix.size
        
        buffer = Buffer.new("#{indent}| ")
        indent_size = buffer.prefix.size
        
        format_subject(severity, prefix, subject, buffer)
        
        arguments.each do |argument|
                format_argument(argument, buffer)
        end
        
        if block_given?
                if block.arity.zero?
                        format_argument(yield, buffer)
                else
                        yield(buffer, @terminal)
                end
        end
        
        if event
                format_event(event, buffer, width - indent_size)
        end
        
        if options&.any?
                format_options(options, buffer)
        end
        
        @stream.write buffer.string
end

Log a message with the given severity.

@parameter subject [String] The subject of the log message. @parameter arguments [Array] The arguments to log. @parameter name [String | Nil] The optional name of the log message, used as a prefix, otherwise defaults to the severity name. @parameter severity [Symbol] The severity of the log message. @parameter event [Hash] The event to log. @parameter options [Hash] Additional options. @yields {|buffer, terminal| …} An optional block used to generate the log message.

@parameter buffer [Console::Output::Terminal::Buffer] The output buffer.
@parameter terminal [Console::Terminal] The terminal instance.

last_output ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/terminal.rb, line 99
def last_output
        self
end

This a final output.

register_formatters (namespace = Console::Terminal::Formatter)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/terminal.rb, line 123
def register_formatters(namespace = Console::Terminal::Formatter)
        namespace.constants.each do |name|
                formatter = namespace.const_get(name)
                @formatters[formatter::KEY] = formatter.new(@terminal)
        end
end

verbose! (value = true)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/terminal.rb, line 118
def verbose!(value = true)
        @verbose = value
end

Set the verbose output.

@parameter value [Boolean] Whether to print verbose output.

Protected Instance Methods

build_prefix (name)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/terminal.rb, line 274
def build_prefix(name)
        if @verbose
                "#{time_offset_prefix} #{name.rjust(8)}"
        else
                time_offset_prefix
        end
end

default_suffix (object = nil)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/terminal.rb, line 211
def default_suffix(object = nil)
        buffer = +""
        
        if @verbose
                if annotation = Fiber.current.annotation
                        # While typically annotations should be strings, that is not always the case.
                        annotation = annotation.to_s
                        
                        # If the annotation is empty, we don't want to print it, as it will look like a formatting bug.
                        if annotation.size > 0
                                buffer << ": #{@terminal[:annotation]}#{annotation}#{@terminal.reset}"
                        end
                end
        end
        
        buffer << " #{@terminal[:logger_suffix]}"
        
        if object
                buffer << "[oid=0x#{object.object_id.to_s(16)}] "
        end
        
        buffer << "[ec=0x#{Fiber.current.object_id.to_s(16)}] [pid=#{Process.pid}] [#{::Time.now}]#{@terminal.reset}"
        
        return buffer
end

format_argument (argument, output)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/terminal.rb, line 195
def format_argument(argument, output)
        argument.to_s.each_line do |line|
                output.puts line
        end
end

format_event (event, buffer, width)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/terminal.rb, line 180
def format_event(event, buffer, width)
        event = event.to_hash
        type = event[:type]
        
        if formatter = @formatters[type]
                formatter.format(event, buffer, verbose: @verbose, width: width)
        else
                format_value(::JSON.pretty_generate(event), buffer)
        end
end

format_object_subject (severity, prefix, subject, output)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/terminal.rb, line 237
def format_object_subject(severity, prefix, subject, output)
        prefix_style = @terminal[severity]
        
        if @verbose
                suffix = default_suffix(subject)
        end
        
        prefix = "#{prefix_style}#{prefix}:#{@terminal.reset} "
        
        output.puts "#{@terminal[:subject]}#{subject.class}#{@terminal.reset}#{suffix}", prefix: prefix
end

format_options (options, output)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/terminal.rb, line 191
def format_options(options, output)
        format_value(::JSON.pretty_generate(options), output)
end

format_string_subject (severity, prefix, subject, output)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/terminal.rb, line 249
def format_string_subject(severity, prefix, subject, output)
        prefix_style = @terminal[severity]
        
        if @verbose
                suffix = default_suffix
        end
        
        prefix = "#{prefix_style}#{prefix}:#{@terminal.reset} "
        
        output.puts "#{@terminal[:subject]}#{subject}#{@terminal.reset}#{suffix}", prefix: prefix
end

format_subject (severity, prefix, subject, buffer)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/terminal.rb, line 201
def format_subject(severity, prefix, subject, buffer)
        if subject.is_a?(String)
                format_string_subject(severity, prefix, subject, buffer)
        elsif subject.is_a?(Module)
                format_string_subject(severity, prefix, subject.to_s, buffer)
        else
                format_object_subject(severity, prefix, subject, buffer)
        end
end

format_value (value, output)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/terminal.rb, line 261
def format_value(value, output)
        string = value.to_s
        
        string.each_line do |line|
                line.chomp!
                output.puts "#{@terminal[:value]}#{line}#{@terminal.reset}"
        end
end

time_offset_prefix ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/terminal.rb, line 270
def time_offset_prefix
        Clock.formatted_duration(Time.now - @start_at).rjust(6)
end