Skip to content

fix width calculations for tables #352

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mpollmeier merged 3 commits into from
Mar 11, 2026
Merged

fix width calculations for tables #352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e655cd2
remove table min-width in order to keep output identical to before
maltek Mar 11, 2026
6f2ada2
fix the total width of the table
malteharness Mar 11, 2026
75c9bf6
scalafmtAll
malteharness Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 19 additions & 8 deletions help/src/main/scala/flatgraph/help/Table.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,27 @@ case class Table(columnNames: Seq[String], rows: Seq[Row]) {
if (columnNames.isEmpty && rows.isEmpty) {
""
} else {
val renderingWidth = math.max(availableWidthProvider.apply(), 60)
val minWidth = 5
val maxWidth = renderingWidth - minWidth
val allRows = columnNames +: rows
val numCols = columnNames.size
val minWidth = 1
val allRows = columnNames +: rows
val numCols = columnNames.size
val separatorWidth = numCols + 1 // │ around and between each column
val minRenderingWidth = math.max(60, numCols * minWidth + separatorWidth)
val renderingWidth = math.max(availableWidthProvider.apply(), minRenderingWidth)
val availableForContent = renderingWidth - separatorWidth

// calculate column widths: longest content per column, clamped to [minWidth, maxWidth]
val colWidths = (0 until numCols).map { col =>
// calculate natural column widths: longest content per column, clamped to minWidth
val widths = (0 until numCols).map { col =>
val longest = allRows.map(row => if (col < row.size) row(col).length else 0).max
math.min(math.max(longest, minWidth), maxWidth)
math.max(longest, minWidth)
}.toArray

// shrink widest columns until total fits within available space
val colWidths = {
while (widths.sum > availableForContent) {
val maxIdx = widths.zipWithIndex.maxBy(_._1)._2
widths(maxIdx) = math.max(widths(maxIdx) - 1, minWidth)
}
widths.toIndexedSeq
}

val sb = new StringBuilder()
Expand Down
32 changes: 17 additions & 15 deletions help/src/test/scala/flatgraph/help/TableTests.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,26 +35,28 @@ class TableTests extends AnyWordSpec {
implicit val availableWidthProvider: AvailableWidthProvider = () => currentTerminalWidth

table.render.trim shouldBe
"""┌───────────────────────────────────────────────────────┐
|│lorem ipsum │
|├───────────────────────────────────────────────────────┤
|│Lorem ipsum dolor sit amet, consectetur adipiscing │
|│elit, sed do eiusmod tempor incididunt ut labore et │
|│dolore magna aliqua. Ut enim ad minim veniam, quis │
|│nostrud exercitation ullamco laboris nisi ut aliquip │
|└───────────────────────────────────────────────────────┘
"""┌──────────────────────────────────────────────────────────┐
|│lorem ipsum │
|├──────────────────────────────────────────────────────────┤
|│Lorem ipsum dolor sit amet, consectetur adipiscing elit, │
|│sed do eiusmod tempor incididunt ut labore et dolore magna│
|│aliqua. Ut enim ad minim veniam, quis nostrud exercitation│
|│ullamco laboris nisi ut aliquip │
|└──────────────────────────────────────────────────────────┘
|""".stripMargin.trim
table.render.trim.linesIterator.foreach(_.length shouldBe 60) // 60 is min rendering width

currentTerminalWidth = 100 // emulating: terminal size has changed
table.render.trim shouldBe
"""┌───────────────────────────────────────────────────────────────────────────────────────────────┐
|│lorem ipsum │
|├───────────────────────────────────────────────────────────────────────────────────────────────┤
|│Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut │
|│labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco │
|│laboris nisi ut aliquip │
|└───────────────────────────────────────────────────────────────────────────────────────────────┘
"""┌──────────────────────────────────────────────────────────────────────────────────────────────────┐
|│lorem ipsum │
|├──────────────────────────────────────────────────────────────────────────────────────────────────┤
|│Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut │
|│labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris │
|│nisi ut aliquip │
|└──────────────────────────────────────────────────────────────────────────────────────────────────┘
|""".stripMargin.trim
table.render.trim.linesIterator.foreach(_.length shouldBe currentTerminalWidth)
}

}
4 changes: 3 additions & 1 deletion tests/src/test/scala/flatgraph/traversal/TraversalTests.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,9 @@ class TraversalTests extends AnyWordSpec {
// thingTraversalHelpVerbose should include("simple.SimpleDomainTravers")
thingTraversalHelpVerbose should include("node label")
thingTraversalHelpVerbose should include("flatgraph.traversal.NodeSteps")
thingTraversalHelpVerbose should include("result to a list")
thingTraversalHelpVerbose should include(
"│.l │Execute the traversal and convert the result to a │flatgraph.traversal.GenericSteps│ │"
)
thingTraversalHelpVerbose should include("flatgraph.traversal.GenericSt")
}
}
Expand Down
Loading