feat(assert): Allow disabling path normalization

This handles the snapbox side of assert-rs#91.  We'll need to update the plumbing
in trycmd to get this to all the right places.  For now this also lets
us experiment with it where we can more easily change the API.

We still normalize paths when inserting substitions.  The two APIs
aren't connected at the moment to allow fixing this.  This will need
more consideration.

Author: epage

crates/snapbox/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 <!-- next-header -->
 ## [Unreleased] - ReleaseDate
 
+### Features
+
+- Added `Assert::normalize_paths` to allow disabling path normalization
+
 ## [0.3.0] - 2022-08-01
 
 ### Breaking Changes

crates/snapbox/src/assert.rs

@@ -17,6 +17,7 @@ use crate::Action;
 pub struct Assert {
     action: Action,
     action_var: Option<String>,
+    normalize_paths: bool,
     substitutions: crate::Substitutions,
     pub(crate) palette: crate::report::Palette,
     pub(crate) data_format: Option<DataFormat>,
@@ -186,7 +187,7 @@ impl Assert {
 
         actual = actual
             .try_coerce(format)
-            .map_text(crate::utils::normalize_text);
+            .map_text(|s| self.normalize_text(s));
 
         (expected, actual)
     }
@@ -205,7 +206,7 @@ impl Assert {
         {
             actual = actual
                 .try_coerce(format)
-                .map_text(crate::utils::normalize_text)
+                .map_text(|s| self.normalize_text(s))
                 .map_text(|t| self.substitutions.normalize(t, expected));
         }
 
@@ -289,6 +290,14 @@ impl Assert {
             Ok(())
         }
     }
+
+    fn normalize_text(&self, data: &str) -> String {
+        let mut data = crate::utils::normalize_lines(data);
+        if self.normalize_paths {
+            data = crate::utils::normalize_paths(&data);
+        }
+        data
+    }
 }
 
 /// # Directory Assertions
@@ -485,6 +494,14 @@ impl Assert {
         self
     }
 
+    /// Specify whether text should have path separators normalized
+    ///
+    /// The default is normalized
+    pub fn normalize_paths(mut self, yes: bool) -> Self {
+        self.normalize_paths = yes;
+        self
+    }
+
     /// Specify whether the content should be treated as binary or not
     ///
     /// The default is to auto-detect
@@ -507,6 +524,7 @@ impl Default for Assert {
         Self {
             action: Default::default(),
             action_var: Default::default(),
+            normalize_paths: true,
             substitutions: Default::default(),
             palette: crate::report::Palette::auto(),
             data_format: Default::default(),

crates/snapbox/src/utils/mod.rs

@@ -4,7 +4,20 @@ pub use lines::LinesWithTerminator;
 
 /// Normalize line endings
 pub fn normalize_lines(data: &str) -> String {
-    normalize_line_endings::normalized(data.chars()).collect()
+    normalize_lines_chars(data.chars()).collect()
+}
+
+fn normalize_lines_chars(data: impl Iterator<Item = char>) -> impl Iterator<Item = char> {
+    normalize_line_endings::normalized(data)
+}
+
+/// Normalize path separators
+pub fn normalize_paths(data: &str) -> String {
+    normalize_paths_chars(data.chars()).collect()
+}
+
+fn normalize_paths_chars(data: impl Iterator<Item = char>) -> impl Iterator<Item = char> {
+    data.map(|c| if c == '\\' { '/' } else { c })
 }
 
 /// "Smart" text normalization
@@ -13,8 +26,5 @@ pub fn normalize_lines(data: &str) -> String {
 /// - Line endings
 /// - Path separators
 pub fn normalize_text(data: &str) -> String {
-    normalize_line_endings::normalized(data.chars())
-        // Also help out with Windows paths
-        .map(|c| if c == '\\' { '/' } else { c })
-        .collect()
+    normalize_paths_chars(normalize_lines_chars(data.chars())).collect()
 }