jimeh/go-render
1
0
Fork 0
mirror of https://github.com/jimeh/go-render.git synced 2026-02-19 11:26:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(examples): improve examples

Browse Source
This commit is contained in:
Jim Myhrberg
2024-03-25 03:02:37 +00:00
parent eb5cc910dd
commit 9b894eaeca
1 changed files with 186 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files

323
render_example_test.go
View File

@@ -11,28 +11,28 @@ import (
) )
func ExampleRender_json() { func ExampleRender_json() {
type Role struct { type Version struct {
Name string `json:"name" yaml:"name" xml:"name"` Version string `json:"version" yaml:"version" xml:",chardata"`
Icon string `json:"icon" yaml:"icon" xml:"icon"` Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"`
Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"`
} }
type User struct { type OutputList struct {
Name string `json:"name" yaml:"name" xml:"name"` Current string `json:"current" yaml:"current" xml:"current"`
Age int `json:"age" yaml:"age" xml:"age"` Versions []Version `json:"versions" yaml:"versions" xml:"version"`
Roles []*Role `json:"roles" yaml:"roles" xml:"roles"`
Tags []string `json:"tags" yaml:"tags" xml:"tags"`
XMLName xml.Name `json:"-" yaml:"-" xml:"user"` XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"`
} }
data := &User{ data := &OutputList{
Name: "John Doe", Current: "1.2.2",
Age: 30, Versions: []Version{
Roles: []*Role{ {Version: "1.2.2", Stable: true, Latest: true},
{Name: "admin", Icon: "shield"}, {Version: "1.2.1", Stable: true},
{Name: "developer", Icon: "keyboard"}, {Version: "1.2.0", Stable: true},
{Version: "1.2.0-rc.0", Stable: false},
{Version: "1.1.0", Stable: true},
}, },
Tags: []string{"golang", "json", "yaml", "toml"},
} }
// Render the object to JSON. // Render the object to JSON.
@@ -45,50 +45,60 @@ func ExampleRender_json() {
// Output: // Output:
// { // {
// "name": "John Doe", // "current": "1.2.2",
// "age": 30, // "versions": [
// "roles": [
// { // {
// "name": "admin", // "version": "1.2.2",
// "icon": "shield" // "latest": true,
// "stable": true
// }, // },
// { // {
// "name": "developer", // "version": "1.2.1",
// "icon": "keyboard" // "latest": false,
// "stable": true
// },
// {
// "version": "1.2.0",
// "latest": false,
// "stable": true
// },
// {
// "version": "1.2.0-rc.0",
// "latest": false,
// "stable": false
// },
// {
// "version": "1.1.0",
// "latest": false,
// "stable": true
// } // }
// ],
// "tags": [
// "golang",
// "json",
// "yaml",
// "toml"
// ] // ]
// } // }
} }
func ExampleRender_yaml() { func ExampleRender_yaml() {
type Role struct { type Version struct {
Name string `json:"name" yaml:"name" xml:"name"` Version string `json:"version" yaml:"version" xml:",chardata"`
Icon string `json:"icon" yaml:"icon" xml:"icon"` Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"`
Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"`
} }
type User struct { type OutputList struct {
Name string `json:"name" yaml:"name" xml:"name"` Current string `json:"current" yaml:"current" xml:"current"`
Age int `json:"age" yaml:"age" xml:"age"` Versions []Version `json:"versions" yaml:"versions" xml:"version"`
Roles []*Role `json:"roles" yaml:"roles" xml:"roles"`
Tags []string `json:"tags" yaml:"tags" xml:"tags"`
XMLName xml.Name `json:"-" yaml:"-" xml:"user"` XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"`
} }
data := &User{ data := &OutputList{
Name: "John Doe", Current: "1.2.2",
Age: 30, Versions: []Version{
Roles: []*Role{ {Version: "1.2.2", Stable: true, Latest: true},
{Name: "admin", Icon: "shield"}, {Version: "1.2.1", Stable: true},
{Name: "developer", Icon: "keyboard"}, {Version: "1.2.0", Stable: true},
{Version: "1.2.0-rc.0", Stable: false},
{Version: "1.1.0", Stable: true},
}, },
Tags: []string{"golang", "json", "yaml", "toml"},
} }
// Render the object to YAML. // Render the object to YAML.
@@ -100,43 +110,48 @@ func ExampleRender_yaml() {
fmt.Println(buf.String()) fmt.Println(buf.String())
// Output: // Output:
// name: John Doe // current: 1.2.2
// age: 30 // versions:
// roles: // - version: 1.2.2
// - name: admin // latest: true
// icon: shield // stable: true
// - name: developer // - version: 1.2.1
// icon: keyboard // latest: false
// tags: // stable: true
// - golang // - version: 1.2.0
// - json // latest: false
// - yaml // stable: true
// - toml // - version: 1.2.0-rc.0
// latest: false
// stable: false
// - version: 1.1.0
// latest: false
// stable: true
} }
func ExampleRender_xml() { func ExampleRender_xml() {
type Role struct { type Version struct {
Name string `json:"name" yaml:"name" xml:"name"` Version string `json:"version" yaml:"version" xml:",chardata"`
Icon string `json:"icon" yaml:"icon" xml:"icon"` Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"`
Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"`
} }
type User struct { type OutputList struct {
Name string `json:"name" yaml:"name" xml:"name"` Current string `json:"current" yaml:"current" xml:"current"`
Age int `json:"age" yaml:"age" xml:"age"` Versions []Version `json:"versions" yaml:"versions" xml:"version"`
Roles []*Role `json:"roles" yaml:"roles" xml:"roles"`
Tags []string `json:"tags" yaml:"tags" xml:"tags"`
XMLName xml.Name `json:"-" yaml:"-" xml:"user"` XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"`
} }
data := &User{ data := &OutputList{
Name: "John Doe", Current: "1.2.2",
Age: 30, Versions: []Version{
Roles: []*Role{ {Version: "1.2.2", Stable: true, Latest: true},
{Name: "admin", Icon: "shield"}, {Version: "1.2.1", Stable: true},
{Name: "developer", Icon: "keyboard"}, {Version: "1.2.0", Stable: true},
{Version: "1.2.0-rc.0", Stable: false},
{Version: "1.1.0", Stable: true},
}, },
Tags: []string{"golang", "json", "yaml", "toml"},
} }
// Create a new renderer that supports XML in addition to the default JSON, // Create a new renderer that supports XML in addition to the default JSON,
@@ -152,50 +167,14 @@ func ExampleRender_xml() {
fmt.Println(buf.String()) fmt.Println(buf.String())
// Output: // Output:
// <user> // <versions-list>
// <name>John Doe</name> // <current>1.2.2</current>
// <age>30</age> // <version latest="true" stable="true">1.2.2</version>
// <roles> // <version latest="false" stable="true">1.2.1</version>
// <name>admin</name> // <version latest="false" stable="true">1.2.0</version>
// <icon>shield</icon> // <version latest="false" stable="false">1.2.0-rc.0</version>
// </roles> // <version latest="false" stable="true">1.1.0</version>
// <roles> // </versions-list>
// <name>developer</name>
// <icon>keyboard</icon>
// </roles>
// <tags>golang</tags>
// <tags>json</tags>
// <tags>yaml</tags>
// <tags>toml</tags>
// </user>
}
type Role struct {
Name string `json:"name" yaml:"name" xml:"name"`
Icon string `json:"icon" yaml:"icon" xml:"icon"`
}
func (r *Role) WriteTo(w io.Writer) (int64, error) {
s := fmt.Sprintf("%s (%s)", r.Name, r.Icon)
n, err := w.Write([]byte(s))
return int64(n), err
}
type User struct {
Name string `json:"name" yaml:"name" xml:"name"`
Age int `json:"age" yaml:"age" xml:"age"`
Roles []*Role `json:"roles" yaml:"roles" xml:"roles"`
Tags []string `json:"tags" yaml:"tags" xml:"tags"`
XMLName xml.Name `json:"-" yaml:"-" xml:"user"`
}
func (u *User) String() string {
return fmt.Sprintf(
"%s (%d): %s",
u.Name, u.Age, strings.Join(u.Tags, ", "),
)
} }
func ExampleRender_textFromByteSlice() { func ExampleRender_textFromByteSlice() {
@@ -244,19 +223,21 @@ func ExampleRender_textFromIOReader() {
} }
func ExampleRender_textFromWriterTo() { func ExampleRender_textFromWriterTo() {
// The Role struct has a WriteTo method which writes a string representation // The Version struct has a WriteTo method which writes a string
// of a role to an io.Writer: // representation of a version to an io.Writer:
// //
// func (r *Role) WriteTo(w io.Writer) (int64, error) { // func (v *Version) WriteTo(w io.Writer) (int64, error) {
// s := fmt.Sprintf("%s (%s)", r.Name, r.Icon) // s := fmt.Sprintf(
// "%s (stable: %t, latest: %t)", v.Version, v.Stable, v.Latest,
// )
// n, err := w.Write([]byte(s)) // n, err := w.Write([]byte(s))
// //
// return int64(n), err // return int64(n), err
// } // }
data := &Role{Name: "admin", Icon: "shield"} data := &Version{Version: "1.2.1", Stable: true, Latest: false}
// Render the object to XML. // Render the object to text.
buf := &bytes.Buffer{} buf := &bytes.Buffer{}
err := render.Pretty(buf, "text", data) err := render.Pretty(buf, "text", data)
if err != nil { if err != nil {
@@ -265,28 +246,92 @@ func ExampleRender_textFromWriterTo() {
fmt.Println(buf.String()) fmt.Println(buf.String())
// Output: // Output:
// admin (shield) // 1.2.1 (stable: true, latest: false)
}
type Version struct {
Version string `json:"version" yaml:"version" xml:",chardata"`
Latest bool `json:"latest" yaml:"latest" xml:"latest,attr"`
Stable bool `json:"stable" yaml:"stable" xml:"stable,attr"`
}
func (v *Version) WriteTo(w io.Writer) (int64, error) {
s := fmt.Sprintf(
"%s (stable: %t, latest: %t)", v.Version, v.Stable, v.Latest,
)
n, err := w.Write([]byte(s))
return int64(n), err
}
type OutputList struct {
Current string `json:"current" yaml:"current" xml:"current"`
Versions []Version `json:"versions" yaml:"versions" xml:"version"`
XMLName xml.Name `json:"-" yaml:"-" xml:"versions-list"`
}
func (ol *OutputList) String() string {
buf := &strings.Builder{}
for _, ver := range ol.Versions {
if ol.Current == ver.Version {
buf.WriteString("* ")
} else {
buf.WriteString(" ")
}
buf.WriteString(ver.Version)
if !ver.Stable {
buf.WriteString(" (pre-release)")
}
if ver.Latest {
buf.WriteString(" (latest)")
}
buf.WriteByte('\n')
}
return buf.String()
} }
func ExampleRender_textFromStringer() { func ExampleRender_textFromStringer() {
// The User struct has a String method which returns a string representation // The User struct has a String method which returns a string representation
// of a user: // of a user:
// //
// func (u *User) String() string { // func (ol *OutputList) String() string {
// return fmt.Sprintf( // buf := &strings.Builder{}
// "%s (%d): %s", //
// u.Name, u.Age, strings.Join(u.Tags, ", "), // for _, ver := range ol.Versions {
// ) // if ol.Current == ver.Version {
// buf.WriteString("* ")
// } else {
// buf.WriteString(" ")
// }
//
// buf.WriteString(ver.Version)
// if !ver.Stable {
// buf.WriteString(" (pre-release)")
// }
// if ver.Latest {
// buf.WriteString(" (latest)")
// }
//
// buf.WriteByte('\n')
// }
//
// return buf.String()
// } // }
data := &User{ data := &OutputList{
Name: "John Doe", Current: "1.2.2",
Age: 30, Versions: []Version{
Roles: []*Role{ {Version: "1.2.2", Stable: true, Latest: true},
{Name: "admin", Icon: "shield"}, {Version: "1.2.1", Stable: true},
{Name: "developer", Icon: "keyboard"}, {Version: "1.2.0", Stable: true},
{Version: "1.2.0-rc.0", Stable: false},
{Version: "1.1.0", Stable: true},
}, },
Tags: []string{"golang", "json", "yaml", "toml"},
} }
// Render the object to XML. // Render the object to XML.
@@ -298,5 +343,9 @@ func ExampleRender_textFromStringer() {
fmt.Println(buf.String()) fmt.Println(buf.String())
// Output: // Output:
// John Doe (30): golang, json, yaml, toml // * 1.2.2 (latest)
// 1.2.1
// 1.2.0
// 1.2.0-rc.0 (pre-release)
// 1.1.0
} }