Merge pull request #14 from christopherhein/bug/fixed-func

Fixed func since it's not eval'ed each time

Author: christopherhein

VERSION

@@ -1 +1 @@
-v0.0.2
+v0.0.3

example/version.go

@@ -16,7 +16,7 @@ limitations under the License.
 package main
 
 import (
-	"os"
+	"fmt"
 
 	"github.com/spf13/cobra"
 	goVersion "go.hein.dev/go-version"
@@ -27,15 +27,21 @@ var (
 	version    = "dev"
 	commit     = "none"
 	date       = "unknown"
+	output     = "json"
 	versionCmd = &cobra.Command{
 		Use:   "version",
 		Short: "Version will output the current build information",
 		Long:  ``,
-		Run:   goVersion.Func(os.Stdout, shortened, version, commit, date),
+		Run: func(_ *cobra.Command, _ []string) {
+			resp := goVersion.FuncWithOutput(shortened, version, commit, date, output)
+			fmt.Print(resp)
+			return
+		},
 	}
 )
 
 func init() {
-	versionCmd.Flags().BoolVarP(&shortened, "short", "s", false, "Use shortened output for version information.")
+	versionCmd.Flags().BoolVarP(&shortened, "short", "s", false, "Print just the version number.")
+	versionCmd.Flags().StringVarP(&output, "output", "o", "json", "Output format. One of 'yaml' or 'json'.")
 	rootCmd.AddCommand(versionCmd)
 }

go.mod

@@ -12,4 +12,5 @@ require (
 	golang.org/x/sys v0.0.0-20190812172437-4e8604ab3aff // indirect
 	golang.org/x/text v0.3.2 // indirect
 	golang.org/x/tools v0.0.0-20190812233024-afc3694995b6 // indirect
+	sigs.k8s.io/yaml v1.1.0
 )

go.sum

@@ -160,3 +160,5 @@ gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
+sigs.k8s.io/yaml v1.1.0 h1:4A07+ZFc2wgJwo8YNlQpr1rVlgUDlxXHhPJciaPY5gs=
+sigs.k8s.io/yaml v1.1.0/go.mod h1:UJmg0vDUVViEyp3mgSv9WPwZCDxu4rQW1olrI1uml+o=

readme.adoc

@@ -26,16 +26,22 @@ var (
 	version    = "dev"
 	commit     = "none"
 	date       = "unknown"
+	output     = "json"
 	versionCmd = &cobra.Command{
 		Use:   "version",
 		Short: "Version will output the current build information",
 		Long:  ``,
-		Run: goVersion.Func(shortened, version, commit, date),
+		Run: func(_ *cobra.Command, _ []string) {
+			resp := goVersion.FuncWithOutput(shortened, version, commit, date, output)
+			fmt.Print(resp)
+			return
+		},
 	}
 )
 
 func init() {
-	versionCmd.Flags().BoolVarP(&shortened, "short", "s", false, "Use shortened output for version information.")
+	versionCmd.Flags().BoolVarP(&shortened, "short", "s", false, "Print just the version number.")
+	versionCmd.Flags().StringVarP(&output, "output", "o", "json", "Output format. One of 'yaml' or 'json'.")
 	rootCmd.AddCommand(versionCmd)
 }
 ----

version.go

@@ -3,10 +3,15 @@ package version // import "go.hein.dev/go-version"
 import (
 	"encoding/json"
 	"fmt"
-	"io"
-	"strings"
 
-	"github.com/spf13/cobra"
+	"sigs.k8s.io/yaml"
+)
+
+var (
+	// JSON returns json so that we can change the output
+	JSON = "json"
+	// YAML returns yaml so that we can change the output
+	YAML = "yaml"
 )
 
 // Info creates a formattable struct for output
@@ -25,20 +30,29 @@ func New(version string, commit string, date string) *Info {
 	}
 }
 
