-
Notifications
You must be signed in to change notification settings - Fork 0
/
tablewriter.go
175 lines (150 loc) · 3.78 KB
/
tablewriter.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
package tablewriter
import (
"encoding/csv"
"errors"
"io"
"os"
"time"
// Packages
text "github.com/djthorpe/go-tablewriter/pkg/text"
)
///////////////////////////////////////////////////////////////////////////////
// TYPES
// A writer object which can write table data to an io.Writer
type Writer struct {
w io.Writer
opts []TableOpt
csv *csv.Writer
text *text.Writer
}
///////////////////////////////////////////////////////////////////////////////
// GLOBALS
const (
defaultTagName = "json"
defaultNull = "<nil>"
defaultTimeLayout = time.RFC1123
)
var (
errUnsupportedFormat = errors.New("unsupported output format")
)
///////////////////////////////////////////////////////////////////////////////
// LIFECYCLE
// New creates a new Writer object, with options for all subsequent writes
func New(w io.Writer, opts ...TableOpt) *Writer {
self := new(Writer)
self.opts = opts
if w == nil {
self.w = os.Stdout
} else {
self.w = w
}
// Return success
return self
}
///////////////////////////////////////////////////////////////////////////////
// PUBLIC METHODS
// Output will return the underlying io.Writer object
func (w *Writer) Output() io.Writer {
return w.w
}
// Write the table to output, applying any options which override to the
// options passed to the New method
func (w *Writer) Write(v any, opts ...TableOpt) error {
var result error
// Create a metadata object which creates an iterator for the data
meta, err := w.NewMeta(v, opts...)
if err != nil {
return err
}
// If the format is JSON then create a JSON writer
switch meta.(*tablemeta).opts.format {
case formatCSV:
w.csv = csv.NewWriter(w.w)
w.csv.Comma = meta.(*tablemeta).opts.delim
case formatText:
opts := []text.Opt{}
for i, fmt := range meta.(*tablemeta).Formats() {
// TODO: Only set a format if there is a wrap, align or width on the column meta
opts = append(opts, text.OptFormat(fmt, i))
}
if writer, err := text.NewWriter(w.w, opts...); err != nil {
return err
} else {
w.text = writer
}
default:
return errUnsupportedFormat
}
// Create an iterator
iterator, err := NewIterator(v)
if err != nil {
return err
}
// TODO: Check for zeroed-data columns
//for row := iterator.Next(); row != nil; row = iterator.Next() {
// if err := meta.CheckZero(row); err != nil {
// result = errors.Join(result, err)
// }
//}
//iterator.Reset()
// Write rows
header := false
for row := iterator.Next(); row != nil; row = iterator.Next() {
if !header {
if meta.(*tablemeta).header {
if err := w.writeHeader(meta.(*tablemeta)); err != nil {
result = errors.Join(result, err)
break
}
}
header = true
}
if err := w.writeRow(meta.(*tablemeta), row); err != nil {
result = errors.Join(result, err)
}
}
// Flush
switch meta.(*tablemeta).opts.format {
case formatCSV:
w.csv.Flush()
if err := w.csv.Error(); err != nil {
result = errors.Join(result, err)
}
}
// Return any errors
return result
}
///////////////////////////////////////////////////////////////////////////////
// PRIVATE METHODS
func (w *Writer) writeHeader(meta *tablemeta) error {
switch meta.opts.format {
case formatCSV:
if err := w.csv.Write(meta.Fields()); err != nil {
return err
}
case formatText:
if err := w.text.Write(meta.Fields()); err != nil {
return err
}
}
// Return success
return nil
}
func (w *Writer) writeRow(meta *tablemeta, row any) error {
switch meta.opts.format {
case formatCSV:
if values, err := meta.StringValues(row); err != nil {
return err
} else if err := w.csv.Write(values); err != nil {
return err
}
case formatText:
if values, err := meta.StringValues(row); err != nil {
return err
} else if err := w.text.Write(values); err != nil {
return err
}
}
// Return success
return nil
}