refactor: Transition from Substitutions to Redactions

Author: epage

crates/snapbox/src/assert/mod.rs

@@ -32,7 +32,7 @@ pub struct Assert {
     action: Action,
     action_var: Option<String>,
     normalize_paths: bool,
-    substitutions: crate::Substitutions,
+    substitutions: crate::Redactions,
     pub(crate) palette: crate::report::Palette,
 }
 
@@ -425,8 +425,8 @@ impl Assert {
         self
     }
 
-    /// Override the default [`Substitutions`][crate::Substitutions]
-    pub fn substitutions(mut self, substitutions: crate::Substitutions) -> Self {
+    /// Override the default [`Redactions`][crate::Redactions]
+    pub fn substitutions(mut self, substitutions: crate::Redactions) -> Self {
         self.substitutions = substitutions;
         self
     }
@@ -449,6 +449,6 @@ impl Default for Assert {
             substitutions: Default::default(),
             palette: crate::report::Palette::color(),
         }
-        .substitutions(crate::Substitutions::with_exe())
+        .substitutions(crate::Redactions::with_exe())
     }
 }

crates/snapbox/src/dir/diff.rs

@@ -105,7 +105,7 @@ impl PathDiff {
     pub fn subset_matches_iter(
         pattern_root: impl Into<std::path::PathBuf>,
         actual_root: impl Into<std::path::PathBuf>,
-        substitutions: &crate::Substitutions,
+        substitutions: &crate::Redactions,
     ) -> impl Iterator<Item = Result<(std::path::PathBuf, std::path::PathBuf), Self>> + '_ {
         let pattern_root = pattern_root.into();
         let actual_root = actual_root.into();
@@ -116,7 +116,7 @@ impl PathDiff {
     pub(crate) fn subset_matches_iter_inner(
         expected_root: std::path::PathBuf,
         actual_root: std::path::PathBuf,
-        substitutions: &crate::Substitutions,
+        substitutions: &crate::Redactions,
         normalize_paths: bool,
     ) -> impl Iterator<Item = Result<(std::path::PathBuf, std::path::PathBuf), Self>> + '_ {
         let walker = crate::dir::Walk::new(&expected_root);

crates/snapbox/src/filter/mod.rs

@@ -100,12 +100,12 @@ fn normalize_paths_chars(data: impl Iterator<Item = char>) -> impl Iterator<Item
 }
 
 pub struct FilterMatches<'a> {
-    substitutions: &'a crate::Substitutions,
+    substitutions: &'a crate::Redactions,
     pattern: &'a Data,
 }
 
 impl<'a> FilterMatches<'a> {
-    pub fn new(substitutions: &'a crate::Substitutions, pattern: &'a Data) -> Self {
+    pub fn new(substitutions: &'a crate::Redactions, pattern: &'a Data) -> Self {
         FilterMatches {
             substitutions,
             pattern,
@@ -173,7 +173,7 @@ fn normalize_value(value: &mut serde_json::Value, op: fn(&str) -> String) {
 fn normalize_value_matches(
     actual: &mut serde_json::Value,
     expected: &serde_json::Value,
-    substitutions: &crate::Substitutions,
+    substitutions: &crate::Redactions,
 ) {
     use serde_json::Value::*;
 

crates/trycmd/src/cases.rs

@@ -5,7 +5,7 @@ use std::borrow::Cow;
 pub struct TestCases {
     runner: std::cell::RefCell<crate::RunnerSpec>,
     bins: std::cell::RefCell<crate::BinRegistry>,
-    substitutions: std::cell::RefCell<snapbox::Substitutions>,
+    substitutions: std::cell::RefCell<snapbox::Redactions>,
     has_run: std::cell::Cell<bool>,
 }
 

crates/trycmd/src/runner.rs

@@ -36,7 +36,7 @@ impl Runner {
         &self,
         mode: &Mode,
         bins: &crate::BinRegistry,
-        substitutions: &snapbox::Substitutions,
+        substitutions: &snapbox::Redactions,
     ) {
         let palette = snapbox::report::Palette::color();
 
@@ -140,7 +140,7 @@ impl Case {
         &self,
         mode: &Mode,
         bins: &crate::BinRegistry,
-        substitutions: &snapbox::Substitutions,
+        substitutions: &snapbox::Redactions,
     ) -> Vec<Result<Output, Output>> {
         if self.expected == Some(crate::schema::CommandStatus::Skipped) {
             let output = Output::sequence(self.path.clone());
@@ -309,7 +309,7 @@ impl Case {
         step: &mut crate::schema::Step,
         cwd: Option<&std::path::Path>,
         bins: &crate::BinRegistry,
-        substitutions: &snapbox::Substitutions,
+        substitutions: &snapbox::Redactions,
     ) -> Result<Output, Output> {
         let output = if let Some(id) = step.id.clone() {
             Output::step(self.path.clone(), id)
@@ -407,7 +407,7 @@ impl Case {
         &self,
         mut output: Output,
         step: &crate::schema::Step,
-        substitutions: &snapbox::Substitutions,
+        substitutions: &snapbox::Redactions,
     ) -> Output {
         output.stdout = self.validate_stream(
             output.stdout,
@@ -430,7 +430,7 @@ impl Case {
         stream: Option<Stream>,
         expected_content: Option<&crate::Data>,
         binary: bool,
-        substitutions: &snapbox::Substitutions,
+        substitutions: &snapbox::Redactions,
     ) -> Option<Stream> {
         let mut stream = stream?;
 
@@ -497,7 +497,7 @@ impl Case {
         actual_root: &std::path::Path,
         mut fs: Filesystem,
         mode: &Mode,
-        substitutions: &snapbox::Substitutions,
+        substitutions: &snapbox::Redactions,
     ) -> Result<Filesystem, Filesystem> {
         let mut ok = true;