Class: RuboCop::RSpec::ExpectOffense::AnnotatedSource
- Inherits:
-
Object
- Object
- RuboCop::RSpec::ExpectOffense::AnnotatedSource
- 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*(\^+|\^{}) /.freeze
- ABBREV =
"[...]\n"
Class Method Summary collapse
-
.parse(annotated_source) ⇒ AnnotatedSource
Separates annotation lines from source lines.
Instance Method Summary collapse
- #==(other) ⇒ Object
-
#initialize(lines, annotations) ⇒ AnnotatedSource
constructor
A new instance of AnnotatedSource.
-
#match_annotations?(other) ⇒ Boolean
Dirty hack: expectations with […] are rewritten when they match This way the diff is clean.
-
#plain_source ⇒ String
Return the plain source code without annotations.
-
#to_s ⇒ String
(also: #inspect)
Construct annotated source string (like what we parse).
-
#with_offense_annotations(offenses) ⇒ self
Annotate the source code with the RuboCop offenses provided.
Constructor Details
#initialize(lines, annotations) ⇒ AnnotatedSource
annotations are sorted so that reconstructing the annotation text via #to_s is deterministic
Returns a new instance of AnnotatedSource.
246 247 248 249 |
# File 'lib/rubocop/rspec/expect_offense.rb', line 246 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.
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
# File 'lib/rubocop/rspec/expect_offense.rb', line 224 def self.parse(annotated_source) source = [] annotations = [] annotated_source.each_line do |source_line| if ANNOTATION_PATTERN.match?(source_line) annotations << [source.size, source_line] else source << source_line end end annotations.each { |a| a[0] = 1 } if source.empty? new(source, annotations) end |
Instance Method Details
#==(other) ⇒ Object
251 252 253 |
# File 'lib/rubocop/rspec/expect_offense.rb', line 251 def ==(other) other.is_a?(self.class) && other.lines == lines && match_annotations?(other) end |
#match_annotations?(other) ⇒ Boolean
Dirty hack: expectations with […] are rewritten when they match This way the diff is clean.
257 258 259 260 261 262 263 264 265 266 267 268 |
# File 'lib/rubocop/rspec/expect_offense.rb', line 257 def match_annotations?(other) annotations.zip(other.annotations) do |(_actual_line, actual_annotation), (_expected_line, expected_annotation)| if expected_annotation&.end_with?(ABBREV) && actual_annotation.start_with?(expected_annotation[0...-ABBREV.length]) expected_annotation.replace(actual_annotation) end end annotations == other.annotations end |
#plain_source ⇒ String
Return the plain source code without annotations
307 308 309 |
# File 'lib/rubocop/rspec/expect_offense.rb', line 307 def plain_source lines.join end |
#to_s ⇒ String Also known as: inspect
Construct annotated source string (like what we parse)
Reconstruct a deterministic annotated source string. This is useful for eliminating semantically irrelevant annotation ordering differences.
293 294 295 296 297 298 299 300 301 |
# File 'lib/rubocop/rspec/expect_offense.rb', line 293 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
316 317 318 319 320 321 322 323 324 325 326 327 |
# File 'lib/rubocop/rspec/expect_offense.rb', line 316 def with_offense_annotations(offenses) offense_annotations = offenses.map do |offense| indent = ' ' * offense.column carets = '^' * offense.column_length carets = '^{}' if offense.column_length.zero? [offense.line, "#{indent}#{carets} #{offense.}\n"] end self.class.new(lines, offense_annotations) end |