generator.go

package gogiven

import (
	"github.com/corbym/gogiven/generator"
	"github.com/corbym/gogiven/generator/htmlspec"
	"io"
	"path/filepath"
	"strings"
)

// Generator is a global variable that holds the GoGivensOutputGenerator.
// You can replace the generator with your own if you match the interface here
// and set Generator = new(myFooGenerator) in a method (usually TestMain or init).
// Don't forget to add the call to the generator function in a "func TestMain(testing.M)" method
// in your test package.
// One file per test file will be generated containing output.
var Generator generator.GoGivensOutputGenerator = htmlspec.NewHTMLOutputGenerator()

const indexIdentifier = "index"

// OutputListeners holds a list of listeners which can process the output generated by the GoGivensOutputGenerator.
// By default, the generator.FileOutputGenerator is added. but you can append or replace with your own.
var OutputListeners = []generator.OutputListener{new(generator.FileOutputGenerator)}

func transformFileNameToHeader(fileWithPath string) (header string) {
	baseFileName := filepath.Base(fileWithPath)
	withTrimmedSuffix := strings.TrimSuffix(baseFileName, ".go")
	return strings.Title(strings.Replace(withTrimmedSuffix, "_", " ", -1))
}

// GenerateTestOutput generates the test output. Call this method from TestMain.
// The global var Generator is used to generate the content, and the OutputListeners are iterated and Notified
// of the content that has been generated. When the test meta data has been processed, an index is generated
// and the listeners notified with an identifier of "index" instead of a test file path and name.
func GenerateTestOutput() {
	var indexData []generator.IndexData
	for _, key := range globalTestContextMap.Keys() {
		value, _ := globalTestContextMap.Load(key)
		currentTestContext := value.(*TestContext)
		tests := currentTestContext.SomeTests()

		pageData := generator.NewPageData(
			transformFileNameToHeader(currentTestContext.FileName()),
			tests.asMapOfSome(),
		)

		output := Generator.Generate(pageData)
		contentType := Generator.ContentType()
		indexData = generateIndexData(currentTestContext, contentType, indexData, pageData)
		notifyListeners(currentTestContext.FileName(), contentType, output)
	}
	index := Generator.GenerateIndex(indexData)
	notifyListeners(indexIdentifier, Generator.ContentType(), index)
}

func generateIndexData(
	currentTestContext *TestContext,
	contentType string,
	indexData []generator.IndexData,
	pageData generator.PageData) []generator.IndexData {

	for _, listener := range OutputListeners {
		ref := listener.Ref(currentTestContext.fileName, contentType)
		indexData = append(indexData, generator.NewIndexData(ref, pageData))
	}
	return indexData
}

func notifyListeners(fileNameWithPath string, contentType string, output io.Reader) {
	for _, listener := range OutputListeners {
		listener.Notify(fileNameWithPath, contentType, output)
	}
}