BuilderTest.php

<?php

namespace uuf6429\StateEngine;

use PHPUnit\Framework\TestCase;
use uuf6429\StateEngine\Implementation\Builder;
use uuf6429\StateEngine\Implementation\Entities\State;
use uuf6429\StateEngine\Interfaces\StateInterface;

class BuilderTest extends TestCase
{
    private Builder $builder;

    protected function setUp(): void
    {
        parent::setUp();

        $this->builder = Builder::create()
            ->defState('started')
            ->defState('finished')
            ->defTransition('started', 'finished');
    }

    public function test_that_states_cannot_be_redeclared(): void
    {
        $this->expectExceptionMessage('Cannot add state "started", it has already been declared.');

        $this->builder->defState('started');
    }

    public function test_that_transitions_cannot_be_redeclared(): void
    {
        $this->expectExceptionMessage('Cannot add transition "started -> finished", it has already been declared.');

        $this->builder->defTransition('started', 'finished');
    }

    public function test_that_old_state_must_be_declared_before_transitions(): void
    {
        $this->expectExceptionMessage('Cannot use state "loaded", since it has not been declared yet.');

        $this->builder->defTransition('loaded', 'started');
    }

    public function test_that_new_state_must_be_declared_before_transitions(): void
    {
        $this->expectExceptionMessage('Cannot use state "progressing", since it has not been declared yet.');

        $this->builder->defTransition('started', 'progressing');
    }

    public function test_that_transitioning_with_mutator_works(): void
    {
        $item = new StatefulItem(new State('started'));
        $mutator = Builder::makeStateMutator(
            static function () use ($item): StateInterface {
                return $item->getState();
            },
            static function (State $newState) use ($item): void {
                $item->setState($newState);
            },
        );

        $this->builder->getEngine()->changeState($mutator, new State('finished'));

        $this->assertSame('finished', $item->getState()->getName());
    }
}