class Ameba::Spec::AnnotatedSource

• Ameba::Spec::AnnotatedSource
• Reference
• Object

Overview

Parsed representation of code annotated with the # ^^^ error: Message style

Defined in:

Constant Summary

ABBREV = "[...]"

ANNOTATION_PATTERN_1 = /\A\s*(# )?(\^+|\^{})( error:)? /

ANNOTATION_PATTERN_2 = " # error: "

Constructors

• .new(lines : Array(String), annotations : Enumerable(Tuple(Int32, String, String)))

  NOTE Annotations are sorted so that reconstructing the annotation text via #to_s is deterministic.

• .new(lines : Array(String), issues : Enumerable(Issue))

  Annotates the source code with the Ameba issues provided.

Class Method Summary

• .parse(annotated_code)

  Separates annotation lines from code lines.

Instance Method Summary

• #==(other)

  Returns false (other can only be a Value here).

• #annotations : Array(Tuple(Int32, String, String))

  Each entry is the line number, annotation prefix, and message.

• #lines : Array(String)
• #to_s(io)

  Constructs an annotated source string (like what we parse).

Constructor Detail

Class Method Detail

Instance Method Detail

source1 = AnnotatedSource.parse(<<-CRYSTAL)
line1
^ Annotation 1
 ^^ Annotation 2
CRYSTAL

source2 = AnnotatedSource.parse(<<-CRYSTAL)
line1
 ^^ Annotation 2
^ Annotation 1
CRYSTAL

source1.to_s == source2.to_s # => true