Skip to content

Commit 8e5162b

Browse files
committed
d updated markdown snippets
1 parent aa2598a commit 8e5162b

File tree

1 file changed

+23
-4
lines changed

1 file changed

+23
-4
lines changed

approvaltests/docs/Scrubbers.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
* [Date Scrubbing](#date-scrubbing)
1212
* [How to do it](#how-to-do-it)
1313
* [Supported formats](#supported-formats)
14+
* [Scrubbing multiple parts of a string](#scrubbing-multiple-parts-of-a-string)
1415
* [Using templates](#using-templates)<!-- endToc -->
1516

1617
![scrubber flow](https://raw.githubusercontent.com/approvals/ApprovalTests.cpp/master/doc/images/ScrubberOverview.png)
@@ -36,7 +37,7 @@ String[] guids = {"2fd78d4a-ad49-447d-96a8-deda585a9aa5",
3637
"2fd78d4a-ad49-447d-96a8-deda585a9aa5",
3738
"2fd78d4a-ad49-447d-96a8-deda585a9aa5 and text"};
3839
```
39-
<sup><a href='/approvaltests-tests/src/test/java/org/approvaltests/scrubbers/ScrubberTest.java#L31-L37' title='Snippet source file'>snippet source</a> | <a href='#snippet-guid-scrubbing-1' title='Start of snippet'>anchor</a></sup>
40+
<sup><a href='/approvaltests-tests/src/test/java/org/approvaltests/scrubbers/ScrubberTest.java#L32-L38' title='Snippet source file'>snippet source</a> | <a href='#snippet-guid-scrubbing-1' title='Start of snippet'>anchor</a></sup>
4041
<!-- endSnippet -->
4142
You can make this output deterministic by using a scrubber in the options.
4243
For example:
@@ -45,7 +46,7 @@ For example:
4546
```java
4647
Approvals.verifyAll("guids", guids, new Options(Scrubbers::scrubGuid));
4748
```
48-
<sup><a href='/approvaltests-tests/src/test/java/org/approvaltests/scrubbers/ScrubberTest.java#L38-L40' title='Snippet source file'>snippet source</a> | <a href='#snippet-guid-scrubbing-2' title='Start of snippet'>anchor</a></sup>
49+
<sup><a href='/approvaltests-tests/src/test/java/org/approvaltests/scrubbers/ScrubberTest.java#L39-L41' title='Snippet source file'>snippet source</a> | <a href='#snippet-guid-scrubbing-2' title='Start of snippet'>anchor</a></sup>
4950
<!-- endSnippet -->
5051
**Note:** Options is available on all Approvals.verify methods.
5152
This will result in the following `.approved.txt` file
@@ -123,17 +124,35 @@ created at [Date1]
123124
| 2020-9-10T08:07Z | \d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}Z |
124125
| 2020-09-10T08:07:89Z | \d{4}-\d{1,2}-\d{1,2}T\d{1,2}:\d{2}:\d{2}Z |
125126
| 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 |
127+
| 20210505T091112Z | \d{8}T\d{6}Z |
126128
<!-- endInclude -->
127129

128130
## Scrubbing multiple parts of a string
129131

130132
If you need to do scrubbing of multiple things, the easiest way is to create multiple scrubbers and then combine them.
131133

132-
snippet: MultiScrubber
134+
<!-- snippet: MultiScrubber -->
135+
<a id='snippet-multiscrubber'></a>
136+
```java
137+
final Scrubber portScrubber = new RegExScrubber(":\\d+/", ":[port]/");
138+
final Scrubber dateScrubber = DateScrubber.getScrubberFor("20210505T091112Z");
139+
final Scrubber signatureScrubber = new RegExScrubber("Signature=.+", "Signature=[signature]");
140+
Scrubber scrubber = Scrubbers.scrubAll(portScrubber, dateScrubber, signatureScrubber);
141+
Approvals.verify("http://127.0.0.1:55079/foo/bar?Date=20210505T091112Z&Signature=4a7dd6f09c1e",
142+
new Options(scrubber));
143+
```
144+
<sup><a href='/approvaltests-tests/src/test/java/org/approvaltests/scrubbers/ScrubberTest.java#L46-L53' title='Snippet source file'>snippet source</a> | <a href='#snippet-multiscrubber' title='Start of snippet'>anchor</a></sup>
145+
<!-- endSnippet -->
133146

134147
will result in
135148

136-
snippet: ScrubberTest.scrubMultipleThings.approved.txt
149+
<!-- snippet: ScrubberTest.scrubMultipleThings.approved.txt -->
150+
<a id='snippet-ScrubberTest.scrubMultipleThings.approved.txt'></a>
151+
```txt
152+
http://127.0.0.1:[port]/foo/bar?Date=[Date1]&Signature=[signature]
153+
```
154+
<sup><a href='/approvaltests-tests/src/test/java/org/approvaltests/scrubbers/ScrubberTest.scrubMultipleThings.approved.txt#L1-L1' title='Snippet source file'>snippet source</a> | <a href='#snippet-ScrubberTest.scrubMultipleThings.approved.txt' title='Start of snippet'>anchor</a></sup>
155+
<!-- endSnippet -->
137156

138157
## Using templates
139158

0 commit comments

Comments
 (0)