Use dedicated Column interface for table formatting nested structs

cmoog · cmoog · commit f44bc763af26 · 2020-11-16T11:20:00.000-06:00
diff --git a/coder-sdk/env.go b/coder-sdk/env.go
@@ -54,7 +54,8 @@ type EnvironmentStat struct {
 	DiskUsed        int64             `json:"disk_used"`
 }
 
-func (e EnvironmentStat) String() string { return string(e.ContainerStatus) }
+// Column defines how EnvironmentStat should format in as a table column.
+func (e EnvironmentStat) Column() string { return string(e.ContainerStatus) }
 
 // EnvironmentStatus refers to the states of an environment.
 type EnvironmentStatus string
diff --git a/coder-sdk/tags.go b/coder-sdk/tags.go
@@ -18,7 +18,8 @@ type ImageTag struct {
 	CreatedAt         time.Time      `json:"created_at"           table:"-"`
 }
 
-func (i ImageTag) String() string {
+// Column defines how ImageTag should format in as a table column.
+func (i ImageTag) Column() string {
 	return i.Tag
 }
 
@@ -29,9 +30,8 @@ type OSRelease struct {
 	HomeURL    string `json:"home_url"`
 }
 
-func (o OSRelease) String() string {
-	return o.PrettyName
-}
+// Column defines how OSRelease should format in as a table column.
+func (o OSRelease) Column() string { return o.PrettyName }
 
 // CreateImageTagReq defines the request parameters for creating a new image tag.
 type CreateImageTagReq struct {
diff --git a/pkg/tablewriter/tablewriter.go b/pkg/tablewriter/tablewriter.go
@@ -10,6 +10,11 @@ import (
 
 const structFieldTagKey = "table"
 
+// Column defines an interface for formatting a type as a column.
+type Column interface {
+	Column() string
+}
+
 // StructValues tab delimits the values of a given struct.
 //
 // Tag a field `table:"-"` to hide it from output.
@@ -20,7 +25,12 @@ func StructValues(data interface{}) string {
 		if shouldHideField(v.Type().Field(i)) {
 			continue
 		}
-		fmt.Fprintf(s, "%v\t", v.Field(i).Interface())
+		value := v.Field(i).Interface()
+		if column, ok := value.(Column); ok {
+			fmt.Fprintf(s, "%s\t", column.Column())
+		} else {
+			fmt.Fprintf(s, "%v\t", value)
+		}
 	}
 	return s.String()
 }

Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,8 @@ type EnvironmentStat struct {`
`54`	`54`	DiskUsed int64 `json:"disk_used"`
`55`	`55`	`}`
`56`	`56`
`57`		`-func (e EnvironmentStat) String() string { return string(e.ContainerStatus) }`
	`57`	`+// Column defines how EnvironmentStat should format in as a table column.`
	`58`	`+func (e EnvironmentStat) Column() string { return string(e.ContainerStatus) }`
`58`	`59`
`59`	`60`	`// EnvironmentStatus refers to the states of an environment.`
`60`	`61`	`type EnvironmentStatus string`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,8 @@ type ImageTag struct {`
`18`	`18`	CreatedAt time.Time `json:"created_at" table:"-"`
`19`	`19`	`}`
`20`	`20`
`21`		`-func (i ImageTag) String() string {`
	`21`	`+// Column defines how ImageTag should format in as a table column.`
	`22`	`+func (i ImageTag) Column() string {`
`22`	`23`	`return i.Tag`
`23`	`24`	`}`
`24`	`25`
`@@ -29,9 +30,8 @@ type OSRelease struct {`
`29`	`30`	HomeURL string `json:"home_url"`
`30`	`31`	`}`
`31`	`32`
`32`		`-func (o OSRelease) String() string {`
`33`		`- return o.PrettyName`
`34`		`-}`
	`33`	`+// Column defines how OSRelease should format in as a table column.`
	`34`	`+func (o OSRelease) Column() string { return o.PrettyName }`
`35`	`35`
`36`	`36`	`// CreateImageTagReq defines the request parameters for creating a new image tag.`
`37`	`37`	`type CreateImageTagReq struct {`