Abstracted the consoleService so it can be used for other UI frameworks.

DerekGooding · DerekGooding · commit 0911c30dbcd7 · 2024-12-03T12:32:12.000-05:00
Will need to consider turning all the helpers into services similarly in the near future.
diff --git a/ConsoleHero.Web/ConsoleHero.Web.csproj b/ConsoleHero.Web/ConsoleHero.Web.csproj
@@ -0,0 +1,14 @@
+﻿<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net9.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\ConsoleHero\ConsoleHero.csproj" />
+  </ItemGroup>
+
+</Project>
diff --git a/ConsoleHero.Web/GlobalUsings.cs b/ConsoleHero.Web/GlobalUsings.cs
@@ -0,0 +1,3 @@
+﻿global using static System.Console;
+global using System.Drawing;
+global using ConsoleHero.Model;
diff --git a/ConsoleHero.Web/Program.cs b/ConsoleHero.Web/Program.cs
@@ -0,0 +1,9 @@
+﻿namespace ConsoleHero.Web;
+
+internal static class Program
+{
+    static void Main()
+    {
+        WriteLine("Hello, World!");
+    }
+}
diff --git a/ConsoleHero.sln b/ConsoleHero.sln
@@ -9,6 +9,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ConsoleHero", "ConsoleHero\
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ConsoleHero.Test", "ConsoleHero.Test\ConsoleHero.Test.csproj", "{C450F83F-7827-402D-8F20-D84C0406C87A}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ConsoleHero.Web", "ConsoleHero.Web\ConsoleHero.Web.csproj", "{3C987FA4-6121-48AA-873D-C092EB514205}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -27,6 +29,10 @@ Global
 		{C450F83F-7827-402D-8F20-D84C0406C87A}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{C450F83F-7827-402D-8F20-D84C0406C87A}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{C450F83F-7827-402D-8F20-D84C0406C87A}.Release|Any CPU.Build.0 = Release|Any CPU
+		{3C987FA4-6121-48AA-873D-C092EB514205}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{3C987FA4-6121-48AA-873D-C092EB514205}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{3C987FA4-6121-48AA-873D-C092EB514205}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{3C987FA4-6121-48AA-873D-C092EB514205}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
diff --git a/ConsoleHero/ConsoleHero.csproj b/ConsoleHero/ConsoleHero.csproj
@@ -1,13 +1,13 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net8.0;net7.0;</TargetFrameworks>
+    <TargetFrameworks>net9.0;net8.0;net7.0;</TargetFrameworks>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
 	  
 	 <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <PackageId>ConsoleHero</PackageId>
-    <Version>0.2.1</Version>
+    <Version>0.3.0</Version>
     <Authors>Derek Gooding</Authors>
     <Description>A library for making quick menus in a console application.</Description>
 	<PackageTags>Console;FluentAPI;Menu;CLI;ConsoleApp;CSharp;UserInterface;MenuNavigation;Scalable;ConsoleMenu;Fluent;</PackageTags>
diff --git a/ConsoleHero/ConsoleService.cs b/ConsoleHero/ConsoleService.cs
@@ -0,0 +1,19 @@
+﻿using ConsoleHero.Interfaces;
+using System.Runtime.InteropServices;
+
+namespace ConsoleHero;
+
+internal class ConsoleService : IConsoleService
+{
+    public void Clear() => Console.Clear();
+    public string? ReadLine() => Console.ReadLine();
+    public void Write(string? value) => Console.Write(value);
+    public void WriteLine(string? value) => Console.WriteLine(value);
+    public void WriteLine() => Console.WriteLine();
+    public ConsoleKeyInfo ReadKey() => Console.ReadKey();
+    public void Beep(int frequency, int duration)
+    {
+        if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+            Console.Beep(frequency, duration);
+    }
+}
diff --git a/ConsoleHero/GlobalSettings.cs b/ConsoleHero/GlobalSettings.cs
@@ -1,4 +1,5 @@
 ﻿using ConsoleHero.Helpers;
+using ConsoleHero.Interfaces;
 
 namespace ConsoleHero;
 
@@ -16,4 +17,20 @@ public static class GlobalSettings
     /// How many line breaks between menues or paragraphs. Set to 1 by default.
     /// </summary>
     public static int Spacing { get; set; } = 1;
