re-add table in a dedicated package

Author: Massimiliano Pippi

cli/board/details.go

@@ -20,15 +20,15 @@ package board
 import (
 	"context"
 	"os"
-	"text/tabwriter"
 
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/cli/globals"
 	"github.com/arduino/arduino-cli/cli/instance"
 	"github.com/arduino/arduino-cli/commands/board"
 	rpc "github.com/arduino/arduino-cli/rpc/commands"
-	"github.com/cheynewallace/tabby"
+	"github.com/arduino/arduino-cli/table"
+	"github.com/fatih/color"
 	"github.com/spf13/cobra"
 )
 
@@ -60,7 +60,7 @@ func runDetailsCommand(cmd *cobra.Command, args []string) {
 }
 
 func outputDetailsResp(details *rpc.BoardDetailsResp) {
-	// Table is 5 columns wide:
+	// Table is 4 columns wide:
 	// |               |                             | |                       |
 	// Board name:     Arduino Nano
 	//
@@ -69,33 +69,40 @@ func outputDetailsResp(details *rpc.BoardDetailsResp) {
 	//                 arduino:arduinoOTA              1.2.1
 	//
 	// Option:         Processor                       cpu
-	//                 ATmega328P                    * cpu=atmega328
+	//                 ATmega328P                    ✔ cpu=atmega328
 	//                 ATmega328P (Old Bootloader)     cpu=atmega328old
 	//                 ATmega168                       cpu=atmega168
-	w := tabwriter.NewWriter(feedback.OutputWriter(), 0, 0, 2, ' ', 0)
-	table := tabby.NewCustom(w)
-
-	table.AddLine("Board name:", details.Name, "")
+	t := table.New()
+	t.SetColumnWidthMode(1, table.Average)
+	t.AddRow("Board name:", details.Name)
 
 	for i, tool := range details.RequiredTools {
 		if i == 0 {
-			table.AddLine("", "", "", "") // get some space from above
-			table.AddLine("Required tools:", tool.Packager+":"+tool.Name, "", tool.Version)
+			t.AddRow() // get some space from above
+			t.AddRow("Required tools:", tool.Packager+":"+tool.Name, "", tool.Version)
 			continue
 		}
-		table.AddLine("", tool.Packager+":"+tool.Name, "", tool.Version)
+		t.AddRow("", tool.Packager+":"+tool.Name, "", tool.Version)
 	}
 
 	for _, option := range details.ConfigOptions {
-		table.AddLine("", "", "", "") // get some space from above
-		table.AddLine("Option:", option.OptionLabel, "", option.Option)
+		t.AddRow() // get some space from above
+		t.AddRow("Option:", option.OptionLabel, "", option.Option)
 		for _, value := range option.Values {
-			checked := ""
+			green := color.New(color.FgGreen)
 			if value.Selected {
-				checked = "✔"
+				t.AddRow("",
+					table.NewCell(value.ValueLabel, green),
+					table.NewCell("✔", green),
+					table.NewCell(option.Option+"="+value.Value, green))
+			} else {
+				t.AddRow("",
+					value.ValueLabel,
+					"",
+					option.Option+"="+value.Value)
 			}
-			table.AddLine("", value.ValueLabel, checked, option.Option+"="+value.Value)
 		}
 	}
-	table.Print()
+
+	feedback.Print(t.Render())
 }

cli/board/list.go

@@ -20,7 +20,6 @@ package board
 import (
 	"os"
 	"sort"
-	"text/tabwriter"
 	"time"
 
 	"github.com/arduino/arduino-cli/cli/errorcodes"
@@ -29,7 +28,7 @@ import (
 	"github.com/arduino/arduino-cli/cli/instance"
 	"github.com/arduino/arduino-cli/commands/board"
 	rpc "github.com/arduino/arduino-cli/rpc/commands"
-	"github.com/cheynewallace/tabby"
+	"github.com/arduino/arduino-cli/table"
 	"github.com/spf13/cobra"
 )
 
@@ -85,9 +84,8 @@ func outputListResp(ports []*rpc.DetectedPort) {
 			(x.GetProtocol() == y.GetProtocol() && x.GetAddress() < y.GetAddress())
 	})
 
-	w := tabwriter.NewWriter(feedback.OutputWriter(), 0, 0, 2, ' ', 0)
-	table := tabby.NewCustom(w)
-	table.AddHeader("Port", "Type", "Board Name", "FQBN")
+	t := table.New()
+	t.SetHeader("Port", "Type", "Board Name", "FQBN")
 	for _, port := range ports {
 		address := port.GetProtocol() + "://" + port.GetAddress()
 		if port.GetProtocol() == "serial" {
@@ -102,16 +100,16 @@ func outputListResp(ports []*rpc.DetectedPort) {
 			for _, b := range boards {
 				board := b.GetName()
 				fqbn := b.GetFQBN()
-				table.AddLine(address, protocol, board, fqbn)
+				t.AddRow(address, protocol, board, fqbn)
 				// show address and protocol only on the first row
 				address = ""
 				protocol = ""
 			}
 		} else {
 			board := "Unknown"
 			fqbn := ""
-			table.AddLine(address, protocol, board, fqbn)
+			t.AddRow(address, protocol, board, fqbn)
 		}
 	}
-	table.Print()
+	feedback.Print(t.Render())
 }

cli/board/listall.go

@@ -21,15 +21,14 @@ import (
 	"context"
 	"os"
 	"sort"
-	"text/tabwriter"
 
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/cli/globals"
 	"github.com/arduino/arduino-cli/cli/instance"
 	"github.com/arduino/arduino-cli/commands/board"
 	rpc "github.com/arduino/arduino-cli/rpc/commands"
-	"github.com/cheynewallace/tabby"
+	"github.com/arduino/arduino-cli/table"
 	"github.com/spf13/cobra"
 )
 
@@ -71,11 +70,10 @@ func outputBoardListAll(list *rpc.BoardListAllResp) {
 		return list.Boards[i].GetName() < list.Boards[j].GetName()
 	})
 
