Class: Rigor::Analysis::Diagnostic

Inherits:
Object
  • Object
show all
Defined in:
lib/rigor/analysis/diagnostic.rb

Constant Summary collapse

DEFAULT_SOURCE_FAMILY =

The default source family. Matches the existing analyzer- internal rule families; serialised as ‘“builtin”` and is the baseline against which non-default families are recognised.

:builtin

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(path:, line:, column:, message:, severity: :error, rule: nil, source_family: DEFAULT_SOURCE_FAMILY, receiver_type: nil, method_name: nil, project_definition_site: nil) ⇒ Diagnostic

‘rule:` is the stable identifier (a kebab-case string) of the diagnostic’s source rule. It is used by the configuration and the in-source ‘# rigor:disable <rule>` suppression comment system to identify diagnostics by category. Diagnostics not produced by `CheckRules` (parse errors, path errors, internal analyzer errors) may leave `rule` as nil and stay unsuppressible.

‘source_family:` names the producer of the rule. The default `:builtin` covers analyzer-internal rules; future families like `:rbs_extended`, `:generated`, or `“plugin.<id>”` (per ADR-2 § “Plugin Diagnostic Provenance”) let consumers distinguish where a diagnostic originated without committing to the plugin API itself.

‘receiver_type:` / `method_name:` are optional structured fields populated by the call-related rules (`call.undefined- method`) — the rendered receiver type and the called method name as plain strings. ADR-23 WD3 / slice 4: `rigor triage`’s heuristic recognisers read these directly instead of parsing the diagnostic message, so the catalogue no longer couples to message wording. Both stay nil for rules that have no such pair; a consumer that finds them nil falls back to message parsing.

‘project_definition_site:` is an optional `“path:line”` string set by `call.undefined-method` when the project itself defines the called method on the receiver class somewhere in the analyzed file set (a reopened core/stdlib/gem class the dispatcher does not apply cross-file — see ADR-17). Its presence is the high-confidence “this is a project monkey-patch, not a bug” signal `rigor triage` keys on to recommend `pre_eval:`. Nil for every other diagnostic.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/rigor/analysis/diagnostic.rb', line 47

def initialize(path:, line:, column:, message:, severity: :error, rule: nil, # rubocop:disable Metrics/ParameterLists
               source_family: DEFAULT_SOURCE_FAMILY,
               receiver_type: nil, method_name: nil, project_definition_site: nil)
  @path = path
  @line = line
  @column = column
  @message = message
  @severity = severity
  @rule = rule
  @source_family = source_family
  @receiver_type = receiver_type
  @method_name = method_name
  @project_definition_site = project_definition_site
end

Instance Attribute Details

#column ⇒ Object (readonly)

Returns the value of attribute column.



11
12
13
 
# File 'lib/rigor/analysis/diagnostic.rb', line 11

def column
  @column
end

#line ⇒ Object (readonly)

Returns the value of attribute line.



11
12
13
 
# File 'lib/rigor/analysis/diagnostic.rb', line 11

def line
  @line
end

#message ⇒ Object (readonly)

Returns the value of attribute message.



11
12
13
 
# File 'lib/rigor/analysis/diagnostic.rb', line 11

def message
  @message
end

#method_name ⇒ Object (readonly)

Returns the value of attribute method_name.



11
12
13
 
# File 'lib/rigor/analysis/diagnostic.rb', line 11

def method_name
  @method_name
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



11
12
13
 
# File 'lib/rigor/analysis/diagnostic.rb', line 11

def path
  @path
end

#project_definition_site ⇒ Object (readonly)

Returns the value of attribute project_definition_site.



11
12
13
 
# File 'lib/rigor/analysis/diagnostic.rb', line 11

def project_definition_site
  @project_definition_site
end

#receiver_type ⇒ Object (readonly)

Returns the value of attribute receiver_type.



11
12
13
 
# File 'lib/rigor/analysis/diagnostic.rb', line 11

def receiver_type
  @receiver_type
end

#rule ⇒ Object (readonly)

Returns the value of attribute rule.



11
12
13
 
# File 'lib/rigor/analysis/diagnostic.rb', line 11

def rule
  @rule
end

#severity ⇒ Object (readonly)

Returns the value of attribute severity.



11
12
13
 
# File 'lib/rigor/analysis/diagnostic.rb', line 11

def severity
  @severity
end

#source_family ⇒ Object (readonly)

Returns the value of attribute source_family.



11
12
13
 
# File 'lib/rigor/analysis/diagnostic.rb', line 11

def source_family
  @source_family
end

Class Method Details

.from_location(location, path:, message:, severity: :error, rule: nil, source_family: DEFAULT_SOURCE_FAMILY, receiver_type: nil, method_name: nil, project_definition_site: nil) ⇒ Object

Builds a Diagnostic from an explicit Prism location, applying the same 1-based ‘line` / `start_column + 1` convention as from_node. Use this when the diagnostic should point at a sub-location rather than the whole node — most often a call’s ‘message_loc` (the matcher / method name) instead of the receiver-spanning `node.location`. from_node is sugar for `from_location(node.location, …)`.



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/rigor/analysis/diagnostic.rb', line 89

def self.from_location(location, path:, message:, severity: :error, rule: nil, # rubocop:disable Metrics/ParameterLists
                       source_family: DEFAULT_SOURCE_FAMILY,
                       receiver_type: nil, method_name: nil, project_definition_site: nil)
  new(
    path: path,
    line: location.start_line,
    column: location.start_column + 1,
    message: message, severity: severity, rule: rule, source_family: source_family,
    receiver_type: receiver_type, method_name: method_name,
    project_definition_site: project_definition_site
  )
end

.from_node(node, path:, message:, severity: :error, rule: nil, source_family: DEFAULT_SOURCE_FAMILY, receiver_type: nil, method_name: nil, project_definition_site: nil) ⇒ Object

Builds a Diagnostic positioned at a Prism node. Internalises the load-bearing convention every caller otherwise repeats: the line is the node’s 1-based ‘start_line` and the column is `start_column + 1` (Prism columns are 0-based; Rigor reports 1-based). Pass any node responding to `#location`; all other fields forward to `#initialize` unchanged.

