Made SpinnerView more testable

Author: tig

Terminal.Gui/Views/SpinnerView/SpinnerView.cs

@@ -1,16 +1,15 @@
-//------------------------------------------------------------------------------
+#nullable enable
+//------------------------------------------------------------------------------
 // Windows Terminal supports Unicode and Emoji characters, but by default
 // conhost shells (e.g., PowerShell and cmd.exe) do not. See
 // <https://spectreconsole.net/best-practices>.
 //------------------------------------------------------------------------------
 
-using System.Diagnostics;
-
 namespace Terminal.Gui;
 
 /// <summary>A <see cref="View"/> which displays (by default) a spinning line character.</summary>
 /// <remarks>
-///     By default animation only occurs when you call <see cref="SpinnerView.AdvanceAnimation(bool)"/>. Use
+///     By default, animation only occurs when you call <see cref="SpinnerView.AdvanceAnimation(bool)"/>. Use
 ///     <see cref="AutoSpin"/> to make the automate calls to <see cref="SpinnerView.AdvanceAnimation(bool)"/>.
 /// </remarks>
 public class SpinnerView : View, IDesignable
@@ -25,7 +24,7 @@ public class SpinnerView : View, IDesignable
     private DateTime _lastRender = DateTime.MinValue;
     private string [] _sequence = DEFAULT_STYLE.Sequence;
     private SpinnerStyle _style = DEFAULT_STYLE;
-    private object _timeout;
+    private object? _timeout;
 
     /// <summary>Creates a new instance of the <see cref="SpinnerView"/> class.</summary>
     public SpinnerView ()
@@ -134,14 +133,7 @@ public void AdvanceAnimation (bool setNeedsDraw = true)
                 {
                     if (SpinBounce)
                     {
-                        if (SpinReverse)
-                        {
-                            _bounceReverse = false;
-                        }
-                        else
-                        {
-                            _bounceReverse = true;
-                        }
+                        _bounceReverse = !SpinReverse;
 
                         _currentIdx = Sequence.Length - 1;
                     }
@@ -155,14 +147,7 @@ public void AdvanceAnimation (bool setNeedsDraw = true)
                 {
                     if (SpinBounce)
                     {
-                        if (SpinReverse)
-                        {
-                            _bounceReverse = true;
-                        }
-                        else
-                        {
-                            _bounceReverse = false;
-                        }
+                        _bounceReverse = SpinReverse;
 
                         _currentIdx = 1;
                     }
@@ -182,25 +167,26 @@ public void AdvanceAnimation (bool setNeedsDraw = true)
         }
     }
 
-    /// <inheritdoc />
+    /// <inheritdoc/>
     protected override bool OnClearingViewport () { return true; }
 
-    /// <inheritdoc />
+    /// <inheritdoc/>
     protected override bool OnDrawingContent ()
     {
         Render ();
+
         return true;
     }
 
     /// <summary>
-    ///    Renders the current frame of the spinner.
+    ///     Renders the current frame of the spinner.
     /// </summary>
     public void Render ()
     {
         if (Sequence is { Length: > 0 } && _currentIdx < Sequence.Length)
         {
             Move (Viewport.X, Viewport.Y);
-            View.Driver?.AddStr (Sequence [_currentIdx]);
+            Driver?.AddStr (Sequence [_currentIdx]);
         }
     }
 
@@ -214,7 +200,8 @@ protected override void Dispose (bool disposing)
 
     private void AddAutoSpinTimeout ()
     {
-        if (_timeout is { })
+        // Only add timeout if we are initialized and not already spinning
+        if (_timeout is { } || !Application.Initialized)
         {
             return;
         }
@@ -223,7 +210,7 @@ private void AddAutoSpinTimeout ()
                                            TimeSpan.FromMilliseconds (SpinDelay),
                                            () =>
                                            {
-                                               Application.Invoke (() => AdvanceAnimation());
+                                               Application.Invoke (() => AdvanceAnimation ());
 
                                                return true;
                                            }
@@ -237,7 +224,7 @@ private bool GetIsAsciiOnly ()
             return false;
         }
 
