refactor(test): remove 'MatchDocumentFragmentGroups' matcher

use 'MatchDocumentFragment' instead

Signed-off-by: Xavier Coulon <[email protected]>

pkg/parser/attributes_test.go

@@ -34,7 +34,7 @@ var _ = Describe("attributes", func() {
 					},
 				},
 			}
-			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 		})
 
 		It("block image with empty alt and extra whitespace", func() {
@@ -54,7 +54,7 @@ var _ = Describe("attributes", func() {
 					},
 				},
 			}
-			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 		})
 
 		It("block image with empty positional parameters", func() {
@@ -74,7 +74,7 @@ var _ = Describe("attributes", func() {
 					},
 				},
 			}
-			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 		})
 
 		It("block image with empty first parameter, non-empty width", func() {
@@ -97,7 +97,7 @@ var _ = Describe("attributes", func() {
 					},
 				},
 			}
-			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 		})
 
 		It("block image with double quoted alt", func() {
@@ -120,7 +120,7 @@ var _ = Describe("attributes", func() {
 					},
 				},
 			}
-			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 		})
 
 		It("block image with double quoted alt and escaped double quotes", func() {
@@ -143,7 +143,7 @@ var _ = Describe("attributes", func() {
 					},
 				},
 			}
-			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 		})
 
 		It("block image with single quoted alt and escaped single quotes", func() {
@@ -166,7 +166,7 @@ var _ = Describe("attributes", func() {
 					},
 				},
 			}
-			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 		})
 
 		It("block image with double quoted alt and standalone backslash", func() {
@@ -189,7 +189,7 @@ var _ = Describe("attributes", func() {
 					},
 				},
 			}
-			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 		})
 
 		It("block image with single quoted alt and standalone backslash", func() {
@@ -212,7 +212,7 @@ var _ = Describe("attributes", func() {
 					},
 				},
 			}
-			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 		})
 
 		It("block image alt and named pair", func() {
@@ -238,7 +238,7 @@ var _ = Describe("attributes", func() {
 			}
 			result, err := ParseDocumentFragments(source)
 			Expect(err).NotTo(HaveOccurred())
-			Expect(result).To(MatchDocumentFragmentGroups(expected))
+			Expect(result).To(MatchDocumentFragments(expected))
 		})
 
 		It("block image alt, width, height, and named pair", func() {
@@ -263,7 +263,7 @@ var _ = Describe("attributes", func() {
 					},
 				},
 			}
-			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 		})
 
 		It("block image alt, width, height, and named pair (spacing)", func() {
@@ -290,7 +290,7 @@ var _ = Describe("attributes", func() {
 					},
 				},
 			}
-			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 		})
 
 		It("block image alt, width, height, and named pair embedded quote", func() {
@@ -317,7 +317,7 @@ var _ = Describe("attributes", func() {
 					},
 				},
 			}
-			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 		})
 	})
 
@@ -350,7 +350,7 @@ var _ = Describe("attributes", func() {
 					},
 				},
 			}
-			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 		})
 
 		It("section with attributes detached", func() {
@@ -382,7 +382,7 @@ var _ = Describe("attributes", func() {
 					},
 				},
 			}
-			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 		})
 	})
 
@@ -410,7 +410,7 @@ var _ = Describe("attributes", func() {
 					},
 				},
 			}
-			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 		})
 	})
 })

pkg/parser/blank_line_test.go

@@ -57,7 +57,7 @@ second paragraph`
 					},
 				},
 			}
-			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 		})
 
 		It("blank line with spaces and tabs between 2 paragraphs and after second paragraph", func() {
@@ -126,7 +126,7 @@ second paragraph
 					},
 				},
 			}
-			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 		})
 
 		It("blank line with attributes", func() {
@@ -136,7 +136,7 @@ second paragraph
 			expected := []types.DocumentFragment{
 				// standalone attribute is ignored
 			}
-			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+			Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 		})
 	})
 

pkg/parser/delimited_block_passthrough_test.go

@@ -67,7 +67,7 @@ another paragraph`
 						},
 					},
 				}
-				Expect(ParseDocumentFragments(source)).To(MatchDocumentFragmentGroups(expected))
+				Expect(ParseDocumentFragments(source)).To(MatchDocumentFragments(expected))
 			})
 		})
 

pkg/parser/document_processing.go

