tk/spectre.console
1
0
Fork 0
mirror of https://github.com/nsnail/spectre.console.git synced 2025-04-24 04:02:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

Work done to allow user to update table cell. (#546)

Browse Source
This commit is contained in:
Christopher Rollings 2021-09-27 12:03:45 +01:00 committed by GitHub
parent ad23855b0a
commit e3dfe23b59
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 260 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
src/Spectre.Console/Extensions/TableExtensions.cs
View File

@ -189,6 +189,56 @@ namespace Spectre.Console
return table; return table;
} }
/// <summary>
/// Updates a tables cell.
/// </summary>
/// <param name="table">The table to update.</param>
/// <param name="rowIndex">The index of row to update.</param>
/// <param name="columnIndex">The index of column to update.</param>
/// <param name="cellData">New cell data.</param>
/// <returns>The same instance so that multiple calls can be chained.</returns>
public static Table UpdateCell(this Table table, int rowIndex, int columnIndex, IRenderable cellData)
{
if (table is null)
{
throw new ArgumentNullException(nameof(table));
}
if (cellData is null)
{
throw new ArgumentNullException(nameof(cellData));
}
table.Rows.Update(rowIndex, columnIndex, cellData);
return table;
}
/// <summary>
/// Updates a tables cell.
/// </summary>
/// <param name="table">The table to update.</param>
/// <param name="rowIndex">The index of row to update.</param>
/// <param name="columnIndex">The index of column to update.</param>
/// <param name="cellData">New cell data.</param>
/// <returns>The same instance so that multiple calls can be chained.</returns>
public static Table UpdateCell(this Table table, int rowIndex, int columnIndex, string cellData)
{
if (table is null)
{
throw new ArgumentNullException(nameof(table));
}
if (cellData is null)
{
throw new ArgumentNullException(nameof(cellData));
}
table.Rows.Update(rowIndex, columnIndex, new Markup(cellData));
return table;
}
/// <summary> /// <summary>
/// Inserts a row in the table at the specified index. /// Inserts a row in the table at the specified index.
/// </summary> /// </summary>

49
src/Spectre.Console/Widgets/Table/TableRowCollection.cs
View File

@ -89,6 +89,55 @@ namespace Spectre.Console
} }
} }
/// <summary>
/// Update a table cell at the specified index.
/// </summary>
/// <param name="row">Index of cell row.</param>
/// <param name="column">index of cell column.</param>
/// <param name="cellData">The new cells details.</param>
public void Update(int row, int column, IRenderable cellData)
{
if (cellData is null)
{
throw new ArgumentNullException(nameof(cellData));
}
lock (_lock)
{
if (row < 0)
{
throw new IndexOutOfRangeException("Table row index cannot be negative.");
}
else if (row >= _list.Count)
{
throw new IndexOutOfRangeException("Table row index cannot exceed the number of rows in the table.");
}
var tableRow = _list.ElementAtOrDefault(row);
var currentRenderables = tableRow.ToList();
if (column < 0)
{
throw new IndexOutOfRangeException("Table column index cannot be negative.");
}
else if (column >= currentRenderables.Count)
{
throw new IndexOutOfRangeException("Table column index cannot exceed the number of rows in the table.");
}
currentRenderables.RemoveAt(column);
currentRenderables.Insert(column, cellData);
var newTableRow = new TableRow(currentRenderables);
_list.RemoveAt(row);
_list.Insert(row, newTableRow);
}
}
/// <summary> /// <summary>
/// Removes a row at the specified index. /// Removes a row at the specified index.
/// </summary> /// </summary>

7
test/Spectre.Console.Tests/Expectations/TableRowCollectionTests.TheUpdateMethod.Should_Update_Row.verified.txt Normal file
View File

@ -0,0 +1,7 @@
┌───────────┬───────────┬───────────┐
│ Column #1 │ Column #2 │ Column #3 │
├───────────┼───────────┼───────────┤
│ 1 │ │ │
│ 2 │ │ │
│ 3 │ 4 │ 5 │
└───────────┴───────────┴───────────┘

7
test/Spectre.Console.Tests/Expectations/TableRowCollectionTests.TheUpdateMethod.Should_Update_Row_With_Renderable.verified.txt Normal file
View File

@ -0,0 +1,7 @@
┌───────────┬───────────┬───────────┐
│ Column #1 │ Column #2 │ Column #3 │
├───────────┼───────────┼───────────┤
│ 1 │ │ │
│ 2 │ │ │
│ 3 │ 4 │ 5 │
└───────────┴───────────┴───────────┘

7
test/Spectre.Console.Tests/Expectations/TableRowCollectionTests.TheUpdateMethod.Should_Update_Row_With_String.verified.txt Normal file
View File

