gui-cs.Terminal.Gui/UnitTests/Views/CheckBoxTests.cs

using System.ComponentModel;
using Xunit.Abstractions;

namespace Terminal.Gui.ViewsTests;

public class CheckBoxTests
{
    private readonly ITestOutputHelper _output;
    public CheckBoxTests (ITestOutputHelper output) { _output = output; }


    // Test that Title and Text are the same
    [Fact]
    public void Text_Mirrors_Title ()
    {
        var view = new CheckBox ();
        view.Title = "Hello";
        Assert.Equal ("Hello", view.Title);
        Assert.Equal ($"Hello", view.TitleTextFormatter.Text);

        Assert.Equal ("Hello", view.Text);
        Assert.Equal ($"{CM.Glyphs.UnChecked} Hello", view.TextFormatter.Text);
    }

    [Fact]
    public void Title_Mirrors_Text ()
    {
        var view = new CheckBox ();
        view.Text = "Hello";
        Assert.Equal ("Hello", view.Text);
        Assert.Equal ($"{CM.Glyphs.UnChecked} Hello", view.TextFormatter.Text);

        Assert.Equal ("Hello", view.Title);
        Assert.Equal ($"Hello", view.TitleTextFormatter.Text);
    }

    [Fact]
    [AutoInitShutdown]
    public void AllowNullChecked_Get_Set ()
    {
        var checkBox = new CheckBox { Text = "Check this out 你" };
        Toplevel top = Application.Top;
        top.Add (checkBox);
        Application.Begin (top);

        Assert.False (checkBox.Checked);
        Assert.True (checkBox.NewKeyDownEvent (Key.Space));
        Assert.True (checkBox.Checked);
        Assert.True (checkBox.MouseEvent (new MouseEvent { X = 0, Y = 0, Flags = MouseFlags.Button1Clicked }));
        Assert.False (checkBox.Checked);

        checkBox.AllowNullChecked = true;
        Assert.True (checkBox.NewKeyDownEvent (Key.Space));
        Assert.Null (checkBox.Checked);
        Application.Refresh ();

        TestHelpers.AssertDriverContentsWithFrameAre (
                                                      @$"
{CM.Glyphs.NullChecked} Check this out 你",
                                                      _output
                                                     );
        Assert.True (checkBox.MouseEvent (new MouseEvent { X = 0, Y = 0, Flags = MouseFlags.Button1Clicked }));
        Assert.True (checkBox.Checked);
        Assert.True (checkBox.NewKeyDownEvent (Key.Space));
        Assert.False (checkBox.Checked);
        Assert.True (checkBox.MouseEvent (new MouseEvent { X = 0, Y = 0, Flags = MouseFlags.Button1Clicked }));
        Assert.Null (checkBox.Checked);

        checkBox.AllowNullChecked = false;
        Assert.False (checkBox.Checked);
    }

    [Fact]
    [AutoInitShutdown]
    public void AutoSize_Stays_True_AnchorEnd_With_HotKeySpecifier ()
    {
        var checkBox = new CheckBox { Y = Pos.Center (), Text = "C_heck this out 你" };

        checkBox.X = Pos.AnchorEnd () - Pos.Function (() => checkBox.GetSizeNeededForTextWithoutHotKey ().Width);

        var win = new Window { Width = Dim.Fill (), Height = Dim.Fill (), Title = "Test Demo 你" };
        win.Add (checkBox);
        Application.Top.Add (win);

        Assert.True (checkBox.AutoSize);

        Application.Begin (Application.Top);
        ((FakeDriver)Application.Driver).SetBufferSize (30, 5);

        var expected = @$"
┌┤Test Demo 你├──────────────┐
│                            │
│         {CM.Glyphs.UnChecked} Check this out 你│
│                            │
└────────────────────────────┘
";

        TestHelpers.AssertDriverContentsWithFrameAre (expected, _output);

        Assert.True (checkBox.AutoSize);
        checkBox.Text = "Check this out 你 changed";
        Assert.True (checkBox.AutoSize);
        Application.Refresh ();

        expected = @$"
┌┤Test Demo 你├──────────────┐
│                            │
│ {CM.Glyphs.UnChecked} Check this out 你 changed│
│                            │
└────────────────────────────┘
";

        TestHelpers.AssertDriverContentsWithFrameAre (expected, _output);
    }