‘Plugin::Base#diagnostic` wraps this for plugin authors (who must not set `source_family` — the runner stamps it); core rules and other producers call it directly.



72
73
74
75
76
77
78
79
80
 
# File 'lib/rigor/analysis/diagnostic.rb', line 72

def self.from_node(node, path:, message:, severity: :error, rule: nil, # rubocop:disable Metrics/ParameterLists
                   source_family: DEFAULT_SOURCE_FAMILY,
                   receiver_type: nil, method_name: nil, project_definition_site: nil)
  from_location(
    node.location, path: path, message: message, severity: severity, rule: rule,
                   source_family: source_family, receiver_type: receiver_type,
                   method_name: method_name, project_definition_site: project_definition_site
  )
end

Instance Method Details

#error? ⇒ Boolean

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/rigor/analysis/diagnostic.rb', line 102

def error?
  severity == :error
end

#qualified_rule ⇒ Object

The fully-qualified rule identifier — ‘<source_family>.<rule>` when the source is non-default, or just `<rule>` for the `:builtin` family. Returns nil when `rule` itself is nil (e.g. parse errors and internal-analyzer errors).



110
111
112
113
114
115
 
# File 'lib/rigor/analysis/diagnostic.rb', line 110

def qualified_rule
  return nil if rule.nil?
  return rule if source_family == DEFAULT_SOURCE_FAMILY

  "#{source_family}.#{rule}"
end

#to_h ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/rigor/analysis/diagnostic.rb', line 117

def to_h
  base = {
    "path" => path,
    "line" => line,
    "column" => column,
    "severity" => severity.to_s,
    "rule" => rule,
    "source_family" => source_family.to_s,
    "message" => message
  }
  base["project_definition_site"] = project_definition_site if project_definition_site
  base
end

#to_s ⇒ Object

Text rendering for ‘rigor check`. The qualified rule identifier (per ADR-2 § “Plugin Diagnostic Provenance” —`plugin.<id>.<rule>`, `rbs_extended.<rule>`, `generated.<provider>.<rule>`) is appended in brackets whenever the diagnostic carries a non-default `source_family`, so plugin / RBS::Extended / generated provenance is visible in the standard text output without changing the layout for built-in rules. Slice 5 (v0.1.0) wires this surface.



139
140
141
142
143
144
145
146
147
 
# File 'lib/rigor/analysis/diagnostic.rb', line 139

def to_s
  base = "#{path}:#{line}:#{column}: #{severity}: #{message}"
  return base if source_family == DEFAULT_SOURCE_FAMILY

  qualified = qualified_rule
  return base if qualified.nil?

  "#{base} [#{qualified}]"
end