Provide the State Machine abstraction

composer.json

@@ -134,6 +134,7 @@
         "symfony/twig-bundle": "^5.4.21 || ^6.0",
         "symfony/validator": "^5.4.21 || ^6.0",
         "symfony/webpack-encore-bundle": "^1.15",
+        "symfony/workflow": "^5.4.21 || ^6.0",
         "symfony/yaml": "^5.4.21 || ^6.0",
         "twig/intl-extra": "^2.12 || ^3.4",
         "twig/twig": "^2.12 || ^3.3",

config/packages/workflow.yaml

@@ -0,0 +1,2 @@
+framework:
+    workflows: ~

src/Sylius/Bundle/CoreBundle/Resources/config/services.xml

@@ -37,6 +37,7 @@
         <import resource="services/promotion.xml" />
         <import resource="services/providers.xml" />
         <import resource="services/shipping.xml" />
+        <import resource="services/state_machines.xml" />
         <import resource="services/state_resolvers.xml" />
         <import resource="services/taxation.xml" />
         <import resource="services/templating.xml" />

src/Sylius/Bundle/CoreBundle/Resources/config/services/state_machines.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+ This file is part of the Sylius package.
+
+ (c) Sylius Sp. z o.o.
+
+ For the full copyright and license information, please view the LICENSE
+ file that was distributed with this source code.
+
+-->
+
+<container xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://symfony.com/schema/dic/services"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+    <services>
+        <defaults public="true" />
+
+        <service id="sylius.state_machine.composite" class="Sylius\Bundle\CoreBundle\StateMachine\CompositeStateMachine">
+            <argument type="tagged_iterator" tag="sylius.state_machine" />
+        </service>
+        <service id="Sylius\Bundle\CoreBundle\StateMachine\StateMachineInterface $compositeStateMachine" alias="sylius.state_machine.composite" />
+
+        <service id="sylius.state_machine" alias="sylius.state_machine.composite" />
+        <service id="Sylius\Bundle\CoreBundle\StateMachine\StateMachineInterface" alias="sylius.state_machine" />
+
+        <service id="sylius.state_machine.adapter.symfony_workflow" class="Sylius\Bundle\CoreBundle\StateMachine\SymfonyWorkflowAdapter">
+            <argument type="service" id="workflow.registry" />
+
+            <tag name="sylius.state_machine" priority="128" />
+        </service>
+        <service id="Sylius\Bundle\CoreBundle\StateMachine\StateMachineInterface $symfonyWorkflow" alias="sylius.state_machine.adapter.symfony_workflow" />
+
+        <service id="sylius.state_machine.adapter.winzou_state_machine" class="Sylius\Bundle\CoreBundle\StateMachine\WinzouStateMachineAdapter">
+            <argument type="service" id="sm.factory" />
+
+            <tag name="sylius.state_machine" priority="64" />
+        </service>
+        <service id="Sylius\Bundle\CoreBundle\StateMachine\StateMachineInterface $winzouStateMachine" alias="sylius.state_machine.adapter.winzou_state_machine" />
+    </services>
+</container>

src/Sylius/Bundle/CoreBundle/StateMachine/CompositeStateMachine.php

