Merge branch 'yaml'

* yaml:
  Add 'yaml' build tag for conditionally using gopkg.in/yaml.v2
  Add YAML() for generating YAML blocks

Author: wking

util/tap/Makefile

@@ -1,5 +1,5 @@
-TESTS = auto check diagnostic failing known skip todo writer
-GOPATH = $(CURDIR)/gopath
+TESTS = auto check diagnostic failing known skip todo writer yaml
+GOPATH ?= $(CURDIR)/gopath
 
 .PHONY: $(TESTS)
 
@@ -9,8 +9,8 @@ all: $(foreach t,$(TESTS),test/$(t)/test)
 clean:
 	rm -f test/*/test
 
-test/%/test: test/%/main.go tap.go
-	go build -o $@ $<
+test/%/test: test/%/*.go tap.go yaml_json.go yaml_yaml.go
+	go build -o $@ -tags yaml ./test/$*
 
 $(TESTS): %: test/%/test
 	prove -v -e '' test/$@/test

util/tap/tap.go

@@ -151,3 +151,15 @@ func (t *T) Diagnostic(message string) {
 func (t *T) Diagnosticf(format string, a ...interface{}) {
 	t.printf("# "+escapeNewlines(format)+"\n", a...)
 }
+
+// YAML generates a YAML block from the message.
+func (t *T) YAML(message interface{}) error {
+	bytes, err := yaml(message, "  ")
+	if err != nil {
+		return err
+	}
+	t.printf("  ---\n  ")
+	t.printf(string(bytes))
+	t.printf("  ...\n")
+	return nil
+}

util/tap/test/yaml/json.go

@@ -0,0 +1,14 @@
+// +build !yaml
+
+package main
+
+const expected = `TAP version 13
+1..2
+ok 1 - test for anchoring the YAML block
+  ---
+  {
+    "code": 3,
+    "message": "testing YAML blocks"
+  }
+  ...
+`

util/tap/test/yaml/main.go

@@ -0,0 +1,26 @@
+package main
+
+import (
+	"bytes"
+	"io"
+	"os"
+
+	tap "github.com/mndrix/tap-go"
+)
+
+func main() {
+	// collect output for comparison later
+	buf := new(bytes.Buffer)
+	t := tap.New()
+	t.Writer = io.MultiWriter(os.Stdout, buf)
+
+	t.Header(2)
+	t.Pass("test for anchoring the YAML block")
+	message := map[string]interface{}{
+		"message": "testing YAML blocks",
+		"code":    3,
+	}
+	t.YAML(message)
+	got := buf.String()
+	t.Ok(got == expected, "diagnostics gave expected output")
+}

util/tap/test/yaml/yaml.go

@@ -0,0 +1,12 @@
+// +build yaml
+
+package main
+
+const expected = `TAP version 13
+1..2
+ok 1 - test for anchoring the YAML block
+  ---
+  code: 3
+  message: testing YAML blocks
+  ...
+`

util/tap/yaml_json.go

@@ -0,0 +1,22 @@
+// +build !yaml
+
+package tap
+
+import (
+	"encoding/json"
+)
+
+// yaml serializes a message to YAML.  This implementation uses JSON,
+// which is a subset of YAML [1] and is implemented by Go's standard
+// library.
+//
+// [1]: http://www.yaml.org/spec/1.2/spec.html#id2759572
+func yaml(message interface{}, prefix string) (marshaled []byte, err error) {
+	marshaled, err = json.MarshalIndent(message, prefix, "  ")
+	if err != nil {
+		return marshaled, err
+	}
+
+	marshaled = append(marshaled, []byte("\n")...)
+	return marshaled, err
+}

util/tap/yaml_yaml.go

@@ -0,0 +1,23 @@
+// +build yaml
+
+package tap
+
+import (
+	"bytes"
+
+	goyaml "gopkg.in/yaml.v2"
+)
+
+// yaml serializes a message to YAML.  This implementation uses
+// non-JSON YAML, which has better prove support [1].
+//
+// [1]: https://rt.cpan.org/Public/Bug/Display.html?id=121606
+func yaml(message interface{}, prefix string) (marshaled []byte, err error) {
+	marshaled, err = goyaml.Marshal(message)
+	if err != nil {
+		return marshaled, err
+	}
+
+	marshaled = bytes.Replace(marshaled, []byte("\n"), []byte("\n"+prefix), -1)
+	return marshaled[:len(marshaled)-len(prefix)], err
+}