Class: PaperTrailDiff::DiagnosticIssue

Inherits:
Object
  • Object
show all
Defined in:
lib/paper_trail_diff/diagnostics.rb,
sig/generated/paper_trail_diff/diagnostics.rbs

Overview

One immutable historical-reconstruction setup finding.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(severity:, code:, message:, path: nil, version_id: nil) ⇒ DiagnosticIssue

: (severity: Symbol, code: Symbol, message: String, ?path: String?, ?version_id: untyped) -> void

Parameters:

  • severity: (Symbol)
  • code: (Symbol)
  • message: (String)
  • path: (String, nil) (defaults to: nil)
  • version_id: (Object) (defaults to: nil) 


14
15
16
17
18
19
20
21
 
# File 'lib/paper_trail_diff/diagnostics.rb', line 14

def initialize(severity:, code:, message:, path: nil, version_id: nil)
  @severity = severity
  @code = code
  @message = Support.immutable_copy(message)
  @path = Support.immutable_copy(path)
  @version_id = Support.immutable_copy(version_id)
  freeze
end

Instance Attribute Details

#code ⇒ Symbol (readonly)

Signature:

  • Symbol

Returns:

  • (Symbol) 


8
9
10
 
# File 'lib/paper_trail_diff/diagnostics.rb', line 8

def code
  @code
end

#message ⇒ String (readonly)

Signature:

  • String

Returns:

  • (String) 


9
10
11
 
# File 'lib/paper_trail_diff/diagnostics.rb', line 9

def message
  @message
end

#path ⇒ String? (readonly)

Signature:

  • String?

Returns:

  • (String, nil) 


10
11
12
 
# File 'lib/paper_trail_diff/diagnostics.rb', line 10

def path
  @path
end

#severity ⇒ Symbol (readonly)

Signature:

  • Symbol

Returns:

  • (Symbol) 


7
8
9
 
# File 'lib/paper_trail_diff/diagnostics.rb', line 7

def severity
  @severity
end

#version_id ⇒ Object (readonly)

Signature:

  • untyped

Returns:

  • (Object) 


11
12
13
 
# File 'lib/paper_trail_diff/diagnostics.rb', line 11

def version_id
  @version_id
end

Instance Method Details

#to_h ⇒ Hash[Symbol, untyped]

: () -> Hash[Symbol, untyped]

Returns:

  • (Hash[Symbol, untyped]) 


24
25
26
27
28
29
30
31
32
 
# File 'lib/paper_trail_diff/diagnostics.rb', line 24

def to_h
  {
    severity: severity,
    code: code,
    message: message,
    path: path,
    version_id: version_id
  }
end