class Console::Capture

A buffer which captures all logged messages into a buffer.

Attributes

buffer [R]

@attribute [Array(Hash)] All records captured by this buffer.

records [R]

@attribute [Array(Hash)] All records captured by this buffer.

to_a [R]

@attribute [Array(Hash)] All records captured by this buffer.

verbose [R]

@attribute [Boolean] If true, the buffer will capture verbose messages.

Public Class Methods

new ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/capture.rb, line 13
def initialize
        @records = []
        @verbose = false
end

Create a new log capture buffer.

Public Instance Methods

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

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/capture.rb, line 87
def call(subject = nil, *arguments, severity: UNKNOWN, event: nil, **options, &block)
        record = {
                time: ::Time.now.iso8601,
                severity: severity,
                **options,
        }
        
        if subject
                record[:subject] = subject
        end
        
        if event
                record[:event] = event.to_hash
        end
        
        if arguments.any?
                record[:arguments] = arguments
        end
        
        if annotation = Fiber.current.annotation
                record[:annotation] = annotation
        end
        
        if block_given?
                if block.arity.zero?
                        record[:message] = yield
                else
                        buffer = StringIO.new
                        yield buffer
                        record[:message] = buffer.string
                end
        else
                record[:message] = arguments.join(" ")
        end
        
        @records << record
end

Record a log message in the buffer.

@parameter subject [Object] The subject of the log message. @parameter arguments [Array] The arguments to the log message. @parameter severity [Symbol] The severity of the log message. @parameter event [Event] The event associated with the log message. @parameter options [Hash] Additional options to pass to the log message. @yields {|buffer| …} A block which can be used to write additional information to the log message.

@parameter buffer [IO] The (optional) buffer to write to.

clear ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/capture.rb, line 59
def clear
        @records.clear
end

Clear all records from the buffer.

each (&block)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/capture.rb, line 42
def each(&block)
        @records.each(&block)
end

Iterate over all records in the buffer.

@yields {|record| …} each record in the buffer.

@parameter record [Hash] The record itself.

empty? ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/capture.rb, line 64
def empty?
        @records.empty?
end

@returns [Boolean] True if the buffer is empty.

first ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/capture.rb, line 49
def first
        @records.first
end

@returns [Hash] The first record in the buffer.

include? (pattern)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/capture.rb, line 32
def include?(pattern)
        @records.any? do |record|
                record[:subject].to_s&.match?(pattern) or record[:message].to_s&.match?(pattern)
        end
end

Whether the buffer includes any records with the given subject or message pattern.

@returns [Boolean] True if the buffer includes any records with the given pattern.

last ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/capture.rb, line 54
def last
        @records.last
end

@returns [Hash] The last record in the buffer.

verbose! (value = true)

Source

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

Sets the verbose flag which controls whether verbose messages are captured.

verbose? ()

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/capture.rb, line 74
def verbose?
        @verbose
end

@returns [Boolean] True if the buffer is capturing verbose messages.