-        if (_sequence is { } && _sequence.Length > 0)
+        if (_sequence is { Length: > 0 })
         {
             foreach (string frame in _sequence)
             {
@@ -260,7 +247,7 @@ private int GetSpinnerWidth ()
     {
         var max = 0;
 
-        if (_sequence is { } && _sequence.Length > 0)
+        if (_sequence is { Length: > 0 })
         {
             foreach (string frame in _sequence)
             {
@@ -295,15 +282,15 @@ private void SetDelay (int delay)
 
     private void SetSequence (string [] frames)
     {
-        if (frames is { } && frames.Length > 0)
+        if (frames is { Length: > 0 })
         {
             _style = new SpinnerStyle.Custom ();
             _sequence = frames;
             Width = GetSpinnerWidth ();
         }
     }
 
-    private void SetStyle (SpinnerStyle style)
+    private void SetStyle (SpinnerStyle? style)
     {
         if (style is { })
         {
@@ -320,6 +307,7 @@ bool IDesignable.EnableForDesign ()
         Style = new SpinnerStyle.Points ();
         SpinReverse = true;
         AutoSpin = true;
+
         return true;
     }
 }

Tests/UnitTests/Views/AllViewsTests.cs

@@ -62,124 +62,4 @@ public void AllViews_Center_Properly (Type viewType)
         Application.Shutdown ();
     }
 
-    //[Fact]
-    //public void AllViews_HotKey_Works ()
-    //{
-    //	foreach (var type in GetAllViewClasses ()) {
-    //		_output.WriteLine ($"Testing {type.Name}");
-    //		var view = GetTypeInitializer (type, type.GetConstructor (Array.Empty<Type> ()));
-    //		view.HotKeySpecifier = (Rune)'^';
-    //		view.Text = "^text";
-    //		Assert.Equal(Key.T, view.HotKey);
-    //	}
-    //}
-
-    [Theory]
-    [MemberData (nameof (AllViewTypes))]
-    [SetupFakeDriver] // Required for spinner view that wants to register timeouts
-    public void AllViews_Command_Select_Raises_Selecting (Type viewType)
-    {
-        // Required for spinner view that wants to register timeouts
-        Application.MainLoop = new (new FakeMainLoop (Application.Driver));
-
-        var view = CreateInstanceIfNotGeneric (viewType);
-
-        if (view == null)
-        {
-            output.WriteLine ($"Ignoring {viewType} - It's a Generic");
-
-            return;
-        }
-
-        if (view is IDesignable designable)
-        {
-            designable.EnableForDesign ();
-        }
-
-        var selectingCount = 0;
-        view.Selecting += (s, e) => selectingCount++;
-
-        var acceptedCount = 0;
-        view.Accepting += (s, e) => { acceptedCount++; };
-
-        if (view.InvokeCommand (Command.Select) == true)
-        {
-            Assert.Equal (1, selectingCount);
-            Assert.Equal (0, acceptedCount);
-        }
-    }
-
-    [Theory]
-    [SetupFakeDriver] // Required for spinner view that wants to register timeouts
-    [MemberData (nameof (AllViewTypes))]
-    public void AllViews_Command_Accept_Raises_Accepted (Type viewType)
-    {
-        // Required for spinner view that wants to register timeouts
-        Application.MainLoop = new (new FakeMainLoop (Application.Driver));
-
-        var view = CreateInstanceIfNotGeneric (viewType);
-
-        if (view == null)
-        {
-            output.WriteLine ($"Ignoring {viewType} - It's a Generic");
-
-            return;
-        }
-
-        if (view is IDesignable designable)
-        {
-            designable.EnableForDesign ();
-        }
-
-        var selectingCount = 0;
-        view.Selecting += (s, e) => selectingCount++;
-
-        var acceptedCount = 0;
-        view.Accepting += (s, e) => { acceptedCount++; };
-
-        if (view.InvokeCommand (Command.Accept) == true)
-        {
-            Assert.Equal (0, selectingCount);
-            Assert.Equal (1, acceptedCount);
-        }
-    }
-
-    [Theory]
-    [MemberData (nameof (AllViewTypes))]
-    [SetupFakeDriver] // Required for spinner view that wants to register timeouts
-    public void AllViews_Command_HotKey_Raises_HandlingHotKey (Type viewType)
-    {
-        // Required for spinner view that wants to register timeouts
-        Application.MainLoop = new (new FakeMainLoop (Application.Driver));
-
-        var view = CreateInstanceIfNotGeneric (viewType);
-
-        if (view == null)
-        {
-            output.WriteLine ($"Ignoring {viewType} - It's a Generic");
-
-            return;
-        }
-
-        if (view is IDesignable designable)
-        {
-            designable.EnableForDesign ();
-        }
-        else
-        {
-            view.HotKey = Key.T;
-        }
-
-        var acceptedCount = 0;
-        view.Accepting += (s, e) => { acceptedCount++; };
-
-        var handlingHotKeyCount = 0;
-        view.HandlingHotKey += (s, e) => { handlingHotKeyCount++; };
-
-        if (view.InvokeCommand (Command.HotKey) == true)
-        {
-            Assert.Equal (1, handlingHotKeyCount);
-            Assert.Equal (0, acceptedCount);
-        }
-    }
 }