Class: RuboCop::RSpec::ExpectOffense::AnnotatedSource

Inherits:
Object
  • Object
show all
Defined in:
lib/rubocop/rspec/expect_offense.rb

Overview

Parsed representation of code annotated with the `^^^ Message` style

Constant Summary collapse

ANNOTATION_PATTERN = 
/\A\s*\^+ /

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(lines, annotations) ⇒ AnnotatedSource

Note:

annotations are sorted so that reconstructing the annotation text via #to_s is deterministic

Returns a new instance of AnnotatedSource



97
98
99
100
 
# File 'lib/rubocop/rspec/expect_offense.rb', line 97

def initialize(lines, annotations)
  @lines       = lines.freeze
  @annotations = annotations.sort.freeze
end

Class Method Details

.parse(annotated_source) ⇒ AnnotatedSource

Separates annotation lines from source lines. Tracks the real source line number that each annotation corresponds to.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/rubocop/rspec/expect_offense.rb', line 76

def self.parse(annotated_source)
  source      = []
  annotations = []

  annotated_source.each_line do |source_line|
    if source_line =~ ANNOTATION_PATTERN
      annotations << [source.size, source_line]
    else
      source << source_line
    end
  end

  new(source, annotations)
end

Instance Method Details

#plain_source ⇒ String

Return the plain source code without annotations



138
139
140
 
# File 'lib/rubocop/rspec/expect_offense.rb', line 138

def plain_source
  lines.join
end

#to_s ⇒ String

Construct annotated source string (like what we parse)

Reconstruct a deterministic annotated source string. This is useful for eliminating semantically irrelevant annotation ordering differences.

Examples:

standardization


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

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

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


125
126
127
128
129
130
131
132
133
 
# File 'lib/rubocop/rspec/expect_offense.rb', line 125

def to_s
  reconstructed = lines.dup

  annotations.reverse_each do |line_number, annotation|
    reconstructed.insert(line_number, annotation)
  end

  reconstructed.join
end

#with_offense_annotations(offenses) ⇒ self

Annotate the source code with the RuboCop offenses provided



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/rubocop/rspec/expect_offense.rb', line 147

def with_offense_annotations(offenses)
  offense_annotations =
    offenses.map do |offense|
      indent     = ' ' * offense.column
      carets     = '^' * offense.column_length

      [offense.line, "#{indent}#{carets} #{offense.message}\n"]
    end

  self.class.new(lines, offense_annotations)
end