class Console::Terminal::Text

A simple text-based terminal output.

Attributes

@attribute [IO] The stream to write to.

Public Class Methods

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/terminal/text.rb, line 16
def initialize(stream)
        @stream = stream
        @styles = {reset: self.reset}
end

Create a new text terminal output.

@parameter stream [IO] The stream to write to.

Public Instance Methods

[] (key)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/terminal/text.rb, line 28
def [] key
        @styles[key]
end

Get the style associated with the given key.

@parameter key [Symbol] The key to look up. @returns [String] The style associated with the key.

[]= (key, value)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/terminal/text.rb, line 36
def []= key, value
        @styles[key] = value
end

Set the style associated with the given key.

@parameter key [Symbol] The key to associate the style with. @parameter value [String] The style to associate with the key.

colors? ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/terminal/text.rb, line 41
def colors?
        false
end

@returns [Boolean] Whether the terminal supports colors.

print (*arguments)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/terminal/text.rb, line 102
def print(*arguments)
        arguments.each do |argument|
                case argument
                when Symbol
                        @stream.write(self[argument])
                when Proc
                        argument.call(self)
                else
                        @stream.write(argument)
                end
        end
end

Print rich text to the output stream.

When the argument is a symbol, look up the style and inject it into the output stream.
When the argument is a proc/lambda, call it with self as the argument.
When the argument is anything else, write it directly to the output.

@parameter arguments [Array] The arguments to print.

print_line (*arguments)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/terminal/text.rb, line 118
def print_line(*arguments)
        print(*arguments)
        @stream.puts(self.reset)
end

Print rich text to the output stream, followed by the reset sequence and a newline.

@parameter arguments [Array] The arguments to print.

puts (*arguments, style: nil)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/terminal/text.rb, line 85
def puts(*arguments, style: nil)
        if style and prefix = self[style]
                @stream.write(prefix)
                @stream.puts(*arguments)
                @stream.write(self.reset)
        else
                @stream.puts(*arguments)
        end
end

Write the given arguments to the output stream using the given style. The reset sequence is automatically appended.

@parameter arguments [Array] The arguments to write, each on a new line. @parameter style [Symbol] The style to apply.

reset ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/terminal/text.rb, line 64
def reset
end

Generate a reset sequence.

@returns [String | Nil] The reset sequence if colors are supported, otherwise nil.

size ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/terminal/text.rb, line 46
def size
        [24, 80]
end

@returns [Tuple(Integer, Integer)] The size of the terminal, or a default value of [24, 80].

style (foreground, background = nil, *attributes)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/terminal/text.rb, line 58
def style(foreground, background = nil, *attributes)
end

Generate a style string for the given foreground, background, and attributes.

@returns [String | Nil] The style string if colors are supported, otherwise nil.

width ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/terminal/text.rb, line 51
def width
        self.size.last
end

@returns [Integer] The width of the terminal.

write (*arguments, style: nil)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/terminal/text.rb, line 71
def write(*arguments, style: nil)
        if style and prefix = self[style]
                @stream.write(prefix)
                @stream.write(*arguments)
                @stream.write(self.reset)
        else
                @stream.write(*arguments)
        end
end

Write the given arguments to the output stream using the given style. The reset sequence is automatically appended.

@parameter arguments [Array] The arguments to write. @parameter style [Symbol] The style to apply.