Class: Reviewer::Doctor::Report::Finding

Inherits:

Struct

• Object
• Struct
• Reviewer::Doctor::Report::Finding

Defined in:

lib/reviewer/doctor/report.rb

Overview

A single diagnostic finding with status, message, and optional detail.

Instance Attribute Summary

• #detail ⇒ String^?

  Optional detail or guidance text.

• #message ⇒ String

  The finding summary.

• #status ⇒ Symbol

  The severity (:ok, :warning, :error, or :info).

Instance Method Summary

• #to_h ⇒ Object

Instance Attribute Details

#detail ⇒ String^?

Returns optional detail or guidance text.

Returns:

• optional detail or guidance text

# File 'lib/reviewer/doctor/report.rb', line 14

Finding = Struct.new(:status, :message, :detail, keyword_init: true) do
  def to_h = { status: status, message: message, detail: detail }.compact
end

#message ⇒ String

Returns the finding summary.

Returns:

• the finding summary

# File 'lib/reviewer/doctor/report.rb', line 14

Finding = Struct.new(:status, :message, :detail, keyword_init: true) do
  def to_h = { status: status, message: message, detail: detail }.compact
end

#status ⇒ Symbol

Returns the severity (:ok, :warning, :error, or :info).

Returns:

• the severity (:ok, :warning, :error, or :info)

# File 'lib/reviewer/doctor/report.rb', line 14

Finding = Struct.new(:status, :message, :detail, keyword_init: true) do
  def to_h = { status: status, message: message, detail: detail }.compact
end

Instance Method Details

#to_h ⇒ Object

# File 'lib/reviewer/doctor/report.rb', line 15

def to_h = { status: status, message: message, detail: detail }.compact