Module: Rigor::SigGen::Classification

Defined in:: lib/rigor/sig_gen/classification.rb

Overview

The five classifications a candidate method falls into after the generator has compared the inferred return type against the project's existing RBS.

The strings are the diagnostic-family identifiers ADR-14 reserves under sig.*; the MVP carries them as plain symbols on the method candidate and renders the matching identifier in JSON / text output. They are added to the diagnostic family hierarchy in docs/type-specification/diagnostic-policy.md even though slice 1 does not yet emit them as diagnostics.

Constant Summary collapse

NEW_FILE =

:new_file

NEW_METHOD =

:new_method

TIGHTER_RETURN =

:tighter_return

EQUIVALENT =

:equivalent

SKIPPED =

:skipped

DIAGNOSTIC_IDS =

{
  NEW_FILE => "sig.generated.new-file",
  NEW_METHOD => "sig.generated.new-method",
  TIGHTER_RETURN => "sig.generated.tighter-return"
}.freeze

SKIP_DIAGNOSTIC_IDS =

{
  complex_shape: "sig.skipped.complex-shape",
  user_authored: "sig.skipped.user-authored",
  untyped_return: "sig.skipped.untyped-return",
  # The generator rendered a line `rbs` itself rejects. Skipping the method keeps sig-gen useful on a
  # project with one pathological def, where failing the command outright would deny the user every other
  # signature; the count is reported so the defect is not silent. See {SigGen::RbsValidity}.
  unrenderable_rbs: "sig.skipped.unrenderable-rbs"
}.freeze