    [Fact]
    [AutoInitShutdown]
    public void AutoSize_Stays_True_AnchorEnd_Without_HotKeySpecifier ()
    {
        var checkBox = new CheckBox { Y = Pos.Center (), Text = "Check this out 你" };

        checkBox.X = Pos.AnchorEnd () - Pos.Function (() => checkBox.GetSizeNeededForTextWithoutHotKey ().Width);

        var win = new Window { Width = Dim.Fill (), Height = Dim.Fill (), Title = "Test Demo 你" };
        win.Add (checkBox);
        Application.Top.Add (win);

        Assert.True (checkBox.AutoSize);

        Application.Begin (Application.Top);
        ((FakeDriver)Application.Driver).SetBufferSize (30, 5);

        var expected = @$"
┌┤Test Demo 你├──────────────┐
│                            │
│         {CM.Glyphs.UnChecked} Check this out 你│
│                            │
└────────────────────────────┘
";

        TestHelpers.AssertDriverContentsWithFrameAre (expected, _output);

        Assert.True (checkBox.AutoSize);
        checkBox.Text = "Check this out 你 changed";
        Assert.True (checkBox.AutoSize);
        Application.Refresh ();

        expected = @$"
┌┤Test Demo 你├──────────────┐
│                            │
│ {CM.Glyphs.UnChecked} Check this out 你 changed│
│                            │
└────────────────────────────┘
";

        TestHelpers.AssertDriverContentsWithFrameAre (expected, _output);
    }

    [Fact]
    [AutoInitShutdown]
    public void AutoSize_StaysVisible ()
    {
        var checkBox = new CheckBox { X = 1, Y = Pos.Center (), Text = "Check this out 你" };
        var win = new Window { Width = Dim.Fill (), Height = Dim.Fill (), Title = "Test Demo 你" };
        win.Add (checkBox);
        Application.Top.Add (win);

        Assert.False (checkBox.IsInitialized);

        RunState runstate = Application.Begin (Application.Top);
        ((FakeDriver)Application.Driver).SetBufferSize (30, 5);

        Assert.True (checkBox.IsInitialized);
        Assert.Equal (new Rectangle (1, 1, 19, 1), checkBox.Frame);
        Assert.Equal ("Check this out 你", checkBox.Text);
        Assert.Equal ($"{CM.Glyphs.UnChecked} Check this out 你", checkBox.TextFormatter.Text);
        Assert.True (checkBox.AutoSize);
        Assert.Equal ("Absolute(19)", checkBox.Width.ToString ());

        checkBox.Checked = true;
        Assert.Equal ($"{CM.Glyphs.Checked} Check this out 你", checkBox.TextFormatter.Text);

        checkBox.AutoSize = false;

        // It isn't auto-size so the height is guaranteed by the SetMinWidthHeight
        checkBox.Text = "Check this out 你 changed";
        var firstIteration = false;
        Application.RunIteration (ref runstate, ref firstIteration);

        // BUGBUG - v2 - Autosize is busted; disabling tests for now
        Assert.Equal (new Rectangle (1, 1, 19, 1), checkBox.Frame);

        var expected = @"
┌┤Test Demo 你├──────────────┐
│                            │
│ ☑ Check this out 你        │
│                            │
└────────────────────────────┘";

        Rectangle pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, _output);
        Assert.Equal (new Rectangle (0, 0, 30, 5), pos);

        checkBox.Width = 19;

        // It isn't auto-size so the height is guaranteed by the SetMinWidthHeight
        checkBox.Text = "Check this out 你 changed";
        Application.RunIteration (ref runstate, ref firstIteration);
        Assert.False (checkBox.AutoSize);
        Assert.Equal (new Rectangle (1, 1, 19, 1), checkBox.Frame);

        expected = @"
┌┤Test Demo 你├──────────────┐
│                            │
│ ☑ Check this out 你        │
│                            │
└────────────────────────────┘";

        pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, _output);
        Assert.Equal (new Rectangle (0, 0, 30, 5), pos);

        checkBox.AutoSize = true;
        Application.RunIteration (ref runstate, ref firstIteration);
        Assert.Equal (new Rectangle (1, 1, 27, 1), checkBox.Frame);

        expected = @"
