! F make FileOptions and Scrubber public

closes #73

Author: hownowstephen

date_scrubber.go

@@ -12,11 +12,11 @@ type DateScrubber struct {
 }
 
 var (
-	customScrubbers []SupportedFormat
+	customScrubbers      []SupportedFormat
 	customScrubbersMutex sync.RWMutex
 )
 
-func NewDateScrubber(pattern string) scrubber {
+func NewDateScrubber(pattern string) Scrubber {
 	return CreateRegexScrubberWithLabeler(regexp.MustCompile(pattern), func(n int) string {
 		return fmt.Sprintf(`[Date%d]`, n)
 	})
@@ -71,7 +71,7 @@ func GetSupportedFormatsRegex() []string {
 //	      "No match found for %s.\n Feel free to add your date at https://github.com/approvals/ApprovalTests.Java/issues/112 \n Current supported formats are: %s",
 //	      formattedExample, Query.select(getSupportedFormats(), SupportedFormat::getRegex));
 //	}
-func GetDateScrubberFor(formattedExample string) (scrubber, error) {
+func GetDateScrubberFor(formattedExample string) (Scrubber, error) {
 	allFormats := getAllFormats()
 	for _, pattern := range allFormats {
 		scrubber := NewDateScrubber(pattern.Regex)
@@ -87,7 +87,7 @@ func GetDateScrubberFor(formattedExample string) (scrubber, error) {
 func getAllFormats() []SupportedFormat {
 	customScrubbersMutex.RLock()
 	defer customScrubbersMutex.RUnlock()
-	
+
 	allFormats := make([]SupportedFormat, 0, len(GetSupportedFormats())+len(customScrubbers))
 	allFormats = append(allFormats, GetSupportedFormats()...)
 	allFormats = append(allFormats, customScrubbers...)
@@ -108,24 +108,24 @@ func AddDateScrubber(example string, regex string, displayMessage ...bool) error
 	if len(displayMessage) > 0 {
 		showMessage = displayMessage[0]
 	}
-	
+
 	compiled, err := regexp.Compile(regex)
 	if err != nil {
 		return fmt.Errorf("invalid regex pattern: %w", err)
 	}
-	
+
 	if !compiled.MatchString(example) {
 		return fmt.Errorf("regex pattern '%s' does not match example '%s'", regex, example)
 	}
-	
+
 	customScrubbersMutex.Lock()
 	defer customScrubbersMutex.Unlock()
-	
+
 	customScrubbers = append(customScrubbers, SupportedFormat{
 		Regex:    regex,
 		Examples: []string{example},
 	})
-	
+
 	if showMessage {
 		fmt.Println("You are using a custom date scrubber. ")
 		fmt.Println("If you think the format you want to scrub would be useful for others,please add it to ")
@@ -134,7 +134,7 @@ func AddDateScrubber(example string, regex string, displayMessage ...bool) error
 		fmt.Println("To suppress this message, use")
 		fmt.Printf("AddDateScrubber(\"%s\", \"%s\", false)\n", example, regex)
 	}
-	
+
 	return nil
 }
 

options.go

@@ -12,12 +12,12 @@ type VerifyOptions struct {
 	fields map[string]interface{}
 }
 
-type fileOptions struct {
+type FileOptions struct {
 	fields map[string]interface{}
 }
 
-func (v VerifyOptions) ForFile() fileOptions {
-	return fileOptions{fields: v.fields}
+func (v VerifyOptions) ForFile() FileOptions {
+	return FileOptions{fields: v.fields}
 }
 
 // Deprecated: Use `ForFile().WithExtension(extension)` instead.
@@ -30,16 +30,16 @@ func (v VerifyOptions) GetExtension() string {
 	return v.ForFile().GetExtension()
 }
 
-func (f fileOptions) GetExtension() string {
+func (f FileOptions) GetExtension() string {
 	ext := getField(f.fields, "extWithDot", ".txt")
 	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)
 }
 
-func (f fileOptions) GetNamer() core.ApprovalNamerCreator {
+func (f FileOptions) GetNamer() core.ApprovalNamerCreator {
 	ext := getField(f.fields, "namer", getApprovalNameCreator())
 	creator := ext.(core.ApprovalNamerCreator)
 
@@ -58,7 +58,7 @@ func (v VerifyOptions) getField(key string, defaultValue interface{}) interface{
 	return getField(v.fields, key, defaultValue)
 }
 
-func (f fileOptions) getField(key string, defaultValue interface{}) interface{} {
+func (f FileOptions) getField(key string, defaultValue interface{}) interface{} {
 	return getField(f.fields, key, defaultValue)
 }
 
@@ -78,26 +78,26 @@ func Options() 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 {
-	scrub := CreateMultiScrubber(v.getField("scrubber", CreateNoopScrubber()).(scrubber), scrubfn)
+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, " ", "_"))
 }
 
@@ -107,7 +107,7 @@ func (v VerifyOptions) Scrub(reader io.Reader) (io.Reader, error) {
 		return nil, err
 	}
 
-	scrub := v.getField("scrubber", CreateNoopScrubber()).(scrubber)
+	scrub := v.getField("scrubber", CreateNoopScrubber()).(Scrubber)
 	result := scrub(string(b))
 
 	return strings.NewReader(result), nil

scrubber.go

@@ -6,7 +6,7 @@ import (
 	"strconv"
 )
 
-type scrubber func(s string) string
+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
@@ -17,12 +17,12 @@ func (v VerifyOptions) WithRegexScrubber(regex *regexp.Regexp, replacer string)
 }
 
 // CreateRegexScrubber allows you to create a scrubber that uses a regular expression to scrub data
-func CreateRegexScrubber(regex *regexp.Regexp, replacer string) scrubber {
+func CreateRegexScrubber(regex *regexp.Regexp, replacer string) Scrubber {
 	return CreateRegexScrubberWithLabeler(regex, func(int) string { return replacer })
 }
 
 // CreateRegexScrubberWithLabeler allows you to create a scrubber that uses a regular expression to scrub data
-func CreateRegexScrubberWithLabeler(regex *regexp.Regexp, replacer func(int) string) scrubber {
+func CreateRegexScrubberWithLabeler(regex *regexp.Regexp, replacer func(int) string) Scrubber {
 	return func(s string) string {
 		seen := map[string]int{}
 		replacefn := func(s string) string {
@@ -37,19 +37,19 @@ func CreateRegexScrubberWithLabeler(regex *regexp.Regexp, replacer func(int) str
 	}
 }
 
-func CreateJSONScrubber(label string, valueMatcher *regexp.Regexp) scrubber {
+func CreateJSONScrubber(label string, valueMatcher *regexp.Regexp) Scrubber {
 	return CreateRegexScrubberWithLabeler(regexp.MustCompile(fmt.Sprintf(`"%s": \d+`, label)), func(n int) string { return fmt.Sprintf(`"%s": "<%s_%d>"`, label, label, n) })
 }
 
 // NoopScrubber is a scrubber that does nothing
-func CreateNoopScrubber() scrubber {
+func CreateNoopScrubber() Scrubber {
 	return func(s string) string {
 		return s
 	}
 }
 
 // CreateMultiScrubber allows you to chain multiple scrubbers together
-func CreateMultiScrubber(scrubbers ...scrubber) scrubber {
+func CreateMultiScrubber(scrubbers ...Scrubber) Scrubber {
 	return func(s string) string {
 		for _, scrubber := range scrubbers {
 			s = scrubber(s)
@@ -58,7 +58,7 @@ func CreateMultiScrubber(scrubbers ...scrubber) scrubber {
 	}
 }
 
-func CreateGuidScrubber() scrubber {
+func CreateGuidScrubber() Scrubber {
 	regex := regexp.MustCompile("[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}")
 	return CreateRegexScrubberWithLabeler(regex, func(n int) string { return "guid_" + strconv.Itoa(n) })
 }