Merge pull request #1 from ninthclowd/master

Adds WithDescription option to Match(), allowing multiple gold files in the same test

Author: tommy351

examples/main_test.go

@@ -31,4 +31,10 @@ var _ = Describe("Examples", func() {
 			"e": []string{"a", "b", "c"},
 		}).To(goldga.Match())
 	})
+
+	It("multiple gold files in the same test", func() {
+		Expect("foo").To(goldga.Match(goldga.WithDescription("first gold file")))
+		Expect("bar").To(goldga.Match(goldga.WithDescription("second gold file")))
+		Expect("foobar").To(goldga.Match(goldga.WithDescription("third gold file")))
+	})
 })

examples/testdata/main.golden

@@ -16,6 +16,15 @@
  }
 }
 '''
+"Examples multiple gold files in the same test (first gold file)" = '''
+(string) (len=3) "foo"
+'''
+"Examples multiple gold files in the same test (second gold file)" = '''
+(string) (len=3) "bar"
+'''
+"Examples multiple gold files in the same test (third gold file)" = '''
+(string) (len=6) "foobar"
+'''
 "Examples string" = '''
 (string) (len=3) "abc"
 '''

matcher.go

@@ -11,13 +11,24 @@ import (
 	"github.com/spf13/afero"
 )
 
+type Option func(*Matcher)
+
+// WithDescription adds an optional description to the gold file, allowing multiple gold files per test
+func WithDescription(description string) Option {
+	return func(matcher *Matcher) {
+		if s, ok := matcher.Storage.(*SuiteStorage); ok {
+			s.Name = fmt.Sprintf("%s (%s)", s.Name, description)
+		}
+	}
+}
+
 func getUpdateFile() bool {
 	update, _ := strconv.ParseBool(os.Getenv("UPDATE_GOLDEN"))
 	return update
 }
 
-func Match() *Matcher {
-	return &Matcher{
+func Match(options ...Option) *Matcher {
+	m := &Matcher{
 		Serializer:  DefaultSerializer,
 		Transformer: DefaultTransformer,
 		Storage: &SuiteStorage{
@@ -28,6 +39,10 @@ func Match() *Matcher {
 		Differ:     DefaultDiffer,
 		UpdateFile: getUpdateFile(),
 	}
+	for _, option := range options {
+		option(m)
+	}
+	return m
 }
 
 var _ types.GomegaMatcher = (*Matcher)(nil)

matcher_test.go

@@ -151,3 +151,13 @@ var _ = Describe("Matcher", func() {
 		testError(HaveOccurred())
 	})
 })
+
+var _ = Describe("Options", func() {
+	Describe("WithDescription", func() {
+		It("should append a description to the test name, allowing multiple gold files per test", func() {
+			Expect("foo").To(Match(WithDescription("First Gold File")))
+			Expect("bar").To(Match(WithDescription("Second Gold File")))
+			Expect("foobar").To(Match(WithDescription("Third Gold File")))
+		})
+	})
+})

testdata/matcher.golden

@@ -0,0 +1,11 @@
+# Generated by goldga. DO NOT EDIT.
+[snapshots]
+"Options WithDescription should append a description to the test name, allowing multiple gold files per test (First Gold File)" = '''
+(string) (len=3) "foo"
+'''
+"Options WithDescription should append a description to the test name, allowing multiple gold files per test (Second Gold File)" = '''
+(string) (len=3) "bar"
+'''
+"Options WithDescription should append a description to the test name, allowing multiple gold files per test (Third Gold File)" = '''
+(string) (len=6) "foobar"
+'''