. dt documentation for date scrubber

Author: hownowstephen

date_scrubber_test.go

@@ -2,6 +2,7 @@ package approvals_test
 
 import (
 	"fmt"
+	"strings"
 	"testing"
 
 	approvals "github.com/approvals/go-approval-tests"
@@ -38,7 +39,7 @@ func TestGetDateScrubber(t *testing.T) {
 }
 
 func TestExampleForDocumentation(t *testing.T) {
-	// begin-snippet: scrub-date-example
+	// begin-snippet: scrub_date_example
 	scrubber, err := approvals.GetDateScrubberFor("00:00:00")
 	if err != nil {
 		t.Error(err)
@@ -47,9 +48,15 @@ func TestExampleForDocumentation(t *testing.T) {
 	// end-snippet
 }
 
-//   @Test
-//   void supportedFormats()
-//   {
-//     VelocityApprovals.verify(c -> c.put("formats", DateScrubber.getSupportedFormats()),
-//         new Options().forFile().withExtension(".md"));
-//   }
+func TestSupportedFormats(t *testing.T) {
+	formats := approvals.GetSupportedFormats()
+
+	table := "| Example Date | RegEx Pattern |\n"
+	table += "| :-------------------- | :----------------------- |\n"
+
+	for _, f := range formats {
+		table += fmt.Sprintf("| %s | `%s` |\n", f.Examples[0], strings.ReplaceAll(f.Regex, "|", `\|`))
+	}
+
+	approvals.VerifyString(t, table, approvals.Options().ForFile().WithExtension(".md"))
+}

docs/how_to/ScrubDates.md

@@ -0,0 +1,54 @@
+# How to scrub dates
+
+<!-- toc -->
+## Contents
+
+  * [Supported formats](#supported-formats)<!-- endToc -->
+
+The easiest way to scrub a date is by calling
+
+<!-- snippet: scrub_date_example -->
+<a id='snippet-scrub_date_example'></a>
+```go
+scrubber, err := approvals.GetDateScrubberFor("00:00:00")
+if err != nil {
+	t.Error(err)
+}
+approvals.VerifyString(t, "created at 03:14:15", approvals.Options().WithScrubber(scrubber))
+```
+<sup><a href='/date_scrubber_test.go#L42-L48' title='Snippet source file'>snippet source</a> | <a href='#snippet-scrub_date_example' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+which will produce
+
+<!-- snippet: date_scrubber_test.TestExampleForDocumentation.approved.txt -->
+<a id='snippet-date_scrubber_test.TestExampleForDocumentation.approved.txt'></a>
+```txt
+created at [Date1]
+```
+<sup><a href='/testdata/date_scrubber_test.TestExampleForDocumentation.approved.txt#L1-L1' title='Snippet source file'>snippet source</a> | <a href='#snippet-date_scrubber_test.TestExampleForDocumentation.approved.txt' title='Start of snippet'>anchor</a></sup>
+<!-- endSnippet -->
+
+## Supported formats
+
+<!-- include: date_scrubber_test.TestSupportedFormats.approved.md -->
+| Example Date | RegEx Pattern |
+| :-------------------- | :----------------------- |
+| Tue May 13 16:30:00 | `[a-zA-Z]{3} [a-zA-Z]{3} \d{2} \d{2}:\d{2}:\d{2}` |
+| Wed Nov 17 22:28:33 EET 2021 | `[a-zA-Z]{3} [a-zA-Z]{3} \d{2} \d{2}:\d{2}:\d{2} [a-zA-Z]{3,4} \d{4}` |
+| Wed, 21 Oct 2015 07:28:00 GMT | `(Mon\|Tue\|Wed\|Thu\|Fri\|Sat\|Sun), \d{2} (Jan\|Feb\|Mar\|Apr\|May\|Jun\|Jul\|Aug\|Sep\|Oct\|Nov\|Dec) \d{4} \d{2}:\d{2}:\d{2} GMT` |
+| Tue May 13 2014 23:30:00.789 | `[a-zA-Z]{3} [a-zA-Z]{3} \d{2} \d{4} \d{2}:\d{2}:\d{2}.\d{3}` |
+| Tue May 13 16:30:00 -0800 2014 | `[a-zA-Z]{3} [a-zA-Z]{3} \d{2} \d{2}:\d{2}:\d{2} -\d{4} \d{4}` |
+| 13 May 2014 23:50:49,999 | `\d{2} [a-zA-Z]{3} \d{4} \d{2}:\d{2}:\d{2},\d{3}` |
+| Oct 13 15:29 | `[A-Za-z]{3} \d{2} \d{2}:\d{2}` |
+| May 13, 2014 11:30:00 PM PST | `[a-zA-Z]{3} \d{2}, \d{4} \d{2}:\d{2}:\d{2} [a-zA-Z]{2} [a-zA-Z]{3}` |
+| 23:30:00 | `\d{2}:\d{2}:\d{2}` |
+| 2014/05/13 16:30:59.786 | `\d{4}/\d{2}/\d{2} \d{2}:\d{2}:\d{2}(\.\d{3})?` |
+| 2020-9-10T08:07Z | `\d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}Z` |
+| 2020-09-10T08:07:89Z | `\d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}:\d{2}Z` |
+| 2020-09-10T01:23:45.678Z | `\d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}\:\d{2}\.\d{3}Z` |
+| 20210505T091112Z | `\d{8}T\d{6}Z` |
+| 2024-12-17 | `\d{4}-\d{2}-\d{2}` |
+| 2024-12-18T14:04:46.746130Z | `\d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}:\d{2}(\.\d{1,9})?Z` |
+| 13/05/2014 23:50:49 | `\d{2}[-/.]\d{2}[-/.]\d{4}\s\d{2}:\d{2}(:\d{2})?( (?:pm\|am\|PM\|AM))?` |
+<!-- endInclude -->

testdata/date_scrubber_test.TestSupportedFormats.approved.md

@@ -0,0 +1,19 @@
+| Example Date | RegEx Pattern |
+| :-------------------- | :----------------------- |
+| Tue May 13 16:30:00 | `[a-zA-Z]{3} [a-zA-Z]{3} \d{2} \d{2}:\d{2}:\d{2}` |
+| Wed Nov 17 22:28:33 EET 2021 | `[a-zA-Z]{3} [a-zA-Z]{3} \d{2} \d{2}:\d{2}:\d{2} [a-zA-Z]{3,4} \d{4}` |
+| Wed, 21 Oct 2015 07:28:00 GMT | `(Mon\|Tue\|Wed\|Thu\|Fri\|Sat\|Sun), \d{2} (Jan\|Feb\|Mar\|Apr\|May\|Jun\|Jul\|Aug\|Sep\|Oct\|Nov\|Dec) \d{4} \d{2}:\d{2}:\d{2} GMT` |
+| Tue May 13 2014 23:30:00.789 | `[a-zA-Z]{3} [a-zA-Z]{3} \d{2} \d{4} \d{2}:\d{2}:\d{2}.\d{3}` |
+| Tue May 13 16:30:00 -0800 2014 | `[a-zA-Z]{3} [a-zA-Z]{3} \d{2} \d{2}:\d{2}:\d{2} -\d{4} \d{4}` |
+| 13 May 2014 23:50:49,999 | `\d{2} [a-zA-Z]{3} \d{4} \d{2}:\d{2}:\d{2},\d{3}` |
+| Oct 13 15:29 | `[A-Za-z]{3} \d{2} \d{2}:\d{2}` |
+| May 13, 2014 11:30:00 PM PST | `[a-zA-Z]{3} \d{2}, \d{4} \d{2}:\d{2}:\d{2} [a-zA-Z]{2} [a-zA-Z]{3}` |
+| 23:30:00 | `\d{2}:\d{2}:\d{2}` |
+| 2014/05/13 16:30:59.786 | `\d{4}/\d{2}/\d{2} \d{2}:\d{2}:\d{2}(\.\d{3})?` |
+| 2020-9-10T08:07Z | `\d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}Z` |
+| 2020-09-10T08:07:89Z | `\d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}:\d{2}Z` |
+| 2020-09-10T01:23:45.678Z | `\d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}\:\d{2}\.\d{3}Z` |
+| 20210505T091112Z | `\d{8}T\d{6}Z` |
+| 2024-12-17 | `\d{4}-\d{2}-\d{2}` |
+| 2024-12-18T14:04:46.746130Z | `\d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}:\d{2}(\.\d{1,9})?Z` |
+| 13/05/2014 23:50:49 | `\d{2}[-/.]\d{2}[-/.]\d{4}\s\d{2}:\d{2}(:\d{2})?( (?:pm\|am\|PM\|AM))?` |