BlackMali.StateMachine 1.0.0

StateMachine

Simple state machine implementation in C# (.NET 6).

Advantages:

• DI ready
• Async Pattern
• Works without constants and enums
• Builder for state machine creation
• Configuration of states and transitions
• Strict and open transitions
• more than 95% code coverage

NuGet

TBD

Configuration

var builder = new StateMachineBuilder();

// OR

var builder = new StateMachineBuilder(new StateMachineConfig(), new StateProvider());

// Every state needs transitions
builder.UseStrictMode();

builder.AddBeginState(new LockState())
	.AddStartTransition();
	.AddInStateTransition()
	.AddTransition<UnLockState>()
	.AddTransition<EndState>();

builder.AddState(new UnLockState())
	.AddInStateTransition()
	.AddTransition<LockState>()
	.AddTransition<EndState>();

// Create state machine
var machine = builder.Build();

State change

await machine.Transmit<LockState>();

// OR with Event

await machine.Transmit<LockState>(new StateMachineEvent());

// Posts an event to the current status

await machine.Post(new StateMachineEvent());

State implementation

internal class LockState 
	: State // you can also use the interface IState without overrides
{
	// optional:
	public override async Task OnEnter(IStateMachineContext context)
	{
		await base.OnEnter(context);

		Console.WriteLine("Please insert coin");
	}

	// optional:
	public override async Task<IState?> OnTransmitted(IStateMachineContext context, StateMachineEvent @event)
	{
		var unLockEvent = @event as UnLockEvent;
		if (unLockEvent == null)
			return null;

		// No state change...
		if (unLockEvent.Coin == null)
			return null;

		// State change to UnLockState
		return await context.GetState<UnLockState>();
	}

	// optional:
	public override async Task OnExit(IStateMachineContext context)
	{
		// Do something...

		await Task.CompletedTask;
	}
}

Used Packages

• XUnit
• XUnit.Runner.VisualStudio
• Autofac.Extras.Moq
• Moq
• Coverlet.Collector

Implemented with Microsoft Visual Studio Community 2022

Used extensions

• Markdown Editor
• Fine Code Coverage