@@ -0,0 +1,91 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\CoreBundle\StateMachine;
+
+use Exception;
+use Traversable;
+use Webmozart\Assert\Assert;
+
+class CompositeStateMachine implements StateMachineInterface
+{
+    /** @var array<StateMachineInterface> */
+    private array $stateMachineAdapters;
+
+    public function __construct(iterable $stateMachineAdapters)
+    {
+        Assert::notEmpty($stateMachineAdapters, 'At least one state machine adapter should be provided.');
+        Assert::allIsInstanceOf(
+            $stateMachineAdapters,
+            StateMachineInterface::class,
+            sprintf('All state machine adapters should implement the "%s" interface.', StateMachineInterface::class),
+        );
+        $this->stateMachineAdapters = $stateMachineAdapters instanceof Traversable ? iterator_to_array($stateMachineAdapters) : $stateMachineAdapters;
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function can(object $subject, string $graphName, string $transition): bool
+    {
+        $lastException = null;
+
+        foreach ($this->stateMachineAdapters as $stateMachineAdapter) {
+            try {
+                return $stateMachineAdapter->can($subject, $graphName, $transition);
+            } catch (Exception $exception) {
+                $lastException = $exception;
+            }
+        }
+
+        throw $lastException;
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function apply(object $subject, string $graphName, string $transition, array $context = []): void
+    {
+        $lastException = null;
+
+        foreach ($this->stateMachineAdapters as $stateMachineAdapter) {
+            try {
+                $stateMachineAdapter->apply($subject, $graphName, $transition, $context);
+
+                return;
+            } catch (Exception $exception) {
+                $lastException = $exception;
+            }
+        }
+
+        throw $lastException;
+    }
+
+    /**
+     * @throws Exception
+     */
+    public function getEnabledTransition(object $subject, string $graphName): array
+    {
+        $lastException = null;
+
+        foreach ($this->stateMachineAdapters as $stateMachineAdapter) {
+            try {
+                return $stateMachineAdapter->getEnabledTransition($subject, $graphName);
+            } catch (Exception $exception) {
+                $lastException = $exception;
+            }
+        }
+
+        throw $lastException;
+    }
+}

src/Sylius/Bundle/CoreBundle/StateMachine/StateMachineInterface.php

@@ -0,0 +1,26 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\CoreBundle\StateMachine;
+
+interface StateMachineInterface
+{
+    public function can(object $subject, string $graphName, string $transition): bool;
+
+    public function apply(object $subject, string $graphName, string $transition, array $context = []): void;
+
+    /**
+     * @return array<TransitionInterface>
+     */
+    public function getEnabledTransition(object $subject, string $graphName): array;
+}

src/Sylius/Bundle/CoreBundle/StateMachine/SymfonyWorkflowAdapter.php

@@ -0,0 +1,50 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\CoreBundle\StateMachine;
+
+use Symfony\Component\Workflow\Registry;
+use Symfony\Component\Workflow\Transition as SymfonyWorkflowTransition;
+
+final class SymfonyWorkflowAdapter implements StateMachineInterface
+{
+    public function __construct(private Registry $symfonyWorkflowRegistry)
+    {
+    }
+
+    public function can(object $subject, string $graphName, string $transition): bool
+    {
+        return $this->symfonyWorkflowRegistry->get($subject, $graphName)->can($subject, $transition);
+    }
+
+    public function apply(object $subject, string $graphName, string $transition, array $context = []): void
+    {
+        $this->symfonyWorkflowRegistry->get($subject, $graphName)->apply($subject, $transition, $context);
+    }
+
+    public function getEnabledTransition(object $subject, string $graphName): array
+    {
+        $enabledTransitions = $this->symfonyWorkflowRegistry->get($subject, $graphName)->getEnabledTransitions($subject);
+
+        return array_map(
+            function (SymfonyWorkflowTransition $transition): TransitionInterface {
+                return new Transition(
+                    $transition->getName(),
+                    $transition->getFroms(),
+                    $transition->getTos(),
+                );
+            },
+            $enabledTransitions,
+        );
+    }
+}

src/Sylius/Bundle/CoreBundle/StateMachine/Transition.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\CoreBundle\StateMachine;
+
+final class Transition implements TransitionInterface
+{
+    public function __construct(
+        private string $name,
+        private ?array $froms,
+        private ?array $tos,
+    ) {
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+
+    public function getFroms(): ?array
+    {
+        return $this->froms;
+    }
+
+    public function getTos(): ?array
+    {
+        return $this->tos;
+    }
+}

src/Sylius/Bundle/CoreBundle/StateMachine/TransitionInterface.php

@@ -0,0 +1,29 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\CoreBundle\StateMachine;
+
+interface TransitionInterface
+{
+    public function getName(): string;
+
+    /**
+     * @return array<string>|null
+     */
+    public function getFroms(): ?array;
+
+    /**
+     * @return array<string>|null
+     */
+    public function getTos(): ?array;
+}

src/Sylius/Bundle/CoreBundle/StateMachine/WinzouStateMachineAdapter.php

@@ -0,0 +1,48 @@
+<?php
+
+/*
+ * This file is part of the Sylius package.
+ *
+ * (c) Sylius Sp. z o.o.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace Sylius\Bundle\CoreBundle\StateMachine;
+
+use SM\Factory\FactoryInterface;
+
+final class WinzouStateMachineAdapter implements StateMachineInterface
+{
+    public function __construct(private FactoryInterface $winzouStateMachineFactory)
+    {
+    }
+
+    public function can(object $subject, string $graphName, string $transition): bool
+    {
+        return $this->getStateMachine($subject, $graphName)->can($transition);
+    }
+
+    public function apply(object $subject, string $graphName, string $transition, array $context = []): void
+    {
+        $this->getStateMachine($subject, $graphName)->apply($transition);
+    }
+
+    public function getEnabledTransition(object $subject, string $graphName): array
+    {
+        $transitions = $this->getStateMachine($subject, $graphName)->getPossibleTransitions();
+
+        return array_map(
+            fn (string $transition) => new Transition($transition, null, null),
+            $transitions,
+        );
+    }
+
+    private function getStateMachine(object $subject, string $graphName): \SM\StateMachine\StateMachineInterface
+    {
+        return $this->winzouStateMachineFactory->get($subject, $graphName);
+    }
+}