- B Made VerifyOptions public. Closes #72

Author: aleclerc-cio

approvals.go

@@ -27,22 +27,22 @@ var (
 //	VerifyWithExtension(t, strings.NewReader("Hello"), ".json")
 //
 // Deprecated: Please use Verify with the Options() fluent syntax.
-func VerifyWithExtension(t core.Failable, reader io.Reader, extWithDot string, opts ...verifyOptions) {
+func VerifyWithExtension(t core.Failable, reader io.Reader, extWithDot string, opts ...VerifyOptions) {
 	t.Helper()
 	Verify(t, reader, alwaysOption(opts).ForFile().WithExtension(extWithDot))
 }
 
 // Verify Example:
 //
 //	Verify(t, strings.NewReader("Hello"))
-func Verify(t core.Failable, reader io.Reader, opts ...verifyOptions) {
+func Verify(t core.Failable, reader io.Reader, opts ...VerifyOptions) {
 	t.Helper()
 
 	if len(opts) > 1 {
 		panic("Please use fluent syntax for options, see documentation for more information")
 	}
 
-	var opt verifyOptions
+	var opt VerifyOptions
 	if len(opts) > 0 {
 		opt = opts[0]
 	}
@@ -71,7 +71,7 @@ func Verify(t core.Failable, reader io.Reader, opts ...verifyOptions) {
 
 // VerifyString stores the passed string into the received file and confirms
 // that it matches the approved local file. On failure, it will launch a reporter.
-func VerifyString(t core.Failable, s string, opts ...verifyOptions) {
+func VerifyString(t core.Failable, s string, opts ...VerifyOptions) {
 	t.Helper()
 	reader := strings.NewReader(s)
 	Verify(t, reader, opts...)
@@ -80,7 +80,7 @@ func VerifyString(t core.Failable, s string, opts ...verifyOptions) {
 // VerifyXMLStruct Example:
 //
 //	VerifyXMLStruct(t, xml)
-func VerifyXMLStruct(t core.Failable, obj interface{}, opts ...verifyOptions) {
+func VerifyXMLStruct(t core.Failable, obj interface{}, opts ...VerifyOptions) {
 	t.Helper()
 	options := alwaysOption(opts).ForFile().WithExtension(".xml")
 	xmlContent, err := xml.MarshalIndent(obj, "", "  ")
@@ -99,7 +99,7 @@ func VerifyXMLStruct(t core.Failable, obj interface{}, opts ...verifyOptions) {
 // VerifyXMLBytes Example:
 //
 //	VerifyXMLBytes(t, []byte("<Test/>"))
-func VerifyXMLBytes(t core.Failable, bs []byte, opts ...verifyOptions) {
+func VerifyXMLBytes(t core.Failable, bs []byte, opts ...VerifyOptions) {
 	t.Helper()
 	type node struct {
 		Attr     []xml.Attr
@@ -121,7 +121,7 @@ func VerifyXMLBytes(t core.Failable, bs []byte, opts ...verifyOptions) {
 // VerifyJSONStruct Example:
 //
 //	VerifyJSONStruct(t, json)
-func VerifyJSONStruct(t core.Failable, obj interface{}, opts ...verifyOptions) {
+func VerifyJSONStruct(t core.Failable, obj interface{}, opts ...VerifyOptions) {
 	t.Helper()
 	options := alwaysOption(opts).ForFile().WithExtension(".json")
 	jsonb, err := json.MarshalIndent(obj, "", "  ")
@@ -136,7 +136,7 @@ func VerifyJSONStruct(t core.Failable, obj interface{}, opts ...verifyOptions) {
 // VerifyJSONBytes Example:
 //
 //	VerifyJSONBytes(t, []byte("{ \"Greeting\": \"Hello\" }"))
-func VerifyJSONBytes(t core.Failable, bs []byte, opts ...verifyOptions) {
+func VerifyJSONBytes(t core.Failable, bs []byte, opts ...VerifyOptions) {
 	t.Helper()
 	var obj map[string]interface{}
 	err := json.Unmarshal(bs, &obj)
@@ -151,7 +151,7 @@ func VerifyJSONBytes(t core.Failable, bs []byte, opts ...verifyOptions) {
 // VerifyMap Example:
 //
 //	VerifyMap(t, map[string][string] { "dog": "bark" })
-func VerifyMap(t core.Failable, m interface{}, opts ...verifyOptions) {
+func VerifyMap(t core.Failable, m interface{}, opts ...VerifyOptions) {
 	t.Helper()
 	outputText := utils.PrintMap(m)
 	VerifyString(t, outputText, opts...)
@@ -160,7 +160,7 @@ func VerifyMap(t core.Failable, m interface{}, opts ...verifyOptions) {
 // VerifyArray Example:
 //
 //	VerifyArray(t, []string{"dog", "cat"})
-func VerifyArray(t core.Failable, array interface{}, opts ...verifyOptions) {
+func VerifyArray(t core.Failable, array interface{}, opts ...VerifyOptions) {
 	t.Helper()
 	outputText := utils.PrintArray(array)
 	VerifyString(t, outputText, opts...)
@@ -169,7 +169,7 @@ func VerifyArray(t core.Failable, array interface{}, opts ...verifyOptions) {
 // VerifyAll Example:
 //
 //	VerifyAll(t, "uppercase", []string("dog", "cat"}, func(x interface{}) string { return strings.ToUpper(x.(string)) })
-func VerifyAll(t core.Failable, header string, collection interface{}, transform func(interface{}) string, opts ...verifyOptions) {
+func VerifyAll(t core.Failable, header string, collection interface{}, transform func(interface{}) string, opts ...VerifyOptions) {
 	t.Helper()
 	if len(header) != 0 {
 		header = fmt.Sprintf("%s\n\n\n", header)

internal_documentation/architecture.go.md

@@ -27,21 +27,21 @@ classDiagram
         +Report(approved string, received string) bool
     }
 
-    class verifyOptions {
+    class VerifyOptions {
         -fields map
         +ForFile() fileOptions
-        +WithScrubber(scrub scrubber) verifyOptions
-        +AddScrubber(scrubfn scrubber) verifyOptions
+        +WithScrubber(scrub scrubber) VerifyOptions
+        +AddScrubber(scrubfn scrubber) VerifyOptions
         +Scrub(reader io.Reader) io.Reader, error
     }
 
     class fileOptions {
         -fields map
-        +WithExtension(extensionWithDot string) verifyOptions
+        +WithExtension(extensionWithDot string) VerifyOptions
         +GetExtension() string
-        +WithNamer(namer ApprovalNamerCreator) verifyOptions
+        +WithNamer(namer ApprovalNamerCreator) VerifyOptions
         +GetNamer() ApprovalNamerCreator
-        +WithAdditionalInformation(info string) verifyOptions
+        +WithAdditionalInformation(info string) VerifyOptions
     }
 
     class scrubber {
@@ -118,15 +118,15 @@ classDiagram
 
     %% Relationships
     VerifyFunctions ..> Failable : uses
-    VerifyFunctions ..> verifyOptions : uses
+    VerifyFunctions ..> VerifyOptions : uses
     VerifyFunctions ..> ApprovalNamer : creates via
     VerifyFunctions ..> Reporter : uses
 
     CombinationApprovals ..> Failable : uses
     CombinationApprovals ..> VerifyFunctions : calls
 
-    verifyOptions --> fileOptions : creates
-    verifyOptions ..> scrubber : uses
+    VerifyOptions --> fileOptions : creates
+    VerifyOptions ..> scrubber : uses
     fileOptions ..> ApprovalNamer : creates
 
     FirstWorkingReporter ..|> Reporter : implements
@@ -151,7 +151,7 @@ classDiagram
 
 ### Configuration
 
-- **verifyOptions**: Main configuration object for verification operations
+- **VerifyOptions**: Main configuration object for verification operations
 - **fileOptions**: File-specific configuration options
 - **scrubber**: Function type for data sanitization/scrubbing
 
@@ -178,7 +178,7 @@ classDiagram
 ## Key Architectural Patterns
 
 1. **Interface-based Design**: Core functionality is defined through interfaces (Failable, ApprovalNamer, Reporter)
-2. **Options Pattern**: Flexible configuration through verifyOptions and fileOptions
+2. **Options Pattern**: Flexible configuration through VerifyOptions and fileOptions
 3. **Strategy Pattern**: Different reporting strategies through Reporter interface
 4. **Chain of Responsibility**: FirstWorkingReporter tries reporters in sequence
 5. **Template Method**: templatedCustomNamer uses templates for file naming

options.go

@@ -3,29 +3,30 @@ package approvals
 import (
 	"io"
 	"strings"
+
 	"github.com/approvals/go-approval-tests/core"
 )
 
-// verifyOptions can be accessed via the approvals.Options() API enabling configuration of scrubbers
-type verifyOptions struct {
+// VerifyOptions can be accessed via the approvals.Options() API enabling configuration of scrubbers
+type VerifyOptions struct {
 	fields map[string]interface{}
 }
 
 type fileOptions struct {
 	fields map[string]interface{}
 }
 
-func (v verifyOptions) ForFile() fileOptions {
+func (v VerifyOptions) ForFile() fileOptions {
 	return fileOptions{fields: v.fields}
 }
 
 // Deprecated: Use `ForFile().WithExtension(extension)` instead.
-func (v verifyOptions) WithExtension(extension string) verifyOptions {
+func (v VerifyOptions) WithExtension(extension string) VerifyOptions {
 	return v.ForFile().WithExtension(extension)
 }
 
 // Deprecated: Use `ForFile().GetExtension()` instead.
-func (v verifyOptions) GetExtension() string {
+func (v VerifyOptions) GetExtension() string {
 	return v.ForFile().GetExtension()
 }
 
@@ -34,7 +35,7 @@ func (f fileOptions) GetExtension() string {
 	return ext.(string)
 }
 
-func (f fileOptions) WithNamer(namer core.ApprovalNamerCreator) verifyOptions {
+func (f fileOptions) WithNamer(namer core.ApprovalNamerCreator) VerifyOptions {
 	return NewVerifyOptions(f.fields, "namer", namer)
 }
 
@@ -53,7 +54,7 @@ func (f fileOptions) GetNamer() core.ApprovalNamerCreator {
 	}
 }
 
-func (v verifyOptions) getField(key string, defaultValue interface{}) interface{} {
+func (v VerifyOptions) getField(key string, defaultValue interface{}) interface{} {
 	return getField(v.fields, key, defaultValue)
 }
 
@@ -72,35 +73,35 @@ func getField(fields map[string]interface{}, key string, defaultValue interface{
 }
 
 // Options enables providing individual Verify functions with customisations such as scrubbers
-func Options() verifyOptions {
-	return verifyOptions{}
+func Options() VerifyOptions {
+	return VerifyOptions{}
 }
 
 // WithScrubber allows you to 'scrub' data within your test input and replace it with a static placeholder
-func (v verifyOptions) WithScrubber(scrub scrubber) verifyOptions {
+func (v VerifyOptions) WithScrubber(scrub scrubber) VerifyOptions {
 	return NewVerifyOptions(v.fields, "scrubber", scrub)
 }
 
 // AddScrubber allows you to 'scrub' data within your test input and replace it with a static placeholder
-func (v verifyOptions) AddScrubber(scrubfn scrubber) verifyOptions {
+func (v VerifyOptions) AddScrubber(scrubfn scrubber) VerifyOptions {
 	scrub := CreateMultiScrubber(v.getField("scrubber", CreateNoopScrubber()).(scrubber), scrubfn)
 	return v.WithScrubber(scrub)
 }
 
 // WithExtension overrides the default file extension (.txt) for approval files.
-func (f fileOptions) WithExtension(extensionWithDot string) verifyOptions {
+func (f fileOptions) WithExtension(extensionWithDot string) VerifyOptions {
 	if !strings.HasPrefix(extensionWithDot, ".") {
 		extensionWithDot = "." + extensionWithDot
 	}
 	return NewVerifyOptions(f.fields, "extWithDot", extensionWithDot)
 }
 
 // WithAdditionalInformation allows adding additional information to the file name for parameterized tests.
-func (f fileOptions) WithAdditionalInformation(info string) verifyOptions {
+func (f fileOptions) WithAdditionalInformation(info string) VerifyOptions {
 	return NewVerifyOptions(f.fields, "additionalInformation", strings.ReplaceAll(info, " ", "_"))
 }
 
-func (v verifyOptions) Scrub(reader io.Reader) (io.Reader, error) {
+func (v VerifyOptions) Scrub(reader io.Reader) (io.Reader, error) {
 	b, err := io.ReadAll(reader)
 	if err != nil {
 		return nil, err
@@ -112,20 +113,20 @@ func (v verifyOptions) Scrub(reader io.Reader) (io.Reader, error) {
 	return strings.NewReader(result), nil
 }
 
-func NewVerifyOptions(fields map[string]interface{}, key string, value interface{}) verifyOptions {
+func NewVerifyOptions(fields map[string]interface{}, key string, value interface{}) VerifyOptions {
 	// Make a copy of the fields map, but with the new key and value
 	newFields := make(map[string]interface{}, len(fields))
 	for k, v := range fields {
 		newFields[k] = v
 	}
 	newFields[key] = value
-	return verifyOptions{
+	return VerifyOptions{
 		fields: newFields,
 	}
 }
 
-func alwaysOption(opts []verifyOptions) verifyOptions {
-	var v verifyOptions
+func alwaysOption(opts []VerifyOptions) VerifyOptions {
+	var v VerifyOptions
 	if len(opts) == 0 {
 		v = Options()
 	} else {

scrubber.go

@@ -10,7 +10,7 @@ type scrubber func(s string) string
 
 // Deprecated: WithRegexScrubber allows you to 'scrub' dynamic data such as timestamps within your test input
 // and replace it with a static placeholder
-func (v verifyOptions) WithRegexScrubber(regex *regexp.Regexp, replacer string) verifyOptions {
+func (v VerifyOptions) WithRegexScrubber(regex *regexp.Regexp, replacer string) VerifyOptions {
 	return v.AddScrubber(func(s string) string {
 		return regex.ReplaceAllString(s, replacer)
 	})