+
+    /// <summary>
+    /// By default will use the standard Console. If you want to adapt this to other output sources, 
+    /// create a new <see cref="IConsoleService"/> and set this GlobalSetting.
+    /// </summary>
+    public static IConsoleService Service
+    {
+        get
+        {
+            _service ??= new ConsoleService();
+            return _service;
+        }
+        set => _service = value;
+    }
+
+    private static IConsoleService? _service;
 }
diff --git a/ConsoleHero/GlobalUsings.cs b/ConsoleHero/GlobalUsings.cs
@@ -1,3 +1,2 @@
-﻿global using static System.Console;
-global using System.Drawing;
+﻿global using System.Drawing;
 global using ConsoleHero.Model;
diff --git a/ConsoleHero/Helpers/BeepHelper.cs b/ConsoleHero/Helpers/BeepHelper.cs
@@ -8,14 +8,14 @@ internal class BeepHelper : IBeepHelper
 
     public BeepHelper(IPlatformHelper plateformHelper) => _platformHelper = plateformHelper;
 
-    void IBeepHelper.Beep() => Write("\a");
+    void IBeepHelper.Beep() => GlobalSettings.Service.Write("\a");
 
     [System.Diagnostics.CodeAnalysis.SuppressMessage("Interoperability", "CA1416:Validate platform compatibility", Justification = "Ensured by _platformHelper")]
     void IBeepHelper.Beep(int frequency, int duration)
     {
         if (_platformHelper.IsWindows)
         {
-            Beep(frequency, duration);
+            GlobalSettings.Service.Beep(frequency, duration);
         }
         else if (_platformHelper.IsLinux || _platformHelper.IsOSX)
         {
@@ -34,7 +34,7 @@ void IBeepHelper.Beep(int frequency, int duration)
             }
             catch
             {
-                Write("\a");
+                GlobalSettings.Service.Write("\a");
             }
         }
     }
diff --git a/ConsoleHero/Helpers/ColorHelper.cs b/ConsoleHero/Helpers/ColorHelper.cs
@@ -27,7 +27,7 @@ internal static class ColorHelper
         _ => Color.Black,
     };
 
-    private static void SetRgbTextColor(byte r, byte g, byte b) => Write($"\u001b[38;2;{r};{g};{b}m");
+    private static void SetRgbTextColor(byte r, byte g, byte b) => GlobalSettings.Service.Write($"\u001b[38;2;{r};{g};{b}m");
 
     //internal static void ResetColor() => Write("\u001b[0m");
 
diff --git a/ConsoleHero/Helpers/PlatformHelper.cs b/ConsoleHero/Helpers/PlatformHelper.cs
@@ -1,6 +1,7 @@
-﻿using System.Runtime.InteropServices;
+﻿using ConsoleHero.Interfaces;
+using System.Runtime.InteropServices;
 
-namespace ConsoleHero.Interfaces;
+namespace ConsoleHero.Helpers;
 
 internal class PlatformHelper : IPlatformHelper
 {
diff --git a/ConsoleHero/Interfaces/IConsoleService.cs b/ConsoleHero/Interfaces/IConsoleService.cs
@@ -0,0 +1,17 @@
+﻿namespace ConsoleHero.Interfaces;
+
+public interface IConsoleService
+{
+    public abstract void WriteLine(string? value);
+    public abstract void WriteLine();
+
+    public abstract void Write(string? value);
+
+    public abstract void Clear();
+
+    public abstract string? ReadLine();
+
+    public abstract ConsoleKeyInfo ReadKey();
+
+    public abstract void Beep(int frequency, int duration);
+}
diff --git a/ConsoleHero/ListExtensions.cs b/ConsoleHero/ListExtensions.cs
@@ -110,16 +110,16 @@ internal static void Print(this IList<ParagraphLine> list, string input = "")
             {
                 ColorHelper.SetTextColor(component.Color);
                 if (component is ColorText c)
-                    Write(c.Text);
+                    GlobalSettings.Service.Write(c.Text);
                 else if (component is InputPlaceholder)
-                    Write(input);
+                    GlobalSettings.Service.Write(input);
                 else if (component is InputModifier modifier)
-                    Write(modifier.Modifier.Invoke(input));
+                    GlobalSettings.Service.Write(modifier.Modifier.Invoke(input));
             }
-            WriteLine();
+            GlobalSettings.Service.WriteLine();
         }
         for (int i = 0; i < GlobalSettings.Spacing; i++)