-	w := tabwriter.NewWriter(feedback.OutputWriter(), 0, 0, 2, ' ', 0)
-	table := tabby.NewCustom(w)
-	table.AddHeader("Board Name", "FQBN")
+	t := table.New()
+	t.SetHeader("Board Name", "FQBN")
 	for _, item := range list.GetBoards() {
-		table.AddLine(item.GetName(), item.GetFQBN())
+		t.AddRow(item.GetName(), item.GetFQBN())
 	}
-	table.Print()
+	feedback.Print(t.Render())
 }

cli/core/list.go

@@ -20,15 +20,14 @@ package core
 import (
 	"os"
 	"sort"
-	"text/tabwriter"
 
 	"github.com/arduino/arduino-cli/arduino/cores"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/cli/globals"
 	"github.com/arduino/arduino-cli/cli/instance"
 	"github.com/arduino/arduino-cli/commands/core"
-	"github.com/cheynewallace/tabby"
+	"github.com/arduino/arduino-cli/table"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
@@ -72,15 +71,14 @@ func outputInstalledCores(platforms []*cores.PlatformRelease) {
 		return
 	}
 
-	w := tabwriter.NewWriter(feedback.OutputWriter(), 0, 0, 2, ' ', 0)
-	table := tabby.NewCustom(w)
-	table.AddHeader("ID", "Installed", "Latest", "Name")
+	t := table.New()
+	t.SetHeader("ID", "Installed", "Latest", "Name")
 	sort.Slice(platforms, func(i, j int) bool {
 		return platforms[i].Platform.String() < platforms[j].Platform.String()
 	})
 	for _, p := range platforms {
-		table.AddLine(p.Platform.String(), p.Version.String(), p.Platform.GetLatestRelease().Version.String(), p.Platform.Name)
+		t.AddRow(p.Platform.String(), p.Version.String(), p.Platform.GetLatestRelease().Version.String(), p.Platform.Name)
 	}
 
-	table.Print()
+	feedback.Print(t.Render())
 }

cli/core/search.go