-// Func will add the versioning code
-func Func(out io.Writer, shortened bool, version, commit, date string) func(*cobra.Command, []string) {
-	return func(_ *cobra.Command, _ []string) {
-		var response string
-		versionOutput := New(version, commit, date)
+// Func will return the versioning code with only JSON and raw text support
+func Func(shortened bool, version, commit, date string) string {
+	return FuncWithOutput(shortened, version, commit, date, JSON)
+}
 
-		if shortened {
-			response = versionOutput.ToShortened()
-		} else {
+// FuncWithOutput will add the versioning code
+func FuncWithOutput(shortened bool, version, commit, date, output string) string {
+	var response string
+	versionOutput := New(version, commit, date)
+
+	if shortened {
+		response = versionOutput.ToShortened()
+	} else {
+		switch output {
+		case YAML:
+			response = versionOutput.ToYAML()
+		case JSON:
+			response = versionOutput.ToJSON()
+		default: // JSON as the default
 			response = versionOutput.ToJSON()
 		}
-		fmt.Fprintf(out, "%+v", response)
-		return
 	}
+	return fmt.Sprintf("%s", response)
 }
 
 // ToJSON converts the Info into a JSON String
@@ -47,22 +61,15 @@ func (v *Info) ToJSON() string {
 	return string(bytes) + "\n"
 }
 
+// ToYAML converts the Info into a JSON String
+func (v *Info) ToYAML() string {
+	bytes, _ := yaml.Marshal(v)
+	return string(bytes)
+}
+
 // ToShortened converts the Info into a JSON String
-func (v *Info) ToShortened() (str string) {
-	var version, commit, date string
-	if v.Version != "" {
-		version = "Version: " + v.Version
-	}
-	if v.Commit != "" {
-		commit = "Commit: " + v.Commit
-	}
-	if v.Date != "" {
-		date = "Date: " + v.Date
-	}
-	values := []string{version, commit, date}
-	values = deleteEmpty(values)
-	str = strings.Join(values, "\n")
-	return str + "\n"
+func (v *Info) ToShortened() string {
+	return v.ToYAML()
 }
 
 func deleteEmpty(s []string) []string {

version_test.go

@@ -1,10 +1,7 @@
 package version
 
 import (
-	"bytes"
 	"testing"
-
-	"github.com/spf13/cobra"
 )
 
 func TestToJSON(t *testing.T) {
@@ -21,9 +18,9 @@ func TestToShortened(t *testing.T) {
 	v := New("dev", "fee8dd1f7c24da23508e26347694be0acce5631b", "Fri Jun 21 10:50:15 PDT 2019")
 	short := v.ToShortened()
 
-	expected := `Version: dev
-Commit: fee8dd1f7c24da23508e26347694be0acce5631b
+	expected := `Commit: fee8dd1f7c24da23508e26347694be0acce5631b
 Date: Fri Jun 21 10:50:15 PDT 2019
+Version: dev
 `
 
 	if short != expected {
@@ -43,18 +40,16 @@ func TestFunc(t *testing.T) {
 			shortened: false,
 		},
 		testcase{
-			expected: `Version: dev
-Commit: fee8dd1f7c24da23508e26347694be0acce5631b
+			expected: `Commit: fee8dd1f7c24da23508e26347694be0acce5631b
 Date: Fri Jun 21 10:50:15 PDT 2019
+Version: dev
 `,
 			shortened: true,
 		},
 	}
 
 	for _, c := range cases {
-		buffer := &bytes.Buffer{}
-		Func(buffer, c.shortened, "dev", "fee8dd1f7c24da23508e26347694be0acce5631b", "Fri Jun 21 10:50:15 PDT 2019")(&cobra.Command{}, []string{})
-		resp := buffer.String()
+		resp := FuncWithOutput(c.shortened, "dev", "fee8dd1f7c24da23508e26347694be0acce5631b", "Fri Jun 21 10:50:15 PDT 2019", JSON)
 		if resp != c.expected {
 			t.Errorf("got %q want %q", resp, c.expected)
 		}