Class: Railsmith::ArchChecks::Violation

Inherits:

Struct

• Object
• Struct
• Railsmith::ArchChecks::Violation

Defined in:

lib/railsmith/arch_checks/violation.rb

Overview

A single architecture rule violation found by static analysis.

Instance Attribute Summary

• #file ⇒ Object readonly

  Path to the source file containing the violation.

• #line ⇒ Object readonly

  1-based line number of the offending code.

• #message ⇒ Object readonly

  Human-readable description of the violation.

• #rule ⇒ Object readonly

  Symbol identifying the detector rule (e.g. :direct_model_access).

• #severity ⇒ Object readonly

  :warn (default, non-blocking) or :error.

Instance Attribute Details

#file ⇒ Object (readonly)

Path to the source file containing the violation.

# File 'lib/railsmith/arch_checks/violation.rb', line 12

Violation = Struct.new(:rule, :file, :line, :message, :severity)

#line ⇒ Object (readonly)

1-based line number of the offending code.

# File 'lib/railsmith/arch_checks/violation.rb', line 12

Violation = Struct.new(:rule, :file, :line, :message, :severity)

#message ⇒ Object (readonly)

Human-readable description of the violation.

# File 'lib/railsmith/arch_checks/violation.rb', line 12

Violation = Struct.new(:rule, :file, :line, :message, :severity)

#rule ⇒ Object (readonly)

Symbol identifying the detector rule (e.g. :direct_model_access).

# File 'lib/railsmith/arch_checks/violation.rb', line 12

Violation = Struct.new(:rule, :file, :line, :message, :severity)

#severity ⇒ Object (readonly)

:warn (default, non-blocking) or :error.

# File 'lib/railsmith/arch_checks/violation.rb', line 12

Violation = Struct.new(:rule, :file, :line, :message, :severity)