-            WriteLine();
+            GlobalSettings.Service.WriteLine();
 
         ColorHelper.SetToDefault();
     }
diff --git a/ConsoleHero/Menu.cs b/ConsoleHero/Menu.cs
@@ -25,7 +25,7 @@ public void Call(string input = "")
         AutoIncrimentKeys();
 
         if (ClearOnCall)
-            Clear();
+            GlobalSettings.Service.Clear();
 
         if (Title.Text != string.Empty)
         {
@@ -38,18 +38,18 @@ public void Call(string input = "")
 
         while (choice == null)
         {
-            string? line = ReadLine();
+            string? line = GlobalSettings.Service.ReadLine();
             choice = FindFirst(x => x.IsCaseSensitive
                 ? string.Equals(x.Key, line)
                 : string.Equals(x.Key, line, StringComparison.OrdinalIgnoreCase));
             if (choice == null)
             {
-                WriteLine("Not a valid choice" + Environment.NewLine);
+                GlobalSettings.Service.WriteLine("Not a valid choice" + Environment.NewLine);
             }
             else
             {
                 for (int i = 0; i < GlobalSettings.Spacing; i++)
-                    WriteLine();
+                    GlobalSettings.Service.WriteLine();
                 choice.Invoke();
             }
         }
diff --git a/ConsoleHero/Paragraph.cs b/ConsoleHero/Paragraph.cs
@@ -19,7 +19,7 @@ internal Paragraph() { }
     public void Call(string input = "")
     {
         if (ClearOnCall)
-            Clear();
+            GlobalSettings.Service.Clear();
         Outputs.Print(input);
 
         FinalizeMessage();
@@ -29,7 +29,7 @@ private void FinalizeMessage()
     {
         if (PressToContinue)
         {
-            ReadKey();
+            GlobalSettings.Service.ReadKey();
         }
         else
         {
diff --git a/ConsoleHero/Request.cs b/ConsoleHero/Request.cs
@@ -26,13 +26,13 @@ public record Request : INode
     public void Call(string input = "")
     {
         if (ClearOnCall)
-            Clear();
+            GlobalSettings.Service.Clear();
 
-        WriteLine(StartingMessage);
+        GlobalSettings.Service.WriteLine(StartingMessage);
         string? result;
-        while (string.IsNullOrEmpty(result = ReadLine()))
+        while (string.IsNullOrEmpty(result = GlobalSettings.Service.ReadLine()))
         {
-            WriteLine(FailMessage);
+            GlobalSettings.Service.WriteLine(FailMessage);
         }
 
         Apply.Invoke(result);

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+global using static System.Console;`
	`2`	`+global using System.Drawing;`
	`3`	`+global using ConsoleHero.Model;`
Original file line number	Diff line number	Diff line change
`@@ -8,14 +8,14 @@ internal class BeepHelper : IBeepHelper`
`8`	`8`
`9`	`9`	`public BeepHelper(IPlatformHelper plateformHelper) => _platformHelper = plateformHelper;`
`10`	`10`
`11`		`- void IBeepHelper.Beep() => Write("\a");`
	`11`	`+ void IBeepHelper.Beep() => GlobalSettings.Service.Write("\a");`
`12`	`12`
`13`	`13`	`[System.Diagnostics.CodeAnalysis.SuppressMessage("Interoperability", "CA1416:Validate platform compatibility", Justification = "Ensured by _platformHelper")]`
`14`	`14`	`void IBeepHelper.Beep(int frequency, int duration)`
`15`	`15`	`{`
`16`	`16`	`if (_platformHelper.IsWindows)`
`17`	`17`	`{`
`18`		`- Beep(frequency, duration);`
	`18`	`+ GlobalSettings.Service.Beep(frequency, duration);`
`19`	`19`	`}`
`20`	`20`	`else if (_platformHelper.IsLinux \|\| _platformHelper.IsOSX)`
`21`	`21`	`{`
`@@ -34,7 +34,7 @@ void IBeepHelper.Beep(int frequency, int duration)`
`34`	`34`	`}`
`35`	`35`	`catch`
`36`	`36`	`{`
`37`		`- Write("\a");`
	`37`	`+ GlobalSettings.Service.Write("\a");`
`38`	`38`	`}`
`39`	`39`	`}`
`40`	`40`	`}`