class Console::Output::Sensitive

Redact sensitive information from output.

Constants

REDACT: Default redaction pattern.

Public Class Methods

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/sensitive.rb, line 44
def initialize(output, redact: REDACT, **options)
        super(output, **options)
        
        @redact = redact
end

Create a new sensitive output wrapper.

@parameter output [Console::Output] The output to wrap. @parameter redact [Regexp] The pattern to redact. @parameter options [Hash] Additional options to pass to the output.

Calls superclass method

Public Instance Methods

call (subject = nil, *arguments, sensitive: true, **options, &block)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/sensitive.rb, line 130
def call(subject = nil, *arguments, sensitive: true, **options, &block)
        if sensitive
                if sensitive.respond_to?(:call)
                        filter = sensitive
                elsif sensitive.is_a?(Hash)
                        filter = Filter.new(sensitive)
                end
                
                subject = redact(subject, filter)
                arguments = redact_array(arguments, filter)
        end
        
        super(subject, *arguments, **options)
end

Write a message to the output, filtering sensitive information if necessary.

@parameter subject [String] The subject of the message. @parameter arguments [Array] The arguments to output. @parameter sensitive [Boolean | Filter | Hash] Whether to filter sensitive information. @parameter options [Hash] Additional options to pass to the output. @parameter block [Proc] An optional block to pass to the output.

Calls superclass method

redact (argument, filter)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/sensitive.rb, line 85
def redact(argument, filter)
        case argument
        when String
                if filter
                        filter.call(argument)
                elsif redact?(argument)
                        "[REDACTED]"
                else
                        argument
                end
        when Array
                redact_array(argument, filter)
        when Hash
                redact_hash(argument, filter)
        else
                redact(argument.to_s, filter)
        end
end

Redact sensitive information from the given argument.

@parameter argument [String | Array | Hash] The argument to redact. @parameter filter [Proc] An optional filter to apply to redacted text. @returns [String | Array | Hash] The redacted argument.

redact? (text)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/sensitive.rb, line 54
def redact?(text)
        text.match?(@redact)
end

Check if the given text should be redacted.

@parameter text [String] The text to check. @returns [Boolean] Whether the text should be redacted.

redact_array (array, filter)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/sensitive.rb, line 74
def redact_array(array, filter)
        array.map do |value|
                redact(value, filter)
        end
end

Redact sensitive information from an array.

@parameter array [Array] The array to redact. @parameter filter [Proc] An optional filter to apply to redacted text. @returns [Array] The redacted array.

redact_hash (arguments, filter)

Source

# File vendor/bundle/ruby/3.4.0/gems/console-1.30.2/lib/console/output/sensitive.rb, line 63
def redact_hash(arguments, filter)
        arguments.transform_values do |value|
                redact(value, filter)
        end
end

Redact sensitive information from a hash.

@parameter arguments [Hash] The hash to redact. @parameter filter [Proc] An optional filter to apply to redacted text. @returns [Hash] The redacted hash.