com.github.writethemfirst.approvals.files

Class ApprovalFolders

java.lang.Object

com.github.writethemfirst.approvals.files.ApprovalFiles

com.github.writethemfirst.approvals.files.ApprovalFolders

public class ApprovalFolders
extends ApprovalFiles

ApprovalFolders is similar to ApprovalFiles : it holds a pair of Paths, approved and received.

The difference is that these paths represents folders we are comparing.

Field Summary

Fields inherited from class com.github.writethemfirst.approvals.files.ApprovalFiles

approved, received

Constructor Summary

Constructors

Constructor and Description
ApprovalFolders(Path folder, String methodName) Constructs a pair of approval entries from the provided folder and method name.

Method Summary

Modifier and Type	Method and Description
MatchesAndMismatches	matchesAndMismatches() Compares the content of files in approved and received folders (only makes sense if approved and received are folders).
void	prepareFolders(Path actualFolder) Creates the approved folder and copies files from actual to received folder.
ApprovalFiles	resolve(Path file) Appends to the approved and received paths the name of a file.

Methods inherited from class com.github.writethemfirst.approvals.files.ApprovalFiles

approvedContent, createEmptyApprovedFileIfNeeded, equals, hashCode, haveSameContent, parent, receivedContent

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApprovalFolders

public ApprovalFolders(Path folder,
                       String methodName)

Constructs a pair of approval entries from the provided folder and method name. The path for both approved and received files will be computed and used as approval files.

Parameters:

folder - The folder in which the approval files will be located

methodName - The name of the method calling the test. It is used to actually name the approval files

Method Detail

resolve

public ApprovalFiles resolve(Path file)

Appends to the approved and received paths the name of a file.

Parameters:

file - the Path for which only the name is taken into account

Returns:

an ApprovalsFile, one step deeper

prepareFolders

public void prepareFolders(Path actualFolder)

Creates the approved folder and copies files from actual to received folder.

matchesAndMismatches

public MatchesAndMismatches matchesAndMismatches()

Compares the content of files in approved and received folders (only makes sense if approved and received are folders).

Returns:

the 2 lists of matches (files with same content) and mismatches (different files)