Merge pull request #17 from phansys/tests

Tests on PHP 7.4 & Symfony 5.0

Author: yann-eugone

.travis.yml

@@ -5,11 +5,14 @@ php:
   - 7.1
   - 7.2
   - 7.3
+  - 7.4
 
 env:
   - SYMFONY_VERSION="3.4.*"
   - SYMFONY_VERSION="4.2.*"
   - SYMFONY_VERSION="4.3.*"
+  - SYMFONY_VERSION="4.4.*"
+  - SYMFONY_VERSION="5.0.*"
 
 matrix:
   exclude:
@@ -18,6 +21,13 @@ matrix:
       env: SYMFONY_VERSION="4.2.*"
     - php: 7.0
       env: SYMFONY_VERSION="4.3.*"
+    - php: 7.0
+      env: SYMFONY_VERSION="4.4.*"
+    - php: 7.0
+      env: SYMFONY_VERSION="5.0.*"
+    # Symfony >= 5.0 PHP requirement is ^7.2.5
+    - php: 7.1
+      env: SYMFONY_VERSION="5.0.*"
 
 sudo: false
 

README.md

@@ -24,11 +24,11 @@ This library add Symfony Workflow component integration within Sonata Admin.
 
 ### Code
 
-- a Sonata Admin [Extension](https://sonata-project.org/bundles/admin/master/doc/reference/extensions.html) : 
+- a Sonata Admin [Extension](https://sonata-project.org/bundles/admin/master/doc/reference/extensions.html) :
   [WorkflowExtension](src/Admin/Extension/WorkflowExtension.php)
-- a Controller trait : 
+- a Controller trait :
   [WorkflowControllerTrait](src/Controller/WorkflowControllerTrait.php)
-- a Controller : 
+- a Controller :
   [WorkflowController](src/Controller/WorkflowController.php)
 
 
@@ -44,6 +44,7 @@ Configuration
 
 Let say that you have an entity named `PullRequest` that is under workflow and for which you have an admin.
 
+#### symfony/workflow <4.3
 ```yaml
 # config/packages/workflow.yml
 framework:
@@ -74,11 +75,42 @@ framework:
                     to:   closed
 ```
 
+#### symfony/workflow ^4.3|^5.0
+```yaml
+# config/packages/workflow.yml
+framework:
+    workflows:
+        pull_request:
+            type: state_machine
+            marking_store:
+                type: state_machine
+                property: status
+            supports:
+                - App\Entity\PullRequest
+            places:
+                - opened
+                - pending_review
+                - merged
+                - closed
+            initial_marking:
+                - opened
+            transitions:
+                start_review:
+                    from: opened
+                    to:   pending_review
+                merge:
+                    from: pending_review
+                    to:   merged
+                close:
+                    from: pending_review
+                    to:   closed
+```
+
 ### One extension for everything
 
 The extension is usable for many entities and with no configuration.
 
-You only need to create a service for it, configure the controller that will handle the transition action 
+You only need to create a service for it, configure the controller that will handle the transition action
 and configure on which admin you want it available.
 
 For instance :
@@ -108,7 +140,7 @@ sonata_admin:
                 - admin.pull_request
 ```
 
-> **note**: You may noticed that we also registered the controller 
+> **note**: You may noticed that we also registered the controller
 `Yokai\SonataWorkflow\Controller\WorkflowController` as a service.
 It is important, because it needs the workflow registry service to work.
 
@@ -170,12 +202,12 @@ What are these options ?
 Hook into the transition process
 --------------------------------
 
-Let say that when you start a review for a pull request, as a user, 
+Let say that when you start a review for a pull request, as a user,
 you will be asked to enter which users are involved in the review.
 
 To achieve this, you will be asked to fill a dedicated form.
 
-You only need to create a custom controller for your entity admin : 
+You only need to create a custom controller for your entity admin :
 
 ```yaml
 # config/packages/sonata_admin.yml

composer.json

@@ -25,9 +25,9 @@
     }
   },
   "require": {
-    "php": "^5.6||^7.0",
+    "php": "^5.6|^7.0",
     "sonata-project/admin-bundle": "^3.0",
-    "symfony/workflow": "^3.2|^4.0"
+    "symfony/workflow": "^3.2|^4.0|^5.0"
   },
   "require-dev": {
     "phpunit/phpunit": "^5.0"

tests/Admin/Extension/WorkflowExtensionTest.php

@@ -12,6 +12,7 @@
 use Symfony\Component\Workflow\Registry;
 use Symfony\Component\Workflow\StateMachine;
 use Yokai\SonataWorkflow\Admin\Extension\WorkflowExtension;
+use Yokai\SonataWorkflow\Tests\Fixtures\LegacyWorkflowRegistry;
 use Yokai\SonataWorkflow\Controller\WorkflowController;
 use Yokai\SonataWorkflow\Tests\PullRequest;
 
@@ -56,7 +57,7 @@ public function testAlterNewInstance()
         /** @var AdminInterface|ObjectProphecy $admin */
         $admin = $this->prophesize(AdminInterface::class);
 
-        $registry = new Registry();
+        $registry = new LegacyWorkflowRegistry();
         $registry->add(
             new StateMachine(PullRequest::createWorkflowDefinition()),
             PullRequest::createSupportStrategy()
@@ -118,7 +119,7 @@ public function testConfigureSideMenu($marking, array $transitions)
                 ->willReturn('/pull-request/42/workflow/transition/'.$transition.'/apply');
         }
 
-        $registry = new Registry();
+        $registry = new LegacyWorkflowRegistry();
         $registry->add(
             new StateMachine(PullRequest::createWorkflowDefinition()),
             PullRequest::createSupportStrategy()

tests/Controller/WorkflowControllerTest.php

@@ -8,7 +8,6 @@
 use Sonata\AdminBundle\Exception\LockException;
 use Sonata\AdminBundle\Exception\ModelManagerException;
 use Sonata\AdminBundle\Templating\TemplateRegistryInterface;
-use Symfony\Bundle\FrameworkBundle\Tests\Templating\Helper\Fixtures\StubTranslator;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\RedirectResponse;
@@ -20,6 +19,8 @@
 use Symfony\Component\HttpFoundation\Session\Storage\MockArraySessionStorage;
 use Symfony\Component\Workflow\Registry;
 use Symfony\Component\Workflow\StateMachine;
+use Yokai\SonataWorkflow\Tests\Fixtures\LegacyWorkflowRegistry;
+use Yokai\SonataWorkflow\Tests\Fixtures\StubTranslator;
 use Yokai\SonataWorkflow\Tests\PullRequest;
 use Yokai\SonataWorkflow\Tests\PullRequestWorkflowController;
 use Yokai\SonataWorkflow\Tests\TestKernel;
@@ -63,7 +64,7 @@ public function setUp()
     {
         $this->container = $this->prophesize(ContainerInterface::class);
         $this->admin = $this->prophesize(AdminInterface::class);
-        $this->registry = new Registry();
+        $this->registry = new LegacyWorkflowRegistry();
         $this->flashBag = new FlashBag();
         $this->translator = new StubTranslator();
 

tests/Fixtures/LegacyWorkflowRegistry.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\SonataWorkflow\Tests\Fixtures;
+
+use Symfony\Component\Workflow\Registry;
+use Symfony\Component\Workflow\Workflow;
+
+/**
+ * This class is provided in order to allow tests to call `add()` method, which
+ * is deprecated since symfony/workflow 4.1 and was removed in version 5.0.
+ */
+final class LegacyWorkflowRegistry extends Registry
+{
+    public function add(Workflow $workflow, $supportStrategy)
+    {
+        if (method_exists($this, 'addWorkflow')) {
+            $this->addWorkflow($workflow, $supportStrategy);
+
+            return;
+        }
+
+        parent::add($workflow, $supportStrategy);
+    }
+}

tests/Fixtures/StubTranslator.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\SonataWorkflow\Tests\Fixtures;
+
+use Symfony\Component\Translation\TranslatorInterface as LegacyTranslatorInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+/**
+ * `StubTranslator` provides a simple implementation for the "translator" service.
+ */
+if (interface_exists(TranslatorInterface::class)) {
+    final class StubTranslator implements TranslatorInterface
+    {
+        public function trans($id, array $parameters = [], $domain = null, $locale = null): string
+        {
+            return '[trans]'.strtr($id, $parameters).'[/trans]';
+        }
+    }
+} else {
+    final class StubTranslator implements LegacyTranslatorInterface
+    {
+        public function trans($id, array $parameters = [], $domain = null, $locale = null)
+        {
+            return '[trans]'.$id.'[/trans]';
+        }
+
+        public function transChoice($id, $number, array $parameters = [], $domain = null, $locale = null)
+        {
+            return '[trans]'.$id.'[/trans]';
+        }
+
+        public function setLocale($locale)
+        {
+        }
+
+        public function getLocale()
+        {
+        }
+    }
+}