@ -0,0 +1,7 @@
┌───────────┬───────────┬───────────┐
│ Column #1 │ Column #2 │ Column #3 │
├───────────┼───────────┼───────────┤
│ 1 │ │ │
│ 2 │ │ │
│ 3 │ 4 │ 5 │
└───────────┴───────────┴───────────┘

140
test/Spectre.Console.Tests/Unit/Widgets/Table/TableRowCollectionTests.cs
View File

@ -222,5 +222,145 @@ namespace Spectre.Console.Tests.Unit
result.ShouldBe(0); result.ShouldBe(0);
} }
} }
[UsesVerify]
public sealed class TheUpdateMethod
{
[Fact]
public Task Should_Update_Row_With_String()
{
// Given
var console = new TestConsole();
var table = new Table();
table.AddColumn("Column #1");
table.AddColumn("Column #2");
table.AddColumn("Column #3");
table.Rows.Add(new[] { new Text("1") });
table.Rows.Add(new[] { new Text("2") });
table.Rows.Add(new[] { new Text("3"), new Text("4"), new Text("8") });
table.UpdateCell(2, 2, "5");
// When
console.Write(table);
// Then
return Verifier.Verify(console.Output);
}
[Fact]
public Task Should_Update_Row_With_Renderable()
{
// Given
var console = new TestConsole();
var table = new Table();
table.AddColumn("Column #1");
table.AddColumn("Column #2");
table.AddColumn("Column #3");
table.Rows.Add(new[] { new Text("1") });
table.Rows.Add(new[] { new Text("2") });
table.Rows.Add(new[] { new Text("3"), new Text("4"), new Text("8") });
table.UpdateCell(2, 2, new Markup("5"));
// When
console.Write(table);
// Then
return Verifier.Verify(console.Output);
}
[Fact]
public void Should_Throw_If_Index_Is_Larger_Than_Number_Of_Rows()
{
// Given
var console = new TestConsole();
var table = new Table();
table.AddColumn("Column #1");
table.AddColumn("Column #2");
table.AddColumn("Column #3");
table.Rows.Add(new[] { new Text("1") });
table.Rows.Add(new[] { new Text("2") });
table.Rows.Add(new[] { new Text("3"), new Text("4"), new Text("8") });
table.UpdateCell(2, 2, "5");
// When
var result = Record.Exception(() => table.UpdateCell(5, 2, "5"));
// Then
result.ShouldBeOfType<IndexOutOfRangeException>()
.Message.ShouldBe("Table row index cannot exceed the number of rows in the table.");
}
[Fact]
public void Should_Throw_If_Index_Is_Larger_Than_Number_Of_Columns()
{
// Given
var console = new TestConsole();
var table = new Table();
table.AddColumn("Column #1");
table.AddColumn("Column #2");
table.AddColumn("Column #3");
table.Rows.Add(new[] { new Text("1") });
table.Rows.Add(new[] { new Text("2") });
table.Rows.Add(new[] { new Text("3"), new Text("4"), new Text("8") });
table.UpdateCell(2, 2, "5");
// When
var result = Record.Exception(() => table.UpdateCell(2, 5, "5"));
// Then
result.ShouldBeOfType<IndexOutOfRangeException>()
.Message.ShouldBe("Table column index cannot exceed the number of rows in the table.");
}
[Fact]
public void Should_Throw_If_Index_Row_Is_Negative()
{
// Given
var console = new TestConsole();
var table = new Table();
table.AddColumn("Column #1");
table.AddColumn("Column #2");
table.AddColumn("Column #3");
table.Rows.Add(new[] { new Text("1") });
table.Rows.Add(new[] { new Text("2") });
table.Rows.Add(new[] { new Text("3"), new Text("4"), new Text("8") });
table.UpdateCell(2, 2, "5");
// When
var result = Record.Exception(() => table.UpdateCell(-1, 2, "5"));
// Then
result.ShouldBeOfType<IndexOutOfRangeException>()
.Message.ShouldBe("Table row index cannot be negative.");
}
[Fact]
public void Should_Throw_If_Index_Column_Is_Negative()
{
// Given
var console = new TestConsole();
var table = new Table();
table.AddColumn("Column #1");
table.AddColumn("Column #2");
table.AddColumn("Column #3");
table.Rows.Add(new[] { new Text("1") });
table.Rows.Add(new[] { new Text("2") });
table.Rows.Add(new[] { new Text("3"), new Text("4"), new Text("8") });
table.UpdateCell(2, 2, "5");
// When
var result = Record.Exception(() => table.UpdateCell(2, -1, "5"));
// Then
result.ShouldBeOfType<IndexOutOfRangeException>()
.Message.ShouldBe("Table column index cannot be negative.");
}
}
} }
} }