Class: Uniword::Redact::Pattern

Inherits:
Object
  • Object
show all
Defined in:
lib/uniword/redact/pattern.rb

Overview

One redaction pattern: a regex plus a label that classifies the kind of PII it matches.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, regex:, replacement: "[REDACTED]", description: nil) ⇒ Pattern

Returns a new instance of Pattern.

Parameters:

  • name (Symbol) —

    pattern identifier (e.g. :ssn, :email)

  • regex (Regexp) —

    what to match

  • replacement (String) (defaults to: "[REDACTED]") —

    replacement text (default "[REDACTED]")

  • description (String) (defaults to: nil) —

    human-readable pattern description



14
15
16
17
18
19
20
 
# File 'lib/uniword/redact/pattern.rb', line 14

def initialize(name:, regex:, replacement: "[REDACTED]",
               description: nil)
  @name = name
  @regex = regex
  @replacement = replacement
  @description = description
end

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.



8
9
10
 
# File 'lib/uniword/redact/pattern.rb', line 8

def description
  @description
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



8
9
10
 
# File 'lib/uniword/redact/pattern.rb', line 8

def name
  @name
end

#regex ⇒ Object (readonly)

Returns the value of attribute regex.



8
9
10
 
# File 'lib/uniword/redact/pattern.rb', line 8

def regex
  @regex
end

#replacement ⇒ Object (readonly)

Returns the value of attribute replacement.



8
9
10
 
# File 'lib/uniword/redact/pattern.rb', line 8

def replacement
  @replacement
end