feat: Add Renderer

Author: Muscraft

benches/simple.rs

@@ -4,8 +4,9 @@ extern crate criterion;
 
 use criterion::{black_box, Criterion};
 
+use annotate_snippets::renderer::Renderer;
 use annotate_snippets::{
-    display_list::{DisplayList, FormatOptions},
+    display_list::FormatOptions,
     snippet::{Annotation, AnnotationType, Slice, Snippet, SourceAnnotation},
 };
 
@@ -62,8 +63,8 @@ fn create_snippet() {
         },
     };
 
-    let dl = DisplayList::from(snippet);
-    let _result = dl.to_string();
+    let renderer = Renderer;
+    let _result = renderer.render(snippet).to_string();
 }
 
 pub fn criterion_benchmark(c: &mut Criterion) {

examples/expected_type.rs

@@ -1,5 +1,6 @@
+use annotate_snippets::renderer::Renderer;
 use annotate_snippets::{
-    display_list::{DisplayList, FormatOptions},
+    display_list::FormatOptions,
     snippet::{Annotation, AnnotationType, Slice, Snippet, SourceAnnotation},
 };
 
@@ -38,6 +39,6 @@ fn main() {
         },
     };
 
-    let dl = DisplayList::from(snippet);
-    println!("{}", dl);
+    let renderer = Renderer;
+    println!("{}", renderer.render(snippet));
 }

examples/footer.rs

@@ -1,5 +1,6 @@
+use annotate_snippets::renderer::Renderer;
 use annotate_snippets::{
-    display_list::{DisplayList, FormatOptions},
+    display_list::FormatOptions,
     snippet::{Annotation, AnnotationType, Slice, Snippet, SourceAnnotation},
 };
 
@@ -34,6 +35,6 @@ fn main() {
         },
     };
 
-    let dl = DisplayList::from(snippet);
-    println!("{}", dl);
+    let renderer = Renderer;
+    println!("{}", renderer.render(snippet));
 }

examples/format.rs

@@ -1,5 +1,6 @@
+use annotate_snippets::renderer::Renderer;
 use annotate_snippets::{
-    display_list::{DisplayList, FormatOptions},
+    display_list::FormatOptions,
     snippet::{Annotation, AnnotationType, Slice, Snippet, SourceAnnotation},
 };
 
@@ -56,6 +57,6 @@ fn main() {
         },
     };
 
-    let dl = DisplayList::from(snippet);
-    println!("{}", dl);
+    let renderer = Renderer;
+    println!("{}", renderer.render(snippet));
 }

examples/multislice.rs

@@ -1,5 +1,6 @@
+use annotate_snippets::renderer::Renderer;
 use annotate_snippets::{
-    display_list::{DisplayList, FormatOptions},
+    display_list::FormatOptions,
     snippet::{Annotation, AnnotationType, Slice, Snippet},
 };
 
@@ -33,6 +34,6 @@ fn main() {
         },
     };
 
-    let dl = DisplayList::from(snippet);
-    println!("{}", dl);
+    let renderer = Renderer;
+    println!("{}", renderer.render(snippet));
 }

src/lib.rs

@@ -50,5 +50,6 @@
 
 pub mod display_list;
 pub mod formatter;
+pub mod renderer;
 pub mod snippet;
 pub mod stylesheets;

src/renderer/mod.rs

@@ -0,0 +1,11 @@
+use crate::display_list::DisplayList;
+use crate::snippet::Snippet;
+use std::fmt::Display;
+
+pub struct Renderer;
+
+impl Renderer {
+    pub fn render<'a>(&'a self, snippet: Snippet<'a>) -> impl Display + 'a {
+        DisplayList::from(snippet)
+    }
+}

tests/fixtures_test.rs

@@ -2,7 +2,8 @@ mod diff;
 mod snippet;
 
 use crate::snippet::SnippetDef;
-use annotate_snippets::{display_list::DisplayList, snippet::Snippet};
+use annotate_snippets::renderer::Renderer;
+use annotate_snippets::snippet::Snippet;
 use glob::glob;
 use std::{error::Error, fs::File, io, io::prelude::*};
 
@@ -30,8 +31,8 @@ fn test_fixtures() {
         let snippet = read_fixture(&src).expect("Failed to read file");
         let expected_out = read_file(&path_out).expect("Failed to read file");
 
-        let dl = DisplayList::from(snippet);
-        let actual_out = dl.to_string();
+        let renderer = Renderer;
+        let actual_out = renderer.render(snippet).to_string();
         println!("{}", expected_out);
         println!("{}", actual_out.trim_end());
 

tests/formatter.rs

@@ -1,4 +1,5 @@
 use annotate_snippets::display_list::*;
+use annotate_snippets::renderer::Renderer;
 use annotate_snippets::snippet::{self, Snippet};
 
 #[test]
@@ -548,7 +549,8 @@ fn test_i_29() {
   |        ^^^^ oops
   |"#;
 
-    assert_eq!(DisplayList::from(snippets).to_string(), expected);
+    let renderer = Renderer;
+    assert_eq!(renderer.render(snippets).to_string(), expected);
 }
 
 #[test]
@@ -576,7 +578,8 @@ fn test_point_to_double_width_characters() {
   |             ^^^^ world
   |"#;
 
-    assert_eq!(DisplayList::from(snippets).to_string(), expected);
+    let renderer = Renderer;
+    assert_eq!(renderer.render(snippets).to_string(), expected);
 }
 
 #[test]
@@ -606,7 +609,8 @@ fn test_point_to_double_width_characters_across_lines() {
   | |______^ Good morning
   |"#;
 
-    assert_eq!(DisplayList::from(snippets).to_string(), expected);
+    let renderer = Renderer;
+    assert_eq!(renderer.render(snippets).to_string(), expected);
 }
 
 #[test]
@@ -643,7 +647,8 @@ fn test_point_to_double_width_characters_multiple() {
   |     ---- note: Sushi2
   |"#;
 
-    assert_eq!(DisplayList::from(snippets).to_string(), expected);
+    let renderer = Renderer;
+    assert_eq!(renderer.render(snippets).to_string(), expected);
 }
 
 #[test]
@@ -671,5 +676,6 @@ fn test_point_to_double_width_characters_mixed() {
   |             ^^^^^^^^^^^ New world
   |"#;
 
-    assert_eq!(DisplayList::from(snippets).to_string(), expected);
+    let renderer = Renderer;
+    assert_eq!(renderer.render(snippets).to_string(), expected);
 }