Source::get_line_text no longer trims end whitespace

This was causing crashes using byte spans when byte spans start or end in whitespace after a line. When I write the code I did not expect get_line_text to trim whitespace.

I edited uses of get_line_text to do the trimming separately.

Technically this is a breaking change.

Author: VonTum

src/source.rs

@@ -212,9 +212,9 @@ impl<I: AsRef<str>> Source<I> {
         start..end
     }
 
-    /// Get the source text for a line, excluding trailing whitespace.
+    /// Get the source text for a line, includes trailing whitespace and the newline
     pub fn get_line_text(&self, line: Line) -> Option<&'_ str> {
-        self.text.as_ref().get(line.byte_span()).map(|text| text.trim_end())
+        self.text.as_ref().get(line.byte_span())
     }
 }
 
@@ -335,7 +335,7 @@ mod tests {
             assert_eq!(source_line.char_len, raw_line.chars().count());
             assert_eq!(
                 source.get_line_text(source_line).unwrap(),
-                raw_line.trim_end()
+                raw_line
             );
             offset += source_line.char_len;
         }
@@ -398,7 +398,7 @@ mod tests {
             assert_eq!(source_line.char_len, raw_line.chars().count());
             assert_eq!(
                 source.get_line_text(source_line).unwrap(),
-                raw_line.trim_end()
+                raw_line
             );
             offset += source_line.char_len;
         }

src/write.rs

@@ -627,7 +627,7 @@ impl<S: Span> Report<'_, S> {
 
                 // Line
                 if !is_ellipsis {
-                    for (col, c) in src.get_line_text(line).unwrap().chars().enumerate() {
+                    for (col, c) in src.get_line_text(line).unwrap().trim_end().chars().enumerate() {
                         let color = if let Some(highlight) = get_highlight(col) {
                             highlight.display_info.color
                         } else {
@@ -665,7 +665,7 @@ impl<S: Span> Report<'_, S> {
                             &margin_label,
                         )?;
                         // Lines alternate
-                        let mut chars = src.get_line_text(line).unwrap().chars();
+                        let mut chars = src.get_line_text(line).unwrap().trim_end().chars();
                         for col in 0..arrow_len {
                             let width =
                                 chars.next().map_or(1, |c| self.config.char_width(c, col).1);
@@ -719,7 +719,7 @@ impl<S: Span> Report<'_, S> {
                         &margin_label,
                     )?;
                     // Lines
-                    let mut chars = src.get_line_text(line).unwrap().chars();
+                    let mut chars = src.get_line_text(line).unwrap().trim_end().chars();
                     for col in 0..arrow_len {
                         let width = chars.next().map_or(1, |c| self.config.char_width(c, col).1);
 
@@ -1002,12 +1002,28 @@ mod tests {
            ,-[<unknown>:1:1]
            |
          1 | apple ==
-           |         | 
-           |         `- Unexpected end of file
+           |          | 
+           |          `- Unexpected end of file
         ---'
         "###);
     }
 
+    #[test]
+    fn byte_spans_never_crash() {
+        let source = "apple\np\n\nempty\n";
+
+        for i in 0..source.len() {
+            for j in i..source.len() {
+                let _ = Report::<Range<usize>>::build(ReportKind::Error, (), 0)
+                    .with_config(no_color_and_ascii().with_index_type(IndexType::Byte))
+                    .with_message("Label")
+                    .with_label(Label::new(i..j).with_message("Label"))
+                    .finish()
+                    .write_to_string(Source::from(source));
+            }
+        }
+    }
+
     #[test]
     fn multiline_label() {
         let source = "apple\n==\norange";