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

Added canvas unit tests & fix canvas scaling bug

Browse Source
This commit is contained in:
Matt Constable 2021-01-05 13:00:04 +00:00 committed by GitHub
parent 1bb0b9ccc6
commit 5b553a4106
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 124 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

108
src/Spectre.Console.Tests/Unit/CanvasTests.cs Normal file
View File

@ -0,0 +1,108 @@
using System;
using System.Linq;
using System.Text;
using Shouldly;
using Spectre.Console.Rendering;
using Spectre.Console.Testing;
using Xunit;
namespace Spectre.Console.Tests.Unit
{
public class CanvasTests
{
[Fact]
public void Canvas_Must_Have_Proper_Size()
{
Should.Throw<ArgumentException>(() => new Canvas(1, 0));
Should.Throw<ArgumentException>(() => new Canvas(0, 1));
}
[Fact]
public void Simple_Render()
{
// Given
var console = new FakeAnsiConsole(ColorSystem.Standard);
var canvas = new Canvas(width: 2, height: 2);
canvas.SetPixel(0, 0, Color.Aqua);
canvas.SetPixel(1, 1, Color.Grey);
// When
console.Render(canvas);
// Then
console.Output.ShouldBe($"\u001b[106m \u001b[0m {Environment.NewLine} \u001b[100m \u001b[0m{Environment.NewLine}");
}
[Fact]
public void Render_Wider_Than_Terminal_Cannot_Be_Reduced_Further()
{
// Given
var console = new FakeAnsiConsole(ColorSystem.Standard, width: 10);
var canvas = new Canvas(width: 20, height: 2);
canvas.SetPixel(0, 0, Color.Aqua);
canvas.SetPixel(19, 1, Color.Grey);
// When
console.Render(canvas);
// Then
console.Output.ShouldBe(string.Empty);
}
[Fact]
public void Render_Wider_Than_Terminal()
{
// Given
var console = new FakeAnsiConsole(ColorSystem.Standard, width: 10);
var canvas = new Canvas(width: 20, height: 10);
canvas.SetPixel(0, 0, Color.Aqua);
canvas.SetPixel(19, 9, Color.Grey);
// When
console.Render(canvas);
// Then
var numNewlines = console.Output.Count(x => x == '\n');
// Small terminal shrinks the canvas
numNewlines.ShouldBe(expected: 2);
}
[Fact]
public void Render_Wider_Configured_With_Max_Width()
{
// Given
var console = new FakeAnsiConsole(ColorSystem.Standard, width: 80);
var canvas = new Canvas(width: 20, height: 10) { MaxWidth = 10 };
canvas.SetPixel(0, 0, Color.Aqua);
canvas.SetPixel(19, 9, Color.Grey);
// When
console.Render(canvas);
// Then
var numNewlines = console.Output.Count(x => x == '\n');
// MaxWidth truncates the canvas
numNewlines.ShouldBe(expected: 5);
}
[Fact]
public void Simple_Measure()
{
// Given
var console = new FakeAnsiConsole(ColorSystem.Standard);
var canvas = new Canvas(width: 2, height: 2);
canvas.SetPixel(0, 0, Color.Aqua);
canvas.SetPixel(1, 1, Color.Grey);
// When
var measurement = ((IRenderable)canvas).Measure(new RenderContext(Encoding.Unicode, false), 80);
// Then
measurement.Max.ShouldBe(expected: 4);
measurement.Min.ShouldBe(expected: 4);
}
}
}

16
src/Spectre.Console/Widgets/Canvas.cs
View File

@ -44,6 +44,16 @@ namespace Spectre.Console
/// <param name="height">The canvas height.</param>
public Canvas(int width, int height)
{
if (width < 1)
{
throw new ArgumentException("Must be > 1", nameof(width));
}
if (height < 1)
{
throw new ArgumentException("Must be > 1", nameof(height));
}
Width = width;
Height = height;
@ -104,6 +114,12 @@ namespace Spectre.Console
{
height = (int)(height * (maxWidth / (float)(width * PixelWidth)));
width = maxWidth / PixelWidth;
// If it's not possible to scale the canvas sufficiently, it's too small to render.
if (height == 0)
{
yield break;
}
}
// Need to rescale the pixel buffer?