fix(filter): Rename FilterMatches to FilterRedactions

Author: epage

crates/snapbox/src/assert/mod.rs

@@ -8,7 +8,7 @@ use anstream::stderr;
 #[cfg(not(feature = "color"))]
 use std::io::stderr;
 
-use crate::filter::{Filter as _, FilterMatches, FilterNewlines, FilterPaths};
+use crate::filter::{Filter as _, FilterNewlines, FilterPaths, FilterRedactions};
 
 pub use action::Action;
 pub use action::DEFAULT_ACTION_ENV;
@@ -164,7 +164,7 @@ impl Assert {
         actual = FilterNewlines.filter(actual);
 
         // If expected is not an error normalize matches
-        actual = FilterMatches::new(&self.substitutions, &expected).filter(actual);
+        actual = FilterRedactions::new(&self.substitutions, &expected).filter(actual);
 
         (expected, actual)
     }

crates/snapbox/src/data/normalize.rs

@@ -20,5 +20,5 @@ impl Normalize for NormalizePaths {
     }
 }
 
-#[deprecated(since = "0.5.11", note = "Replaced with `filter::FilterMatches")]
-pub type NormalizeMatches<'a> = crate::filter::FilterMatches<'a>;
+#[deprecated(since = "0.5.11", note = "Replaced with `filter::FilterRedactions")]
+pub type NormalizeMatches<'a> = crate::filter::FilterRedactions<'a>;

crates/snapbox/src/dir/diff.rs

@@ -1,5 +1,5 @@
 #[cfg(feature = "dir")]
-use crate::filter::{Filter as _, FilterMatches, FilterNewlines, FilterPaths};
+use crate::filter::{Filter as _, FilterNewlines, FilterPaths, FilterRedactions};
 
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub enum PathDiff {
@@ -160,7 +160,7 @@ impl PathDiff {
                     if normalize_paths {
                         actual = FilterPaths.filter(actual);
                     }
-                    actual = FilterMatches::new(substitutions, &expected)
+                    actual = FilterRedactions::new(substitutions, &expected)
                         .filter(FilterNewlines.filter(actual));
 
                     if expected != actual {

crates/snapbox/src/filter/mod.rs

@@ -99,21 +99,21 @@ fn normalize_paths_chars(data: impl Iterator<Item = char>) -> impl Iterator<Item
     data.map(|c| if c == '\\' { '/' } else { c })
 }
 
-pub struct FilterMatches<'a> {
+pub struct FilterRedactions<'a> {
     substitutions: &'a crate::Redactions,
     pattern: &'a Data,
 }
 
-impl<'a> FilterMatches<'a> {
+impl<'a> FilterRedactions<'a> {
     pub fn new(substitutions: &'a crate::Redactions, pattern: &'a Data) -> Self {
-        FilterMatches {
+        FilterRedactions {
             substitutions,
             pattern,
         }
     }
 }
 
-impl Filter for FilterMatches<'_> {
+impl Filter for FilterRedactions<'_> {
     fn normalize(&self, data: Data) -> Data {
         let source = data.source;
         let inner = match data.inner {

crates/snapbox/src/filter/test.rs

@@ -97,7 +97,7 @@ fn json_normalize_matches_string() {
     let exp = json!({"name": "{...}"});
     let expected = Data::json(exp);
     let actual = json!({"name": "JohnDoe"});
-    let actual = FilterMatches::new(&Default::default(), &expected).filter(Data::json(actual));
+    let actual = FilterRedactions::new(&Default::default(), &expected).filter(Data::json(actual));
     if let (DataInner::Json(exp), DataInner::Json(act)) = (expected.inner, actual.inner) {
         assert_eq!(exp, act);
     }
@@ -116,7 +116,7 @@ fn json_normalize_matches_array() {
             }
         ]
     });
-    let actual = FilterMatches::new(&Default::default(), &expected).filter(Data::json(actual));
+    let actual = FilterRedactions::new(&Default::default(), &expected).filter(Data::json(actual));
     if let (DataInner::Json(exp), DataInner::Json(act)) = (expected.inner, actual.inner) {
         assert_eq!(exp, act);
     }
@@ -133,7 +133,7 @@ fn json_normalize_matches_obj() {
             "nickname": "John",
         }
     });
-    let actual = FilterMatches::new(&Default::default(), &expected).filter(Data::json(actual));
+    let actual = FilterRedactions::new(&Default::default(), &expected).filter(Data::json(actual));
     if let (DataInner::Json(exp), DataInner::Json(act)) = (expected.inner, actual.inner) {
         assert_eq!(exp, act);
     }
@@ -149,7 +149,7 @@ fn json_normalize_matches_diff_order_array() {
     let actual = json!({
         "people": ["Jane", "John"]
     });
-    let actual = FilterMatches::new(&Default::default(), &expected).filter(Data::json(actual));
+    let actual = FilterRedactions::new(&Default::default(), &expected).filter(Data::json(actual));
     if let (DataInner::Json(exp), DataInner::Json(act)) = (expected.inner, actual.inner) {
         assert_ne!(exp, act);
     }
@@ -184,7 +184,7 @@ fn json_normalize_wildcard_object_first() {
             }
         ]
     });
