File: prettytables.go

package info (click to toggle)
golang-github-jaytaylor-html2text 0.0~git20230321.74c2419-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 196 kB
  • sloc: makefile: 6
file content (212 lines) | stat: -rw-r--r-- 5,016 bytes parent folder | download
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
package html2text

import (
	"github.com/olekukonko/tablewriter"
	"github.com/olekukonko/tablewriter/tw"
)

// PrettyTablesOptions overrides tablewriter behaviors
type PrettyTablesOptions struct {
	AutoFormatHeader bool
	AutoWrapText     bool
	// Deprecated. Tablewriter always assumes this to be `true`
	ReflowDuringAutoWrap bool
	ColWidth             int
	ColumnSeparator      string
	RowSeparator         string
	CenterSeparator      string
	HeaderAlignment      tw.Align
	FooterAlignment      tw.Align
	Alignment            tw.Align
	ColumnAlignment      tw.Alignment
	// Deprecated. Tablewriter always assumes this to be `\n`
	NewLine        string
	HeaderLine     bool
	RowLine        bool
	AutoMergeCells bool
	Borders        Border
	// Configuration allows to directly manipulate the `Table` with all what [tablewriter] offers.
	// Setting this ignores all the rest of the settings of this struct.
	Configuration func(table *tablewriter.Table)
}

// NewPrettyTablesOptions creates PrettyTablesOptions with default settings
func NewPrettyTablesOptions() *PrettyTablesOptions {
	return &PrettyTablesOptions{
		AutoFormatHeader: true,
		AutoWrapText:     true,
		ColWidth:         32, // old tablewriter.MAX_ROW_WIDTH + borders now count into width
		ColumnSeparator:  defaultBorderStyle.ColumnSeparator,
		RowSeparator:     defaultBorderStyle.RowSeparator,
		CenterSeparator:  defaultBorderStyle.CenterSeparator,
		HeaderAlignment:  tw.AlignCenter,
		FooterAlignment:  tw.AlignCenter,
		Alignment:        tw.AlignDefault,
		ColumnAlignment:  make(tw.Alignment, 0),
		HeaderLine:       true,
		RowLine:          false,
		AutoMergeCells:   false,
		Borders:          Border{Left: true, Right: true, Bottom: true, Top: true},
	}
}

func (p *PrettyTablesOptions) configureTable(table *tablewriter.Table) {
	if p.Configuration != nil {
		p.Configuration(table)
		return
	}

	cfg := tablewriter.NewConfigBuilder()

	cfg.WithHeaderAutoFormat(asState(p.AutoFormatHeader)).WithFooterAutoFormat(asState(p.AutoFormatHeader)).
		WithRowAutoWrap(p.wrapMode()).WithHeaderAutoWrap(p.wrapMode()).WithFooterAutoWrap(p.wrapMode()).
		WithRowMaxWidth(p.ColWidth).
		WithHeaderAlignment(p.HeaderAlignment).
		WithFooterAlignment(p.FooterAlignment).
		WithRowAlignment(p.Alignment).
		WithRowMergeMode(p.mergeMode())

	if len(p.ColumnAlignment) > 0 {
		cfg.Row().Alignment().WithPerColumn(p.ColumnAlignment)
	}

	rendition := tw.Rendition{
		Borders:  p.Borders.withStates(),
		Symbols:  p.borderStyle(),
		Settings: p.renderSettings(),
	}

	table.Options(
		tablewriter.WithConfig(cfg.Build()),
		tablewriter.WithRendition(rendition))
}

func (p *PrettyTablesOptions) wrapMode() int {
	if p.AutoWrapText {
		return tw.WrapNormal
	} else {
		return tw.WrapNone
	}
}

func (p *PrettyTablesOptions) mergeMode() int {
	if p.AutoMergeCells {
		return tw.MergeVertical
	} else {
		return tw.MergeNone
	}
}

func (p *PrettyTablesOptions) renderSettings() tw.Settings {
	return tw.Settings{
		Lines: tw.Lines{
			ShowHeaderLine: asState(p.HeaderLine),
		},
		Separators: tw.Separators{
			BetweenRows: asState(p.RowLine),
		},
	}
}

// Border controls tablewriter borders. It uses simple bools instead of tablewriters `State`
type Border struct {
	Left, Right, Bottom, Top bool
}

func (b Border) withStates() tw.Border {
	return tw.Border{
		Left:   asState(b.Left),
		Right:  asState(b.Right),
		Bottom: asState(b.Bottom),
		Top:    asState(b.Top),
	}
}

type BorderStyle struct {
	ColumnSeparator string
	RowSeparator    string
	CenterSeparator string
}

func (b BorderStyle) Name() string {
	return "html2text"
}

func (b BorderStyle) Center() string {
	return b.CenterSeparator
}

func (b BorderStyle) Row() string {
	return b.RowSeparator
}

func (b BorderStyle) Column() string {
	return b.ColumnSeparator
}

func (b BorderStyle) TopLeft() string {
	return b.CenterSeparator
}

func (b BorderStyle) TopMid() string {
	return b.CenterSeparator
}

func (b BorderStyle) TopRight() string {
	return b.CenterSeparator
}

func (b BorderStyle) MidLeft() string {
	return b.CenterSeparator
}

func (b BorderStyle) MidRight() string {
	return b.CenterSeparator
}

func (b BorderStyle) BottomLeft() string {
	return b.CenterSeparator
}

func (b BorderStyle) BottomMid() string {
	return b.CenterSeparator
}

func (b BorderStyle) BottomRight() string {
	return b.CenterSeparator
}

func (b BorderStyle) HeaderLeft() string {
	return b.CenterSeparator
}

func (b BorderStyle) HeaderMid() string {
	return b.CenterSeparator
}

func (b BorderStyle) HeaderRight() string {
	return b.CenterSeparator
}

var defaultBorderStyle = BorderStyle{
	ColumnSeparator: "|",
	RowSeparator:    "-",
	CenterSeparator: "+",
}

func (p *PrettyTablesOptions) borderStyle() BorderStyle {
	return BorderStyle{
		ColumnSeparator: p.ColumnSeparator,
		RowSeparator:    p.RowSeparator,
		CenterSeparator: p.CenterSeparator,
	}
}

func asState(b bool) tw.State {
	// TableWriter does not provide this by default :(
	if b {
		return tw.On
	} else {
		return tw.Off
	}
}