- r clean up

Co-Authored-By: Llewellyn Falco <[email protected]>
Co-Authored-By: 4dsherwood <[email protected]>

Author: 3 people

.windsurf/CodeStyle.md

@@ -5,6 +5,7 @@
 Remove all comments from the code.
 If the comment is explaining a block of code, extract the block as a reusable method and give it a name
 If the comment is explaining a variable, extract one with a name or give an existing variable a better name
+Keep comments related to .md snippets (these comments will start with // begin-snippet and end with // end-snippet)
 
 ## Testing Console output
 

approvaltests-tests/src/test/java/org/approvaltests/scrubbers/DateScrubberTest.java

@@ -18,7 +18,6 @@
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import org.approvaltests.reporters.UseReporter;
 import org.approvaltests.reporters.AutoApproveReporter;
-import org.approvaltests.reporters.BeyondCompareReporter;
 
 public class DateScrubberTest
 {
@@ -109,30 +108,27 @@ void testUtilDate()
   @Test
   void testAddScrubberWithValidRegexAndExample()
   {
-    // Clear any existing custom scrubbers
-    DateScrubber.clearCustomScrubbers();
-    // Add a custom scrubber with valid regex and example
-    DateScrubber.addScrubber("2023-Dec-25", "\\d{4}-[A-Za-z]{3}-\\d{2}");
-    // Test that the custom scrubber works
-    DateScrubber scrubber = DateScrubber.getScrubberFor("2024-Jan-15");
-    assertEquals("[Date1]", scrubber.scrub("2024-Jan-15"));
+    try
+    {
+      DateScrubber.addScrubber("2023-Dec-25", "\\d{4}-[A-Za-z]{3}-\\d{2}");
+      DateScrubber scrubber = DateScrubber.getScrubberFor("2024-Jan-15");
+      assertEquals("[Date1]", scrubber.scrub("2024-Jan-15"));
+    }
+    finally
+    {
+      DateScrubber.clearCustomScrubbers();
+    }
   }
   @Test
   void testAddScrubberWithInvalidRegex()
   {
-    // Clear any existing custom scrubbers
-    DateScrubber.clearCustomScrubbers();
-    // Test that invalid regex throws an exception
     assertThrows(IllegalArgumentException.class, () -> {
       DateScrubber.addScrubber("2023-Dec-25", "[invalid regex");
     });
   }
   @Test
   void testAddScrubberWithRegexThatDoesntMatchExample()
   {
-    // Clear any existing custom scrubbers
-    DateScrubber.clearCustomScrubbers();
-    // Test that regex that doesn't match example throws an exception
     assertThrows(IllegalArgumentException.class, () -> {
       DateScrubber.addScrubber("2023-Dec-25", "\\d{2}-\\d{2}-\\d{4}");
     });
@@ -150,70 +146,86 @@ void testAddScrubberDisplaysMessage()
         To suppress this message, use:
             DateScrubber.addScrubber("<date format>", "<regex>", false)
         """;
-    // Clear any existing custom scrubbers
-    DateScrubber.clearCustomScrubbers();
-    // Capture system output to verify message is displayed
-    try (ConsoleOutput console = new ConsoleOutput())
+    try
     {
-      DateScrubber.addScrubber("2023-Dec-25", "\\d{4}-[A-Za-z]{3}-\\d{2}");
-      console.verifyOutput(new Options().inline(expected));
+      try (ConsoleOutput console = new ConsoleOutput())
+      {
+        DateScrubber.addScrubber("2023-Dec-25", "\\d{4}-[A-Za-z]{3}-\\d{2}");
+        console.verifyOutput(new Options().inline(expected));
+      }
+    }
+    finally
+    {
+      DateScrubber.clearCustomScrubbers();
     }
   }
   @Test
   void testAddScrubberSuppressMessage()
   {
-    // Clear any existing custom scrubbers
-    DateScrubber.clearCustomScrubbers();
-    // Capture system output to verify message is NOT displayed
-    try (ConsoleOutput console = new ConsoleOutput())
+    try
     {
-      DateScrubber.addScrubber("2023-Dec-25", "\\d{4}-[A-Za-z]{3}-\\d{2}", false);
-      String output = console.getOutput();
-      assertEquals("", output);
+      try (ConsoleOutput console = new ConsoleOutput())
+      {
+        DateScrubber.addScrubber("2023-Dec-25", "\\d{4}-[A-Za-z]{3}-\\d{2}", false);
+        String output = console.getOutput();
+        assertEquals("", output);
+      }
+    }
+    finally
+    {
+      DateScrubber.clearCustomScrubbers();
     }
   }
   @Test
   void testCustomScrubberIntegrationWithGetScrubberFor()
   {
-    // Clear any existing custom scrubbers
-    DateScrubber.clearCustomScrubbers();
-    // Add a custom scrubber - use a unique pattern that doesn't conflict with built-ins
-    DateScrubber.addScrubber("2023-Dec-25", "\\d{4}-[A-Za-z]{3}-\\d{2}", false);
-    // Test that getScrubberFor finds the custom scrubber
-    DateScrubber scrubber = DateScrubber.getScrubberFor("2024-Jan-15");
-    assertEquals("[Date1]", scrubber.scrub("2024-Jan-15"));
-    // Test that it works with different examples matching the pattern
-    assertEquals("[Date1]", scrubber.scrub("2025-Mar-30"));
-    assertEquals("Meeting on [Date1] at noon", scrubber.scrub("Meeting on 2024-Jan-15 at noon"));
-    assertEquals("Due date: [Date1]", scrubber.scrub("Due date: 2025-Mar-30"));
+    try
+    {
+      DateScrubber.addScrubber("2023-Dec-25", "\\d{4}-[A-Za-z]{3}-\\d{2}", false);
+      DateScrubber scrubber = DateScrubber.getScrubberFor("2024-Jan-15");
+      assertEquals("[Date1]", scrubber.scrub("2024-Jan-15"));
+      assertEquals("[Date1]", scrubber.scrub("2025-Mar-30"));
+      assertEquals("Meeting on [Date1] at noon", scrubber.scrub("Meeting on 2024-Jan-15 at noon"));
+      assertEquals("Due date: [Date1]", scrubber.scrub("Due date: 2025-Mar-30"));
+    }
+    finally
+    {
+      DateScrubber.clearCustomScrubbers();
+    }
   }
   @Test
   void testClearCustomScrubbers()
   {
-    // Add a custom scrubber
-    DateScrubber.addScrubber("2023-Dec-25", "\\d{4}-[A-Za-z]{3}-\\d{2}", false);
-    // Verify it works
-    DateScrubber scrubber = DateScrubber.getScrubberFor("2024-Jan-15");
-    assertEquals("[Date1]", scrubber.scrub("2024-Jan-15"));
-    // Clear custom scrubbers
-    DateScrubber.clearCustomScrubbers();
-    // Verify the custom scrubber no longer works
-    assertThrows(Exception.class, () -> {
-      DateScrubber.getScrubberFor("2024-Jan-15");
-    });
+    try
+    {
+      DateScrubber.addScrubber("2023-Dec-25", "\\d{4}-[A-Za-z]{3}-\\d{2}", false);
+      DateScrubber scrubber = DateScrubber.getScrubberFor("2024-Jan-15");
+      assertEquals("[Date1]", scrubber.scrub("2024-Jan-15"));
+      DateScrubber.clearCustomScrubbers();
+      assertThrows(Exception.class, () -> {
+        DateScrubber.getScrubberFor("2024-Jan-15");
+      });
+    }
+    finally
+    {
+      DateScrubber.clearCustomScrubbers();
+    }
   }
   @Test
   void testMultipleCustomScrubbers()
   {
-    // Clear any existing custom scrubbers
-    DateScrubber.clearCustomScrubbers();
-    // Add multiple custom scrubbers
-    DateScrubber.addScrubber("2023-Dec-25", "\\d{4}-[A-Za-z]{3}-\\d{2}", false);
-    DateScrubber.addScrubber("25/Dec/2023", "\\d{2}/[A-Za-z]{3}/\\d{4}", false);
-    // Test both custom scrubbers work
-    DateScrubber scrubber1 = DateScrubber.getScrubberFor("2024-Jan-15");
-    assertEquals("[Date1]", scrubber1.scrub("2024-Jan-15"));
-    DateScrubber scrubber2 = DateScrubber.getScrubberFor("15/Jan/2024");
-    assertEquals("[Date1]", scrubber2.scrub("15/Jan/2024"));
+    try
+    {
+      DateScrubber.addScrubber("2023-Dec-25", "\\d{4}-[A-Za-z]{3}-\\d{2}", false);
+      DateScrubber.addScrubber("25/Dec/2023", "\\d{2}/[A-Za-z]{3}/\\d{4}", false);
+      DateScrubber scrubber1 = DateScrubber.getScrubberFor("2024-Jan-15");
+      assertEquals("[Date1]", scrubber1.scrub("2024-Jan-15"));
+      DateScrubber scrubber2 = DateScrubber.getScrubberFor("15/Jan/2024");
+      assertEquals("[Date1]", scrubber2.scrub("15/Jan/2024"));
+    }
+    finally
+    {
+      DateScrubber.clearCustomScrubbers();
+    }
   }
 }

approvaltests/src/main/java/org/approvaltests/utils/ConsoleOutput.java

@@ -12,7 +12,6 @@ public class ConsoleOutput implements AutoCloseable
   private final ByteArrayOutputStream errContent;
   private final PrintStream           originalOut;
   private final PrintStream           originalErr;
-
   public ConsoleOutput()
   {
     originalOut = System.out;
@@ -22,48 +21,39 @@ public ConsoleOutput()
     System.setOut(new PrintStream(outContent));
     System.setErr(new PrintStream(errContent));
   }
-
   public String getOutput()
   {
     return outContent.toString();
   }
-
   public String getError()
   {
     return errContent.toString();
   }
-
   public void verifyOutput()
   {
     verifyOutput(new Options());
   }
-
   public void verifyOutput(Options options)
   {
     Approvals.verify(getOutput(), options);
   }
-
   public void verifyError()
   {
     Approvals.verify(getError());
   }
-
   public void verifyError(Options options)
   {
     Approvals.verify(getError(), options);
   }
-
   public void verifyAll()
   {
     verifyAll(new Options());
   }
-
   public void verifyAll(Options options)
   {
     String combined = "Output:\n" + getOutput() + "\nError:\n" + getError();
     Approvals.verify(combined, options);
   }
-
   @Override
   public void close()
   {