-    let actual = FilterMatches::new(&Default::default(), &expected).filter(Data::json(actual));
+    let actual = FilterRedactions::new(&Default::default(), &expected).filter(Data::json(actual));
     if let (DataInner::Json(exp), DataInner::Json(act)) = (expected.inner, actual.inner) {
         assert_eq!(exp, act);
     }
@@ -215,7 +215,7 @@ fn json_normalize_wildcard_array_first() {
             "nickname": "3",
         }
     ]);
-    let actual = FilterMatches::new(&Default::default(), &expected).filter(Data::json(actual));
+    let actual = FilterRedactions::new(&Default::default(), &expected).filter(Data::json(actual));
     if let (DataInner::Json(exp), DataInner::Json(act)) = (expected.inner, actual.inner) {
         assert_eq!(exp, act);
     }
@@ -251,7 +251,7 @@ fn json_normalize_wildcard_array_first_last() {
             "nickname": "4",
         }
     ]);
-    let actual = FilterMatches::new(&Default::default(), &expected).filter(Data::json(actual));
+    let actual = FilterRedactions::new(&Default::default(), &expected).filter(Data::json(actual));
     if let (DataInner::Json(exp), DataInner::Json(act)) = (expected.inner, actual.inner) {
         assert_eq!(exp, act);
     }
@@ -295,7 +295,7 @@ fn json_normalize_wildcard_array_middle_last() {
             "nickname": "5",
         }
     ]);
-    let actual = FilterMatches::new(&Default::default(), &expected).filter(Data::json(actual));
+    let actual = FilterRedactions::new(&Default::default(), &expected).filter(Data::json(actual));
     if let (DataInner::Json(exp), DataInner::Json(act)) = (expected.inner, actual.inner) {
         assert_eq!(exp, act);
     }
@@ -336,7 +336,7 @@ fn json_normalize_wildcard_array_middle_last_early_return() {
         }
     ]);
     let actual_normalized =
-        FilterMatches::new(&Default::default(), &expected).filter(Data::json(actual.clone()));
+        FilterRedactions::new(&Default::default(), &expected).filter(Data::json(actual.clone()));
     if let DataInner::Json(act) = actual_normalized.inner {
         assert_eq!(act, actual);
     }

crates/trycmd/src/runner.rs

@@ -14,7 +14,7 @@ use std::io::stderr;
 use rayon::prelude::*;
 use snapbox::data::DataFormat;
 use snapbox::dir::FileType;
-use snapbox::filter::{Filter as _, FilterMatches, FilterNewlines, FilterPaths};
+use snapbox::filter::{Filter as _, FilterNewlines, FilterPaths, FilterRedactions};
 
 #[derive(Debug)]
 pub(crate) struct Runner {
@@ -443,7 +443,7 @@ impl Case {
 
         if let Some(expected_content) = expected_content {
             stream.content =
-                FilterMatches::new(substitutions, expected_content).filter(stream.content);
+                FilterRedactions::new(substitutions, expected_content).filter(stream.content);
 
             if stream.content != *expected_content {
                 stream.status = StreamStatus::Expected(expected_content.clone());