┌┤Test Demo 你├──────────────┐
│                            │
│ ☑ Check this out 你 changed│
│                            │
└────────────────────────────┘";

        pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, _output);
        Assert.Equal (new Rectangle (0, 0, 30, 5), pos);
    }

    [Fact]
    public void Constructors_Defaults ()
    {
        var ckb = new CheckBox ();
        Assert.True (ckb.AutoSize);
        Assert.False (ckb.Checked);
        Assert.False (ckb.AllowNullChecked);
        Assert.Equal (string.Empty, ckb.Text);
        Assert.Equal ($"{CM.Glyphs.UnChecked} ", ckb.TextFormatter.Text);
        Assert.True (ckb.CanFocus);
        Assert.Equal (new Rectangle (0, 0, 2, 1), ckb.Frame);

        ckb = new CheckBox { Text = "Test", Checked = true };
        Assert.True (ckb.AutoSize);
        Assert.True (ckb.Checked);
        Assert.False (ckb.AllowNullChecked);
        Assert.Equal ("Test", ckb.Text);
        Assert.Equal ($"{CM.Glyphs.Checked} Test", ckb.TextFormatter.Text);
        Assert.True (ckb.CanFocus);
        Assert.Equal (new Rectangle (0, 0, 6, 1), ckb.Frame);

        ckb = new CheckBox { Text = "Test", X = 1, Y = 2 };
        Assert.True (ckb.AutoSize);
        Assert.False (ckb.Checked);
        Assert.False (ckb.AllowNullChecked);
        Assert.Equal ("Test", ckb.Text);
        Assert.Equal ($"{CM.Glyphs.UnChecked} Test", ckb.TextFormatter.Text);
        Assert.True (ckb.CanFocus);
        Assert.Equal (new Rectangle (1, 2, 6, 1), ckb.Frame);

        ckb = new CheckBox { Text = "Test", X = 3, Y = 4, Checked = true };
        Assert.True (ckb.AutoSize);
        Assert.True (ckb.Checked);
        Assert.False (ckb.AllowNullChecked);
        Assert.Equal ("Test", ckb.Text);
        Assert.Equal ($"{CM.Glyphs.Checked} Test", ckb.TextFormatter.Text);
        Assert.True (ckb.CanFocus);
        Assert.Equal (new Rectangle (3, 4, 6, 1), ckb.Frame);
    }

    [Fact]
    public void KeyBindings_Command ()
    {
        var toggled = false;
        var ckb = new CheckBox ();
        ckb.Toggled += (s, e) => toggled = true;

        Assert.False (ckb.Checked);
        Assert.False (toggled);
        Assert.Equal (Key.Empty, ckb.HotKey);

        ckb.Text = "_Test";
        Assert.Equal (Key.T, ckb.HotKey);
        Assert.True (ckb.NewKeyDownEvent (Key.T));
        Assert.True (ckb.Checked);
        Assert.True (toggled);

        ckb.Text = "T_est";
        toggled = false;
        Assert.Equal (Key.E, ckb.HotKey);
        Assert.True (ckb.NewKeyDownEvent (Key.E.WithAlt));
        Assert.True (toggled);
        Assert.False (ckb.Checked);

        toggled = false;
        Assert.Equal (Key.E, ckb.HotKey);
        Assert.True (ckb.NewKeyDownEvent (Key.E));
        Assert.True (toggled);
        Assert.True (ckb.Checked);

        toggled = false;
        Assert.True (ckb.NewKeyDownEvent (Key.Space));
        Assert.True (toggled);
        Assert.False (ckb.Checked);

        toggled = false;
        Assert.True (ckb.NewKeyDownEvent (Key.Space));
        Assert.True (toggled);
        Assert.True (ckb.Checked);

        toggled = false;
        Assert.False (ckb.NewKeyDownEvent (Key.Enter));
        Assert.False (toggled);
        Assert.True (ckb.Checked);
    }

    [Fact]
    public void Accept_Cancel_Event_OnAccept_Returns_True ()
    {
        var ckb = new CheckBox ();
        var acceptInvoked = false;

        ckb.Accept += ViewOnAccept;

        var ret = ckb.OnAccept ();
        Assert.True (ret);
        Assert.True (acceptInvoked);

        return;
        void ViewOnAccept (object sender, CancelEventArgs e)
        {
            acceptInvoked = true;
            e.Cancel = true;
        }
    }

    [Fact]
    [AutoInitShutdown]
    public void TextAlignment_Centered ()
    {
        var checkBox = new CheckBox
        {
            X = 1,
            Y = Pos.Center (),
            Text = "Check this out 你",
            TextAlignment = TextAlignment.Centered,
            AutoSize = false,
            Width = 25
        };
        var win = new Window { Width = Dim.Fill (), Height = Dim.Fill (), Title = "Test Demo 你" };
        win.Add (checkBox);
        Application.Top.Add (win);

        Application.Begin (Application.Top);
        ((FakeDriver)Application.Driver).SetBufferSize (30, 5);

        Assert.Equal (TextAlignment.Centered, checkBox.TextAlignment);
        Assert.Equal (new Rectangle (1, 1, 25, 1), checkBox.Frame);
        Assert.Equal (new Size (25, 1), checkBox.TextFormatter.Size);
        Assert.False (checkBox.AutoSize);

        var expected = @$"
┌┤Test Demo 你├──────────────┐
│                            │
│    {CM.Glyphs.UnChecked} Check this out 你     │
│                            │
└────────────────────────────┘
";

        Rectangle pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, _output);
        Assert.Equal (new Rectangle (0, 0, 30, 5), pos);

        checkBox.Checked = true;
        Application.Refresh ();

        expected = @$"
