fix!: Move Message contruction to Level

This fits with the session-type / type-state style builder and allows
Diagnoatic adapters, like rustc, to leverage it vs the hard-coded
functions.

Author: epage

benches/simple.rs

@@ -4,7 +4,7 @@ extern crate criterion;
 
 use criterion::{black_box, Criterion};
 
-use annotate_snippets::{Label, Message, Renderer, Snippet};
+use annotate_snippets::{Label, Level, Renderer, Snippet};
 
 fn create_snippet(renderer: Renderer) {
     let source = r#") -> Option<String> {
@@ -29,7 +29,7 @@ fn create_snippet(renderer: Renderer) {
             _ => continue,
         }
     }"#;
-    let snippet = Message::error("mismatched types").id("E0308").snippet(
+    let snippet = Level::Error.title("mismatched types").id("E0308").snippet(
         Snippet::new(source)
             .line_start(51)
             .origin("src/format.rs")

examples/expected_type.rs

@@ -1,11 +1,11 @@
-use annotate_snippets::{Label, Message, Renderer, Snippet};
+use annotate_snippets::{Label, Level, Renderer, Snippet};
 
 fn main() {
     let source = r#"                annotations: vec![SourceAnnotation {
                 label: "expected struct `annotate_snippets::snippet::Slice`, found reference"
                     ,
                 range: <22, 25>,"#;
-    let snippet = Message::error("expected type, found `22`").snippet(
+    let snippet = Level::Error.title("expected type, found `22`").snippet(
         Snippet::new(source)
             .line_start(26)
             .origin("examples/footer.rs")

examples/footer.rs

@@ -1,7 +1,8 @@
-use annotate_snippets::{Label, Message, Renderer, Snippet};
+use annotate_snippets::{Label, Level, Renderer, Snippet};
 
 fn main() {
-    let snippet = Message::error("mismatched types")
+    let snippet = Level::Error
+        .title("mismatched types")
         .id("E0308")
         .snippet(
             Snippet::new("        slices: vec![\"A\",")

examples/format.rs

@@ -1,4 +1,4 @@
-use annotate_snippets::{Label, Message, Renderer, Snippet};
+use annotate_snippets::{Label, Level, Renderer, Snippet};
 
 fn main() {
     let source = r#") -> Option<String> {
@@ -23,7 +23,7 @@ fn main() {
             _ => continue,
         }
     }"#;
-    let snippet = Message::error("mismatched types").id("E0308").snippet(
+    let snippet = Level::Error.title("mismatched types").id("E0308").snippet(
         Snippet::new(source)
             .line_start(51)
             .origin("src/format.rs")

examples/multislice.rs

@@ -1,7 +1,8 @@
-use annotate_snippets::{Message, Renderer, Snippet};
+use annotate_snippets::{Level, Renderer, Snippet};
 
 fn main() {
-    let snippet = Message::error("mismatched types")
+    let snippet = Level::Error
+        .title("mismatched types")
         .snippet(Snippet::new("Foo").line_start(51).origin("src/format.rs"))
         .snippet(Snippet::new("Faa").line_start(129).origin("src/display.rs"));
 

src/renderer/display_list.rs

@@ -107,8 +107,9 @@ impl<'a> DisplayList<'a> {
 
     pub(crate) fn new(
         snippet::Message {
-            title,
+            level,
             id,
+            title,
             footer,
             snippets,
         }: snippet::Message<'a>,
@@ -118,7 +119,13 @@ impl<'a> DisplayList<'a> {
     ) -> DisplayList<'a> {
         let mut body = vec![];
 
-        body.push(format_title(title, id));
+        body.push(format_title(
+            snippet::Label {
+                level,
+                label: title,
+            },
+            id,
+        ));
 
         for (idx, slice) in snippets.into_iter().enumerate() {
             body.append(&mut format_slice(
@@ -1206,7 +1213,7 @@ mod tests {
 
     #[test]
     fn test_format_title() {
-        let input = snippet::Message::error("This is a title").id("E0001");
+        let input = snippet::Level::Error.title("This is a title").id("E0001");
         let output = from_display_lines(vec![DisplayLine::Raw(DisplayRawLine::Annotation {
             annotation: Annotation {
                 annotation_type: DisplayAnnotationType::Error,
@@ -1227,8 +1234,9 @@ mod tests {
         let line_1 = "This is line 1";
         let line_2 = "This is line 2";
         let source = [line_1, line_2].join("\n");
-        let input =
-            snippet::Message::error("").snippet(snippet::Snippet::new(&source).line_start(5402));
+        let input = snippet::Level::Error
+            .title("")
+            .snippet(snippet::Snippet::new(&source).line_start(5402));
         let output = from_display_lines(vec![
             DisplayLine::Raw(DisplayRawLine::Annotation {
                 annotation: Annotation {
@@ -1278,7 +1286,8 @@ mod tests {
         let src_0_len = src_0.len();
         let src_1 = "This is slice 2";
         let src_1_len = src_1.len();
-        let input = snippet::Message::error("")
+        let input = snippet::Level::Error
+            .title("")
             .snippet(
                 snippet::Snippet::new(src_0)
                     .line_start(5402)
@@ -1359,7 +1368,7 @@ mod tests {
         let source = [line_1, line_2].join("\n");
         // In line 2
         let range = 22..24;
-        let input = snippet::Message::error("").snippet(
+        let input = snippet::Level::Error.title("").snippet(
             snippet::Snippet::new(&source)
                 .line_start(5402)
                 .annotation(snippet::Label::info("Test annotation").span(range.clone())),
@@ -1429,8 +1438,9 @@ mod tests {
 
     #[test]
     fn test_format_label() {
-        let input =
-            snippet::Message::error("").footer(snippet::Label::error("This __is__ a title"));
+        let input = snippet::Level::Error
+            .title("")
+            .footer(snippet::Label::error("This __is__ a title"));
         let output = from_display_lines(vec![
             DisplayLine::Raw(DisplayRawLine::Annotation {
                 annotation: Annotation {
@@ -1465,7 +1475,7 @@ mod tests {
     fn test_i26() {
         let source = "short";
         let label = "label";
-        let input = snippet::Message::error("").snippet(
+        let input = snippet::Level::Error.title("").snippet(
             snippet::Snippet::new(source)
                 .line_start(0)
                 .annotation(snippet::Label::error(label).span(0..source.len() + 2)),
@@ -1475,7 +1485,7 @@ mod tests {
 
     #[test]
     fn test_i_29() {
-        let snippets = snippet::Message::error("oops").snippet(
+        let snippets = snippet::Level::Error.title("oops").snippet(
             snippet::Snippet::new("First line\r\nSecond oops line")
                 .line_start(1)
                 .origin("<current file>")

src/renderer/mod.rs

@@ -2,8 +2,8 @@
 //!
 //! # Example
 //! ```
-//! use annotate_snippets::{Renderer, Snippet, Message};
-//! let snippet = Message::error("mismatched types")
+//! use annotate_snippets::{Renderer, Snippet, Level};
+//! let snippet = Level::Error.title("mismatched types")
 //!     .snippet(Snippet::new("Foo").line_start(51).origin("src/format.rs"))
 //!     .snippet(Snippet::new("Faa").line_start(129).origin("src/display.rs"));
 //!

src/snippet.rs

@@ -5,51 +5,25 @@
 //! ```
 //! use annotate_snippets::*;
 //!
-//! Message::error("mismatched types")
+//! Level::Error.title("mismatched types")
 //!     .snippet(Snippet::new("Foo").line_start(51).origin("src/format.rs"))
 //!     .snippet(Snippet::new("Faa").line_start(129).origin("src/display.rs"));
 //! ```
 
 use std::ops::Range;
 
 /// Primary structure provided for formatting
+///
+/// See [`Level::title`] to create a [`Message`]
 pub struct Message<'a> {
-    pub(crate) title: Label<'a>,
+    pub(crate) level: Level,
     pub(crate) id: Option<&'a str>,
+    pub(crate) title: &'a str,
     pub(crate) snippets: Vec<Snippet<'a>>,
     pub(crate) footer: Vec<Label<'a>>,
 }
 
 impl<'a> Message<'a> {
-    pub fn title(title: Label<'a>) -> Self {
-        Self {
-            title,
-            id: None,
-            snippets: vec![],
-            footer: vec![],
-        }
-    }
-
-    pub fn error(title: &'a str) -> Self {
-        Self::title(Label::error(title))
-    }
-
-    pub fn warning(title: &'a str) -> Self {
-        Self::title(Label::warning(title))
-    }
-
-    pub fn info(title: &'a str) -> Self {
-        Self::title(Label::info(title))
-    }
-
-    pub fn note(title: &'a str) -> Self {
-        Self::title(Label::note(title))
-    }
-
-    pub fn help(title: &'a str) -> Self {
-        Self::title(Label::help(title))
-    }
-
     pub fn id(mut self, id: &'a str) -> Self {
         self.id = Some(id);
         self
@@ -179,3 +153,15 @@ pub enum Level {
     Note,
     Help,
 }
+
+impl Level {
+    pub fn title(self, title: &str) -> Message<'_> {
+        Message {
+            level: self,
+            id: None,
+            title,
+            snippets: vec![],
+            footer: vec![],
+        }
+    }
+}

tests/fixtures/deserialize.rs

@@ -13,9 +13,10 @@ pub struct Fixture<'a> {
 
 #[derive(Deserialize)]
 pub struct MessageDef<'a> {
-    #[serde(deserialize_with = "deserialize_label")]
+    #[serde(with = "LevelDef")]
+    pub level: Level,
     #[serde(borrow)]
-    pub title: Label<'a>,
+    pub title: &'a str,
     #[serde(default)]
     #[serde(borrow)]
     pub id: Option<&'a str>,
@@ -31,12 +32,13 @@ pub struct MessageDef<'a> {
 impl<'a> From<MessageDef<'a>> for Message<'a> {
     fn from(val: MessageDef<'a>) -> Self {
         let MessageDef {
+            level,
             title,
             id,
             footer,
             slices,
         } = val;
-        let mut snippet = Message::title(title);
+        let mut snippet = level.title(title);
         if let Some(id) = id {
             snippet = snippet.id(id);
         }
@@ -50,20 +52,6 @@ impl<'a> From<MessageDef<'a>> for Message<'a> {
     }
 }
 
-fn deserialize_label<'de, D>(deserializer: D) -> Result<Label<'de>, D::Error>
-where
-    D: Deserializer<'de>,
-{
-    #[derive(Deserialize)]
-    struct Wrapper<'a>(
-        #[serde(with = "LabelDef")]
-        #[serde(borrow)]
-        LabelDef<'a>,
-    );
-
-    Wrapper::deserialize(deserializer).map(|Wrapper(label)| Label::new(label.level, label.label))
-}
-
 fn deserialize_labels<'de, D>(deserializer: D) -> Result<Vec<Label<'de>>, D::Error>
 where
     D: Deserializer<'de>,

tests/fixtures/no-color/issue_52.toml

@@ -1,6 +1,6 @@
-[snippet.title]
+[snippet]
 level = "Error"
-label = ""
+title = ""
 
 [[snippet.slices]]
 source = """

tests/fixtures/no-color/issue_9.toml

@@ -1,6 +1,6 @@
-[snippet.title]
-label = "expected one of `.`, `;`, `?`, or an operator, found `for`"
+[snippet]
 level = "Error"
+title = "expected one of `.`, `;`, `?`, or an operator, found `for`"
 
 [[snippet.slices]]
 source = "let x = vec![1];"

tests/fixtures/no-color/multiline_annotation.toml

@@ -1,3 +1,8 @@
+[snippet]
+level = "Error"
+id = "E0308"
+title = "mismatched types"
+
 [[snippet.slices]]
 source = """
 ) -> Option<String> {
@@ -34,7 +39,3 @@ range = [5, 19]
 label = "expected enum `std::option::Option`, found ()"
 level = "Error"
 range = [22, 766]
-
-[snippet]
-title = { level = "Error", label = "mismatched types" }
-id = "E0308"

tests/fixtures/no-color/multiline_annotation2.toml

@@ -1,3 +1,8 @@
+[snippet]
+level = "Error"
+id = "E0027"
+title = "pattern does not mention fields `lineno`, `content`"
+
 [[snippet.slices]]
 source = """
                         if let DisplayLine::Source {
@@ -11,7 +16,3 @@ fold = false
 label = "missing fields `lineno`, `content`"
 level = "Error"
 range = [31, 128]
-
-[snippet]
-title = { level = "Error", label = "pattern does not mention fields `lineno`, `content`" }
-id = "E0027"

tests/fixtures/no-color/multiline_annotation3.toml

@@ -1,3 +1,8 @@
+[snippet]
+level = "Error"
+id = "E####"
+title = "spacing error found"
+
 [[snippet.slices]]
 source = """
 This is an exampl
@@ -11,7 +16,3 @@ fold = false
 label = "this should not be on separate lines"
 level = "Error"
 range = [11, 18]
-
-[snippet]
-title = { level = "Error", label = "spacing error found" }
-id = "E####"

tests/fixtures/no-color/multiple_annotations.toml

@@ -1,6 +1,6 @@
-[snippet.title]
+[snippet]
 level = "Error"
-label = ""
+title = ""
 
 [[snippet.slices]]
 source = """

tests/fixtures/no-color/one_past.toml

@@ -1,6 +1,6 @@
-[snippet.title]
-label = "expected `.`, `=`"
+[snippet]
 level = "Error"
+title = "expected `.`, `=`"
 
 [[snippet.slices]]
 source = "asdf"

tests/fixtures/no-color/simple.toml

@@ -1,3 +1,7 @@
+[snippet]
+level = "Error"
+title = "expected one of `.`, `;`, `?`, or an operator, found `for`"
+
 [[snippet.slices]]
 source = """
         })
@@ -13,6 +17,3 @@ range = [20, 23]
 label = "expected one of `.`, `;`, `?`, or an operator here"
 level = "Warning"
 range = [10, 11]
-[snippet.title]
-label = "expected one of `.`, `;`, `?`, or an operator, found `for`"
-level = "Error"