fix: table expand math error

charmbracelet · Oct 3, 2023 · d28947e · d28947e
1 parent 33a15e3
commit d28947e
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 33 deletions.
diff --git a/examples/table/pokemon/main.go b/examples/table/pokemon/main.go
@@ -69,6 +69,7 @@ func main() {
 		Border(lipgloss.NormalBorder()).
 		BorderStyle(re.NewStyle().Foreground(lipgloss.Color("238"))).
 		Headers(CapitalizeHeaders(headers)...).
+		Width(90).
 		Rows(data...).
 		StyleFunc(func(row, col int) lipgloss.Style {
 			if row == 0 {

diff --git a/table/table.go b/table/table.go
@@ -33,8 +33,8 @@ import (
 //	    })
 type StyleFunc func(row, col int) lipgloss.Style
 
-// NoTableStyle is a TableStyleFunc that returns a new Style with no attributes.
-func NoTableStyle(_, _ int) lipgloss.Style {
+// DefaultStyles is a TableStyleFunc that returns a new Style with no attributes.
+func DefaultStyles(_, _ int) lipgloss.Style {
 	return lipgloss.NewStyle()
 }
 
@@ -70,8 +70,8 @@ type Table struct {
 // By default, a table has no border, no styling, and no rows.
 func New() *Table {
 	return &Table{
-		styleFunc:    NoTableStyle,
-		border:       lipgloss.HiddenBorder(),
+		styleFunc:    DefaultStyles,
+		border:       lipgloss.RoundedBorder(),
 		borderBottom: true,
 		borderColumn: true,
 		borderHeader: true,
@@ -282,6 +282,9 @@ func (t *Table) String() string {
 			for i := range t.widths {
 				t.widths[i]++
 				tableWidth++
+				if tableWidth >= t.width {
+					break
+				}
 			}
 		}
 	} else if tableWidth > t.width && t.width > 0 {
@@ -472,7 +475,10 @@ func (t *Table) String() string {
 		}
 	}
 
-	return s.String()
+	height := sum(t.heights) - 1 + boolToInt(hasHeaders) +
+		boolToInt(t.borderHeader) + boolToInt(t.borderTop) + boolToInt(t.borderBottom) +
+		len(t.rows)*boolToInt(t.borderRow)
+	return lipgloss.NewStyle().MaxHeight(height).MaxWidth(t.width).Render(s.String())
 }
 
 // Render returns the table as a string.

diff --git a/table/table_test.go b/table/table_test.go
@@ -313,11 +313,10 @@ func TestTableUnsetBorders(t *testing.T) {
  French   │ Bonjour      │ Salut     
  Japanese │ こんにちは   │ やあ      
  Russian  │ Zdravstvuyte │ Privet    
- Spanish  │ Hola         │ ¿Qué tal? 
-`, "\n")
+ Spanish  │ Hola         │ ¿Qué tal? `, "\n")
 
 	if table.String() != expected {
-		t.Fatalf("expected:\n\n%s\n\ngot:\n\n%s", expected, table.String())
+		t.Fatalf("expected:\n\n%s\n\ngot:\n\n%s", debug(expected), debug(table.String()))
 	}
 }
 
@@ -343,11 +342,10 @@ func TestTableUnsetHeaderSeparator(t *testing.T) {
  French   │ Bonjour      │ Salut     
  Japanese │ こんにちは   │ やあ      
  Russian  │ Zdravstvuyte │ Privet    
- Spanish  │ Hola         │ ¿Qué tal? 
-`, "\n")
+ Spanish  │ Hola         │ ¿Qué tal? `, "\n")
 
 	if table.String() != expected {
-		t.Fatalf("expected:\n\n%s\n\ngot:\n\n%s", expected, table.String())
+		t.Fatalf("expected:\n\n%s\n\ngot:\n\n%s", debug(expected), debug(table.String()))
 	}
 }
 
@@ -540,17 +538,21 @@ func TestTableWidthExpand(t *testing.T) {
 		Rows(rows...)
 
 	expected := strings.TrimSpace(`
-┌────────────────────────┬────────────────────────────┬─────────────────────────┐
-│        LANGUAGE        │           FORMAL           │        INFORMAL         │
-├────────────────────────┼────────────────────────────┼─────────────────────────┤
-│ Chinese                │ Nǐn hǎo                    │ Nǐ hǎo                  │
-│ French                 │ Bonjour                    │ Salut                   │
-│ Japanese               │ こんにちは                 │ やあ                    │
-│ Russian                │ Zdravstvuyte               │ Privet                  │
-│ Spanish                │ Hola                       │ ¿Qué tal?               │
-└────────────────────────┴────────────────────────────┴─────────────────────────┘
+┌────────────────────────┬────────────────────────────┬────────────────────────┐
+│        LANGUAGE        │           FORMAL           │        INFORMAL        │
+├────────────────────────┼────────────────────────────┼────────────────────────┤
+│ Chinese                │ Nǐn hǎo                    │ Nǐ hǎo                 │
+│ French                 │ Bonjour                    │ Salut                  │
+│ Japanese               │ こんにちは                 │ やあ                   │
+│ Russian                │ Zdravstvuyte               │ Privet                 │
+│ Spanish                │ Hola                       │ ¿Qué tal?              │
+└────────────────────────┴────────────────────────────┴────────────────────────┘
 `)
 
+	if lipgloss.Width(table.String()) != 80 {
+		t.Fatalf("expected table width to be 80, got %d", lipgloss.Width(table.String()))
+	}
+
 	if table.String() != expected {
 		t.Fatalf("expected:\n\n%s\n\ngot:\n\n%s", expected, table.String())
 	}
@@ -653,7 +655,7 @@ func TestTableWidthSmartCropExtensive(t *testing.T) {
 	}
 }
 
-func TestTableWidthSmartCropFail(t *testing.T) {
+func TestTableWidthSmartCropTiny(t *testing.T) {
 	rows := [][]any{
 		{"Chinese", "您好", "你好"},
 		{"Japanese", "こんにちは", "やあ"},
@@ -663,24 +665,22 @@ func TestTableWidthSmartCropFail(t *testing.T) {
 	}
 
 	table := New().
-		Width(1). // Width is unreasonably small, fail to crop.
+		Width(1).
 		StyleFunc(TableStyle).
 		Border(lipgloss.NormalBorder()).
 		Headers("LANGUAGE", "FORMAL", "INFORMAL").
 		Rows(rows...)
 
-		// Width is too small, ignoring widths...
-		// TODO: Perhaps truncate the entire table to the table width?
 	expected := strings.TrimSpace(`
-┌──────────┬─────────────┬─────────┐
-│ LANGUAGE │   FORMAL    │ INFORMA │
-├──────────┼─────────────┼─────────┤
-│ Chinese  │ 您好        │ 你好    │
-│ Japanese │ こんにちは  │ やあ    │
-│ Russian  │ Здравствуйт │ Привет  │
-│ Spanish  │ Hola        │ ¿Qué    │
-│ English  │ You look    │ How's   │
-└──────────┴─────────────┴─────────┘
+┌
+│
+├
+│
+│
+│
+│
+│
+└
 `)
 
 	if table.String() != expected {
@@ -759,3 +759,7 @@ func TestTableWidthShrinkNoBorders(t *testing.T) {
 		t.Fatalf("expected:\n\n%s\n\ngot:\n\n%s", expected, table.String())
 	}
 }
+
+func debug(s string) string {
+	return strings.ReplaceAll(s, " ", ".")
+}