┌┤Test Demo 你├──────────────┐
│                            │
│    {CM.Glyphs.Checked} Check this out 你     │
│                            │
└────────────────────────────┘
";

        pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, _output);
        Assert.Equal (new Rectangle (0, 0, 30, 5), pos);
    }

    [Fact]
    [AutoInitShutdown]
    public void TextAlignment_Justified ()
    {
        var checkBox1 = new CheckBox
        {
            X = 1,
            Y = Pos.Center (),
            Text = "Check first out 你",
            TextAlignment = TextAlignment.Justified,
            AutoSize = false,
            Width = 25
        };

        var checkBox2 = new CheckBox
        {
            X = 1,
            Y = Pos.Bottom (checkBox1),
            Text = "Check second out 你",
            TextAlignment = TextAlignment.Justified,
            AutoSize = false,
            Width = 25
        };
        var win = new Window { Width = Dim.Fill (), Height = Dim.Fill (), Title = "Test Demo 你" };
        win.Add (checkBox1, checkBox2);
        Application.Top.Add (win);

        Application.Begin (Application.Top);
        ((FakeDriver)Application.Driver).SetBufferSize (30, 6);

        Assert.Equal (TextAlignment.Justified, checkBox1.TextAlignment);
        Assert.Equal (new Rectangle (1, 1, 25, 1), checkBox1.Frame);
        Assert.Equal (new Size (25, 1), checkBox1.TextFormatter.Size);
        Assert.Equal (TextAlignment.Justified, checkBox2.TextAlignment);
        Assert.Equal (new Rectangle (1, 2, 25, 1), checkBox2.Frame);
        Assert.Equal (new Size (25, 1), checkBox2.TextFormatter.Size);

        var expected = @$"
┌┤Test Demo 你├──────────────┐
│                            │
│ {CM.Glyphs.UnChecked}   Check  first  out  你  │
│ {CM.Glyphs.UnChecked}  Check  second  out  你  │
│                            │
└────────────────────────────┘
";

        Rectangle pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, _output);
        Assert.Equal (new Rectangle (0, 0, 30, 6), pos);

        checkBox1.Checked = true;
        Assert.Equal (new Rectangle (1, 1, 25, 1), checkBox1.Frame);
        Assert.Equal (new Size (25, 1), checkBox1.TextFormatter.Size);
        checkBox2.Checked = true;
        Assert.Equal (new Rectangle (1, 2, 25, 1), checkBox2.Frame);
        Assert.Equal (new Size (25, 1), checkBox2.TextFormatter.Size);
        Application.Refresh ();

        expected = @$"