@@ -25,7 +25,7 @@ func ParseDocument(r io.Reader, config *configuration.Configuration, opts ...Opt
 				CollectFootnotes(footnotes, done,
 					ApplySubstitutions(NewParseContext(config, opts...), done, // needs to be before 'ArrangeLists'
 						RefineFragments(NewParseContext(config, opts...), r, done,
-							ParseFragments(NewParseContext(config, opts...), r, done),
+							ParseDocumentFragments(NewParseContext(config, opts...), r, done),
 						),
 					),
 				),

pkg/parser/document_processing_parse_fragments.go

@@ -9,7 +9,7 @@ import (
 	log "github.com/sirupsen/logrus"
 )
 
-func ParseFragments(ctx *ParseContext, source io.Reader, done <-chan interface{}) <-chan types.DocumentFragment {
+func ParseDocumentFragments(ctx *ParseContext, source io.Reader, done <-chan interface{}) <-chan types.DocumentFragment {
 	resultStream := make(chan types.DocumentFragment, bufferSize)
 	go func() {
 		defer close(resultStream)

testsupport/document_fragment_matcher.go

@@ -27,7 +27,7 @@ type documentFragmentMatcher struct {
 
 func (m *documentFragmentMatcher) Match(actual interface{}) (success bool, err error) {
 	if _, ok := actual.(types.DocumentFragment); !ok {
-		return false, errors.Errorf("MatchDocumentFragment matcher expects a types.DocumentFragment (actual: %T)", actual)
+		return false, errors.Errorf("MatchDocumentFragment matcher expects a 'types.DocumentFragment' (actual: %T)", actual)
 	}
 	if diff := cmp.Diff(m.expected, actual, opts...); diff != "" {
 		if log.IsLevelEnabled(log.DebugLevel) {

testsupport/document_fragment_matcher_test.go

@@ -63,7 +63,7 @@ var _ = Describe("document fragments matcher", func() {
 		result, err := matcher.Match(1)
 		// then
 		Expect(err).To(HaveOccurred())
-		Expect(err.Error()).To(Equal("MatchDocumentFragment matcher expects a types.DocumentFragment (actual: int)"))
+		Expect(err.Error()).To(Equal("MatchDocumentFragment matcher expects a 'types.DocumentFragment' (actual: int)"))
 		Expect(result).To(BeFalse())
 	})
 

testsupport/document_fragments_matcher.go

@@ -26,14 +26,14 @@ type documentFragmentsMatcher struct {
 
 func (m *documentFragmentsMatcher) Match(actual interface{}) (success bool, err error) {
 	if _, ok := actual.([]types.DocumentFragment); !ok {
-		return false, errors.Errorf("MatchDocumentFragments matcher expects an array of types.DocumentFragment (actual: %T)", actual)
+		return false, errors.Errorf("MatchDocumentFragments matcher expects a '[]types.DocumentFragment' (actual: %T)", actual)
 	}
 	if diff := cmp.Diff(m.expected, actual, opts...); diff != "" {
 		if log.IsLevelEnabled(log.DebugLevel) {
-			log.Debugf("actual raw document:\n%s", spew.Sdump(actual))
-			log.Debugf("expected raw document:\n%s", spew.Sdump(m.expected))
+			log.Debugf("actual document fragments:\n%s", spew.Sdump(actual))
+			log.Debugf("expected document fragments:\n%s", spew.Sdump(m.expected))
 		}
-		m.diffs = cmp.Diff(spew.Sdump(m.expected), spew.Sdump(actual))
+		m.diffs = diff
 		return false, nil
 	}
 	return true, nil

testsupport/document_fragments_matcher_test.go

@@ -7,12 +7,11 @@ import (
 	"github.com/bytesparadise/libasciidoc/testsupport"
 	"github.com/google/go-cmp/cmp"
 
-	"github.com/davecgh/go-spew/spew"
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 )
 
-var _ = Describe("document fragments matcher", func() {
+var _ = Describe("document fragment matcher", func() {
 
 	// given
 	expected := []types.DocumentFragment{
@@ -60,7 +59,7 @@ var _ = Describe("document fragments matcher", func() {
 		// then
 		Expect(err).ToNot(HaveOccurred())
 		Expect(result).To(BeFalse())
-		diffs := cmp.Diff(spew.Sdump(expected), spew.Sdump(actual))
+		diffs := cmp.Diff(expected, actual)
 		Expect(matcher.FailureMessage(actual)).To(Equal(fmt.Sprintf("expected document fragments to match:\n%s", diffs)))
 		Expect(matcher.NegatedFailureMessage(actual)).To(Equal(fmt.Sprintf("expected document fragments not to match:\n%s", diffs)))
 	})
@@ -70,7 +69,7 @@ var _ = Describe("document fragments matcher", func() {
 		result, err := matcher.Match(1)
 		// then
 		Expect(err).To(HaveOccurred())
-		Expect(err.Error()).To(Equal("MatchDocumentFragments matcher expects an array of types.DocumentFragment (actual: int)"))
+		Expect(err.Error()).To(Equal("MatchDocumentFragments matcher expects a '[]types.DocumentFragment' (actual: int)"))
 		Expect(result).To(BeFalse())
 	})