✨ feature: Create State Machine Base Class (#1)

* ✨ feature: Create State Machine Base Class

* Update CHANGELOG.md

* Update README.md

Author: TylerCarrol

CHANGELOG.md

@@ -6,3 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+### Added
+
+- Created state machine base class

README.md

@@ -7,7 +7,7 @@
 [![License](https://img.shields.io/github/license/TJC-Tools/TJC.StateMachine.svg)](LICENSE)
 
 [![tests](https://github.com/TJC-Tools/TJC.StateMachine/actions/workflows/ct-matrix.yml/badge.svg)](https://github.com/TJC-Tools/TJC.StateMachine/actions/workflows/ct-matrix.yml)
-[![codecov](https://codecov.io/gh/TJC-Tools/TJC.StateMachine/graph/badge.svg?token=StateMachine_CODECOV_TOKEN)](https://codecov.io/gh/TJC-Tools/TJC.StateMachine)
+[![codecov](https://codecov.io/gh/TJC-Tools/TJC.StateMachine/graph/badge.svg?token=ZwhQB7Ku8u)](https://codecov.io/gh/TJC-Tools/TJC.StateMachine)
 
 ## Documentation
 - [Changelog](CHANGELOG.md)

TJC.StateMachine.Tests/Mocks/RevolverMock.cs

@@ -0,0 +1,30 @@
+namespace TJC.StateMachine.Tests.Mocks
+{
+    internal class RevolverMock()
+        : StateMachineBase<RevolverStates>(RevolverStates.Loaded)
+    {
+        public int BulletsLoaded { get; private set; } = 6;
+
+        public bool TryShoot()
+        {
+            switch (State)
+            {
+                case RevolverStates.Empty:
+                    return false;
+                case RevolverStates.Loaded:
+                    BulletsLoaded--;
+                    if (BulletsLoaded == 0)
+                        State = RevolverStates.Empty;
+                    return true;
+                default:
+                    throw new InvalidOperationException($"Unknown State [{State}] for method {nameof(TryShoot)}");
+            }
+        }
+
+        public void Reload()
+        {
+            BulletsLoaded = 6;
+            State = RevolverStates.Loaded;
+        }
+    }
+}

TJC.StateMachine.Tests/Mocks/RevolverStates.cs

@@ -0,0 +1,8 @@
+namespace TJC.StateMachine.Tests.Mocks
+{
+    internal enum RevolverStates
+    {
+        Loaded,
+        Empty
+    }
+}

TJC.StateMachine.Tests/TJC.StateMachine.Tests.csproj

@@ -6,6 +6,7 @@
     <Nullable>enable</Nullable>
     <IsPackable>false</IsPackable>
     <IsTestProject>true</IsTestProject>
+    <AppDesignerFolder>Tests</AppDesignerFolder>
   </PropertyGroup>
 
   <ItemGroup>
@@ -15,6 +16,10 @@
     <PackageReference Include="MSTest.TestFramework" Version="3.6.1" />
   </ItemGroup>
 
+  <ItemGroup>
+    <ProjectReference Include="..\TJC.StateMachine\TJC.StateMachine.csproj" />
+  </ItemGroup>
+
   <ItemGroup>
     <Using Include="Microsoft.VisualStudio.TestTools.UnitTesting" />
   </ItemGroup>

TJC.StateMachine.Tests/Tests/RevolverMockTests.cs

@@ -0,0 +1,61 @@
+using TJC.StateMachine.Tests.Mocks;
+
+namespace TJC.StateMachine.Tests.Tests
+{
+    [TestClass]
+    public class RevolverMockTests
+    {
+        [TestMethod]
+        public void EnsureRevolverStartsFull()
+        {
+            var revolver = new RevolverMock();
+            Assert.AreEqual(6, revolver.BulletsLoaded);
+        }
+
+        [TestMethod]
+        public void EnsureRevolverShootingLowersBulletsToZeroThenRequiresReloading()
+        {
+            var revolver = new RevolverMock();
+
+            var result = revolver.TryShoot();
+            Assert.IsTrue(result);
+            Assert.AreEqual(5, revolver.BulletsLoaded);
+
+            result = revolver.TryShoot();
+            Assert.IsTrue(result);
+            Assert.AreEqual(4, revolver.BulletsLoaded);
+
+            result = revolver.TryShoot();
+            Assert.IsTrue(result);
+            Assert.AreEqual(3, revolver.BulletsLoaded);
+
+            result = revolver.TryShoot();
+            Assert.IsTrue(result);
+            Assert.AreEqual(2, revolver.BulletsLoaded);
+
+            result = revolver.TryShoot();
+            Assert.IsTrue(result);
+            Assert.AreEqual(1, revolver.BulletsLoaded);
+
+            result = revolver.TryShoot();
+            Assert.IsTrue(result);
+            Assert.AreEqual(0, revolver.BulletsLoaded);
+
+            result = revolver.TryShoot();
+            Assert.IsFalse(result);
+            Assert.AreEqual(0, revolver.BulletsLoaded);
+        }
+
+        [TestMethod]
+        public void EnsureReloadingResetsBulletsTo6()
+        {
+            var revolver = new RevolverMock();
+
+            Assert.AreEqual(6, revolver.BulletsLoaded);
+            revolver.TryShoot();
+            Assert.AreEqual(5, revolver.BulletsLoaded);
+            revolver.Reload();
+            Assert.AreEqual(6, revolver.BulletsLoaded);
+        }
+    }
+}

TJC.StateMachine.Tests/Tests/StatePropertyAccessibility.cs

@@ -0,0 +1,26 @@
+using System.Reflection;
+using TJC.StateMachine.Tests.Mocks;
+
+namespace TJC.StateMachine.Tests.Tests
+{
+    [TestClass]
+    public class StatePropertyAccessibility
+    {
+        [TestMethod]
+        public void EnsurePropertyStateIsNotPubliclyAccessible()
+        {
+            var prop = typeof(StateMachineBase<RevolverStates>).GetProperty("State", BindingFlags.Instance | BindingFlags.Public);
+            Assert.IsNull(prop);
+        }
+
+        [TestMethod]
+        public void EnsurePropertyStateIsProtectedAccessible()
+        {
+            var prop = typeof(StateMachineBase<RevolverStates>).GetProperty("State", BindingFlags.Instance | BindingFlags.NonPublic);
+            Assert.IsNotNull(prop);
+            var getter = prop.GetMethod;
+            Assert.IsNotNull(getter);
+            Assert.IsTrue(getter.IsFamily);
+        }
+    }
+}

TJC.StateMachine.Tests/UnitTest1.cs

@@ -0,0 +1,15 @@
+namespace TJC.StateMachine
+{
+    /// <summary>
+    /// State machine pattern base class.
+    /// </summary>
+    /// <typeparam name="T">State Type.</typeparam>
+    /// <param name="initialState">Initial State of the State Machine.</param>
+    public class StateMachineBase<T>(T initialState)
+    {
+        /// <summary>
+        /// State of the state machine.
+        /// </summary>
+        protected T State { get; set; } = initialState;
+    }
+}