┌┤Test Demo 你├──────────────┐
│                            │
│ {CM.Glyphs.Checked}   Check  first  out  你  │
│ {CM.Glyphs.Checked}  Check  second  out  你  │
│                            │
└────────────────────────────┘
";

        pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, _output);
        Assert.Equal (new Rectangle (0, 0, 30, 6), pos);
    }

    [Fact]
    [AutoInitShutdown]
    public void TextAlignment_Left ()
    {
        var checkBox = new CheckBox
        {
            X = 1,
            Y = Pos.Center (),
            Text = "Check this out 你",
            AutoSize = false,
            Width = 25
        };
        var win = new Window { Width = Dim.Fill (), Height = Dim.Fill (), Title = "Test Demo 你" };
        win.Add (checkBox);
        Application.Top.Add (win);

        Application.Begin (Application.Top);
        ((FakeDriver)Application.Driver).SetBufferSize (30, 5);

        Assert.Equal (TextAlignment.Left, checkBox.TextAlignment);
        Assert.Equal (new Rectangle (1, 1, 25, 1), checkBox.Frame);
        Assert.Equal (new Size (25, 1), checkBox.TextFormatter.Size);

        var expected = @$"
┌┤Test Demo 你├──────────────┐
│                            │
│ {CM.Glyphs.UnChecked} Check this out 你        │
│                            │
└────────────────────────────┘
";

        Rectangle pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, _output);
        Assert.Equal (new Rectangle (0, 0, 30, 5), pos);

        checkBox.Checked = true;
        Application.Refresh ();

        expected = @$"
┌┤Test Demo 你├──────────────┐
│                            │
│ {CM.Glyphs.Checked} Check this out 你        │
│                            │
└────────────────────────────┘
";

        pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, _output);
        Assert.Equal (new Rectangle (0, 0, 30, 5), pos);
    }

    [Fact]
    [AutoInitShutdown]
    public void TextAlignment_Right ()
    {
        var checkBox = new CheckBox
        {
            X = 1,
            Y = Pos.Center (),
            Text = "Check this out 你",
            TextAlignment = TextAlignment.Right,
            AutoSize = false,
            Width = 25
        };
        var win = new Window { Width = Dim.Fill (), Height = Dim.Fill (), Title = "Test Demo 你" };
        win.Add (checkBox);
        Application.Top.Add (win);

        Application.Begin (Application.Top);
        ((FakeDriver)Application.Driver).SetBufferSize (30, 5);

        Assert.Equal (TextAlignment.Right, checkBox.TextAlignment);
        Assert.Equal (new Rectangle (1, 1, 25, 1), checkBox.Frame);
        Assert.Equal (new Size (25, 1), checkBox.TextFormatter.Size);
        Assert.False (checkBox.AutoSize);

        var expected = @$"
┌┤Test Demo 你├──────────────┐
│                            │
│       Check this out 你 {CM.Glyphs.UnChecked}  │
│                            │
└────────────────────────────┘
";

        Rectangle pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, _output);
        Assert.Equal (new Rectangle (0, 0, 30, 5), pos);

        checkBox.Checked = true;
        Application.Refresh ();

        expected = @$"
┌┤Test Demo 你├──────────────┐
│                            │
│       Check this out 你 {CM.Glyphs.Checked}  │
│                            │
└────────────────────────────┘
";

        pos = TestHelpers.AssertDriverContentsWithFrameAre (expected, _output);
        Assert.Equal (new Rectangle (0, 0, 30, 5), pos);
    }

    [Fact]
    public void HotKey_Command_Fires_Accept ()
    {
        var cb = new CheckBox ();
        var accepted = false;

        cb.Accept += ButtonOnAccept;
        cb.InvokeCommand (Command.HotKey);

        Assert.True (accepted);

        return;
        void ButtonOnAccept (object sender, CancelEventArgs e) { accepted = true; }
    }

    [Theory]
    [InlineData (true)]
    [InlineData (false)]
    [InlineData (null)]
    public void Toggled_Cancel_Event_Prevents_Toggle (bool? initialState)
    {
        var ckb = new CheckBox () { AllowNullChecked = true };
        var checkedInvoked = false;

        ckb.Toggled += CheckBoxToggled;

        ckb.Checked = initialState;
        Assert.Equal(initialState, ckb.Checked);
        var ret = ckb.OnToggled ();
        Assert.True (ret);
        Assert.True (checkedInvoked);
        Assert.Equal (initialState, ckb.Checked);

        return;
        void CheckBoxToggled (object sender, CancelEventArgs e)
        {
            checkedInvoked = true;
            e.Cancel = true;
        }
    }
}