This is a public, read-only report. Striff reads this repository's docs, turns each sentence that makes a claim about the code into a rule, and checks the rule against the code on the default branch. How this works
Each sentence below has a stale name: a type the default branch doesn't declare, or declares somewhere else. Edit the doc so it matches the code, or bring the type back.
GoneRegexScrubber
The link:{javadoc-url}/core/org/approvej/scrub/RegexScrubber.html[RegexScrubber] already allows for a lot of special custom cases.
The repository once had modules/core/src/main/java/org/approvej/scrub/RegexScrubber.java. It doesn't now. Closest names there: RegexScrubberRecord, Scrubber.
You can make this explicit by using the link:{javadoc-url}/core/org/approvej/approve/PathProviderBuilder.html#nextToTest()[PathProviderBuilder.nextToTest()] method.
The repository once had modules/core/src/main/java/org/approvej/approve/PathProviderBuilder.java. It doesn't now. Closest name there: PathProvider.
ApprovalBuilder.approve(value) with fluent methods .printedAs(), .scrubbedOf(), .byFile().
4 rules from this sentence
ApprovalBuilder has an approve method
Holds
ApprovalBuilder has a printedAs method
Holds
ApprovalBuilder has a scrubbedOf method
Holds
ApprovalBuilder has a byFile method
Holds
The general entry point to start an approval is the static initializer approve of the link:{javadoc-url}/core/org/approvej/ApprovalBuilder.html[ApprovalBuilder].
ApprovalBuilder has approve
Holds
For individual overrides, you can use the link:{javadoc-url}/core/org/approvej/ApprovalBuilder.html#printedAs(org.approvej.print.PrintFormat)[printedAs method] with a link:{javadoc-url}/core/org/approvej/print/PrintFormat.html[PrintFormat], or the link:{javadoc-url}/core/org/approvej/ApprovalBuilder.html#printedBy(java.util.function.Function)[printedBy method] with a Function<T, String>.
4 rules from this sentence
ApprovalBuilder depends on PrintFormat
Holds
ApprovalBuilder uses java.util.function.Function
Holds
ApprovalBuilder has a printedAs method
Holds
ApprovalBuilder has a printedBy method
Holds
This will allow you to also override the filenameExtension method.
PrintFormat has a filenameExtension method
Holds
You can do this by using the scrubbedOf method of the link:{javadoc-url}/core/org/approvej/ApprovalBuilder.html[ApprovalBuilder] and provide a link:{javadoc-url}/core/org/approvej/scrub/Scrubber.html[Scrubber]/UnaryOperator<T> implementation.
ApprovalBuilder has a scrubbedOf method
Holds
Call printed() to apply the <<default_print_format,configured default print format>>, or use printedAs()/printedBy() to choose one explicitly.
ApprovalBuilder has a printed method
Holds
In the following example, the two dynamic properties are scrubbed with the built-in Scrubbers for link:{javadoc-url}/core/org/approvej/scrub/Scrubbers.html#dateTimeFormat(java.lang.String)[dateTimeFormat] and link:{javadoc-url}/core/org/approvej/scrub/Scrubbers.html#uuids()[uuids].
2 rules from this sentence
Scrubbers has a dateTimeFormat method
Holds
Scrubbers has an uuids method
Holds
You can change this behavior by calling the replacement method on a scrubber to choose a different link:{javadoc-url}/core/org/approvej/scrub/Replacement.html[Replacement] function.
Scrubber has a replacement method
Holds
You conclude the link:{javadoc-url}/core/org/approvej/ApprovalBuilder.html[ApprovalBuilder] by specifying by which link:{javadoc-url}/core/org/approvej/approve/Approver.html[Approver] the received value should be approved.
ApprovalBuilder depends on Approver
Holds
The link:{javadoc-url}/core/org/approvej/ApprovalBuilder.html#byValue(java.lang.String)[ApprovalBuilder.byValue()] method will use an link:{javadoc-url}/core/org/approvej/approve/InplaceApprover.html[InplaceApprover] to approve the received value by comparison with a directly provided previously approved value.
ApprovalBuilder has a byValue method
Holds
The link:{javadoc-url}/core/org/approvej/ApprovalBuilder.html#byFile()[ApprovalBuilder.byFile()] method will use a link:{javadoc-url}/core/org/approvej/approve/FileApprover.html[FileApprover] to approve the received value by comparison with a previously approved value stored in a file.
ApprovalBuilder has a byFile method
Holds
You can also define your own link:{javadoc-url}/core/org/approvej/approve/PathProvider.html[PathProvider] and pass it to the link:{javadoc-url}/core/org/approvej/ApprovalBuilder.html#byFile(org.approvej.approve.PathProvider)[byFile] method.
ApprovalBuilder depends on PathProvider
Holds
If you call approve() without a concluding terminal method (by(), byFile(), or byValue()), the test will silently pass without any approval actually happening.
ApprovalBuilder has a by method
Holds
You can do so by calling the reviewedBy method on the link:{javadoc-url}/core/org/approvej/ApprovalBuilder.html[ApprovalBuilder].
ApprovalBuilder has a reviewedBy method
Holds
In that case, you can use the link:{javadoc-url}/core/org/approvej/review/Reviewers.html#automatic()[automatic] link:{javadoc-url}/core/org/approvej/review/Reviewer.html[Reviewer].
Reviewers has an automatic method
Holds
The link:{javadoc-url}/http/org/approvej/http/HttpScrubbers.html[HttpScrubbers] utility provides scrubbers for these common cases: hostHeaderValue() – Scrubs the Host header (varies by port)
HttpScrubbers has a hostHeaderValue method
Holds
userAgentHeaderValue() – Scrubs the User-agent header (varies by JVM version)
HttpScrubbers has an userAgentHeaderValue method
Holds
headerValue(name) – Scrubs any header by name
HttpScrubbers has a headerValue method
Holds
For the most common case -- scrubbing strings -- you can implement link:{javadoc-url}/core/org/approvej/scrub/StringScrubber.html[StringScrubber], which binds all three parameters to Scrubber<StringScrubber, String, String>.
StringScrubber depends on Scrubber
Holds
StringScrubber replacement(Replacement<String> replacement) -- return a copy with a different replacement strategy
StringScrubber has a replacement method
Holds
columnValue(name) -- Scrubs all values in the named column (case-insensitive)
DatabaseScrubbers has a columnValue method
Holds
To approve an image, use the approveImage static method from ImageApprovalBuilder.