@@ -22,15 +22,14 @@ import (
 	"os"
 	"sort"
 	"strings"
-	"text/tabwriter"
 
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/cli/globals"
 	"github.com/arduino/arduino-cli/cli/instance"
 	"github.com/arduino/arduino-cli/commands/core"
 	rpc "github.com/arduino/arduino-cli/rpc/commands"
-	"github.com/cheynewallace/tabby"
+	"github.com/arduino/arduino-cli/table"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
@@ -73,16 +72,15 @@ func runSearchCommand(cmd *cobra.Command, args []string) {
 
 func outputSearchCores(cores []*rpc.Platform) {
 	if len(cores) > 0 {
-		w := tabwriter.NewWriter(feedback.OutputWriter(), 0, 0, 2, ' ', 0)
-		table := tabby.NewCustom(w)
-		table.AddHeader("ID", "Version", "Name")
+		t := table.New()
+		t.SetHeader("ID", "Version", "Name")
 		sort.Slice(cores, func(i, j int) bool {
 			return cores[i].ID < cores[j].ID
 		})
 		for _, item := range cores {
-			table.AddLine(item.GetID(), item.GetLatest(), item.GetName())
+			t.AddRow(item.GetID(), item.GetLatest(), item.GetName())
 		}
-		table.Print()
+		feedback.Print(t.Render())
 	} else {
 		feedback.Print("No platforms matching your search.")
 	}

cli/lib/list.go

@@ -19,15 +19,14 @@ package lib
 
 import (
 	"os"
-	"text/tabwriter"
 
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/cli/globals"
 	"github.com/arduino/arduino-cli/cli/instance"
 	"github.com/arduino/arduino-cli/commands/lib"
 	rpc "github.com/arduino/arduino-cli/rpc/commands"
-	"github.com/cheynewallace/tabby"
+	"github.com/arduino/arduino-cli/table"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 	"golang.org/x/net/context"
@@ -82,9 +81,8 @@ func outputListLibrary(il []*rpc.InstalledLibrary) {
 		return
 	}
 
-	w := tabwriter.NewWriter(feedback.OutputWriter(), 0, 0, 2, ' ', 0)
-	table := tabby.NewCustom(w)
-	table.AddHeader("Name", "Installed", "Available", "Location")
+	t := table.New()
+	t.SetHeader("Name", "Installed", "Available", "Location")
 
 	lastName := ""
 	for _, libMeta := range il {
@@ -104,12 +102,12 @@ func outputListLibrary(il []*rpc.InstalledLibrary) {
 		if libMeta.GetRelease() != nil {
 			available := libMeta.GetRelease().GetVersion()
 			if available != "" {
-				table.AddLine(name, lib.Version, available, location)
+				t.AddRow(name, lib.Version, available, location)
 			} else {
-				table.AddLine(name, lib.Version, "-", location)
+				t.AddRow(name, lib.Version, "-", location)
 			}
 		}
 	}
 
-	table.Print()
+	feedback.Print(t.Render())
 }

go.mod

@@ -9,7 +9,6 @@ require (
 	github.com/arduino/go-properties-orderedmap v0.0.0-20181003091528-89278049acd3
 	github.com/arduino/go-timeutils v0.0.0-20171220113728-d1dd9e313b1b
 	github.com/arduino/go-win32-utils v0.0.0-20180330194947-ed041402e83b
-	github.com/cheynewallace/tabby v1.1.0
 	github.com/cmaglie/pb v1.0.27
 	github.com/codeclysm/cc v1.2.2 // indirect
 	github.com/codeclysm/extract v2.2.0+incompatible

table/cell.go

@@ -0,0 +1,87 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2019 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to modify or
+// otherwise use the software for commercial activities involving the Arduino
+// software without disclosing the source code of your own applications. To purchase
+// a commercial license, send an email to license@arduino.cc.
+
+package table
+
+import (
+	"fmt"
+	"unicode/utf8"
+
+	"github.com/fatih/color"
+)
+
+// JustifyMode is used to configure text alignment on cells
+type JustifyMode int
+
+// Justify mode enumeration
+const (
+	JustifyLeft JustifyMode = iota
+	JustifyCenter
+	JustifyRight
+)
+
+// Cell represents a Table cell
+type Cell struct {
+	clean   string
+	raw     string
+	justify JustifyMode
+}
+
+// NewCell creates a new cell. Color can be nil.
+func NewCell(text string, c *color.Color) *Cell {
+	styled := text
+	if c != nil {
+		styled = c.SprintFunc()(text)
+	}
+
+	return &Cell{
+		raw:     styled,
+		clean:   text,
+		justify: JustifyLeft,
+	}
+}
+
+// Len returns the size of the cell, taking into account color codes
+func (t *Cell) Len() int {
+	return utf8.RuneCountInString(t.clean)
+}
+
+// Justify sets text justification
+func (t *Cell) Justify(mode JustifyMode) {
+	t.justify = mode
+}
+
+// Pad sets the cell padding
+func (t *Cell) Pad(totalLen int) string {
+	delta := totalLen - t.Len()
+	switch t.justify {
+	case 0:
+		return t.raw + spaces(delta)
+	case 1:
+		return spaces(delta/2) + t.raw + spaces(delta-delta/2)
+	case 2:
+		return spaces(delta) + t.raw
+	}
+	panic(fmt.Sprintf("internal error: invalid justify %d", t.justify))
+}
+
+func spaces(n int) string {
+	res := ""
+	for n > 0 {
+		res += " "
+		n--
+	}
+	return res
+}