Compatibility with Sonata 4.x (#30)

* Allow sonata ^4.0 * Introduced WorkflowExtension::configureTabMenu as an alias of WorkflowExtension::configureSideMenu * Added missing sonata.admin.pool.do-not-use service to controller container * Add Github action tests with sonata 4.x-dev@dev * Bump packages versions * Adapt tests & fix sources for Sonata 4.x * Updated PHPUnit configuration structure * Use PHP 7.4 features * Fixed missing session service for Symfony 4.4 tests * Force PHPUnit 9.x
yokai-php · Oct 18, 2021 · ea912e9 · ea912e9
1 parent 5f0f6bd
commit ea912e9
Show file tree

Hide file tree

Showing 11 changed files with 91 additions and 177 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -4,6 +4,7 @@ on:
   pull_request: null
   push:
     branches:
+      - "main"
       - "0.*.x"
 
 jobs:
@@ -14,14 +15,12 @@ jobs:
     strategy:
       matrix:
         include:
-          - php-version: 7.3
-            symfony-version: 4.4.*
-          - php-version: 7.3
-            symfony-version: 5.2.*
           - php-version: 7.4
-            symfony-version: 5.2.*
+            symfony-version: 4.4.*
+            sonata-version: ^4.0
           - php-version: 8.0
-            symfony-version: 5.2.*
+            symfony-version: 5.3.*
+            sonata-version: ^4.0
 
     steps:
       - name: "Checkout"
@@ -36,6 +35,7 @@ jobs:
       - name: "Install dependencies with composer"
         run: |
           composer require --no-update symfony/workflow:${{ matrix.symfony-version }}
+          composer require --no-update sonata-project/admin-bundle:${{ matrix.sonata-version }}
           composer update --no-interaction --no-progress --no-suggest
 
       - name: "Run tests with phpunit/phpunit"
@@ -49,7 +49,7 @@ jobs:
       matrix:
         include:
           - php-version: 8.0
-            symfony-version: 5.2.*
+            symfony-version: 5.3.*
 
     steps:
       - name: "Checkout"
@@ -76,7 +76,7 @@ jobs:
       matrix:
         include:
           - php-version: 8.0
-            symfony-version: 5.2.*
+            symfony-version: 5.3.*
 
     steps:
       - name: "Checkout"

diff --git a/.gitignore b/.gitignore
@@ -3,5 +3,6 @@
 /build/
 /vendor/
 /.phpcs-cache
+/.phpunit.result.cache
 /composer.lock
 /docker-compose.yml
diff --git a/README.md b/README.md
@@ -207,7 +207,7 @@ class PullRequestController extends CRUDController
 {
     use WorkflowControllerTrait;
 
-    protected function preApplyTransition($object, string $transition): ?Response
+    protected function preApplyTransition(object $object, string $transition): ?Response
     {
         switch ($transition) {
             case 'start_review':

diff --git a/composer.json b/composer.json
@@ -25,12 +25,13 @@
     }
   },
   "require": {
-    "php": "^7.3|^8.0",
-    "sonata-project/admin-bundle": "^3.0",
+    "php": "^7.4|^8.0",
+    "sonata-project/admin-bundle": "^4.0",
     "symfony/workflow": "^4.4|^5.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "^8.5|^9.5",
-    "squizlabs/php_codesniffer": "^3.5"
+    "phpunit/phpunit": "^9.5",
+    "squizlabs/php_codesniffer": "^3.5",
+    "phpspec/prophecy-phpunit": "^2.0"
   }
 }
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,24 +1,24 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
-<phpunit backupGlobals="false"
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+         backupGlobals="false"
          backupStaticAttributes="false"
          convertErrorsToExceptions="true"
          convertNoticesToExceptions="true"
          convertWarningsToExceptions="true"
          processIsolation="false"
          stopOnFailure="false"
          colors="true"
-         bootstrap="vendor/autoload.php"
-        >
+         bootstrap="vendor/autoload.php">
+    <coverage>
+        <include>
+            <directory>./src</directory>
+        </include>
+    </coverage>
     <testsuites>
         <testsuite name="default">
             <directory>./tests</directory>
         </testsuite>
     </testsuites>
-
-    <filter>
-        <whitelist>
-            <directory>./src</directory>
-        </whitelist>
-    </filter>
 </phpunit>
diff --git a/src/Admin/Extension/WorkflowExtension.php b/src/Admin/Extension/WorkflowExtension.php
@@ -7,7 +7,7 @@
 use Knp\Menu\ItemInterface as MenuItemInterface;
 use Sonata\AdminBundle\Admin\AbstractAdminExtension;
 use Sonata\AdminBundle\Admin\AdminInterface;
-use Sonata\AdminBundle\Route\RouteCollection;
+use Sonata\AdminBundle\Route\RouteCollectionInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 use Symfony\Component\Security\Core\Exception\AccessDeniedException;
 use Symfony\Component\Workflow\Exception\InvalidArgumentException;
@@ -20,20 +20,9 @@
  */
 class WorkflowExtension extends AbstractAdminExtension
 {
-    /**
-     * @var Registry
-     */
-    private $registry;
+    private Registry $registry;
+    private array $options;
 
-    /**
-     * @var array
-     */
-    private $options;
-
-    /**
-     * @param Registry $registry
-     * @param array    $options
-     */
     public function __construct(Registry $registry, array $options = [])
     {
         $this->registry = $registry;
@@ -44,7 +33,7 @@ public function __construct(Registry $registry, array $options = [])
     /**
      * @inheritdoc
      */
-    public function configureRoutes(AdminInterface $admin, RouteCollection $collection): void
+    public function configureRoutes(AdminInterface $admin, RouteCollectionInterface $collection): void
     {
         $collection->add(
             'workflow_apply_transition',
@@ -69,18 +58,23 @@ public function alterNewInstance(AdminInterface $admin, $object): void
     /**
      * @inheritdoc
      */
-    public function configureSideMenu(
+    public function configureTabMenu(
         AdminInterface $admin,
         MenuItemInterface $menu,
         $action,
-        AdminInterface $childAdmin = null
+        ?AdminInterface $childAdmin = null
     ): void {
         if (null !== $childAdmin || !in_array($action, $this->options['render_actions'], true)) {
             return;
         }
 
-        $subject = $admin->getSubject();
-        if (null === $subject || !$this->isGrantedView($admin, $subject)) {
+        try {
+            $subject = $admin->getSubject();
+        } catch (\LogicException $exception) {
+            return;
+        }
+
+        if (!$this->isGrantedView($admin, $subject)) {
             return;
         }
 
@@ -111,20 +105,13 @@ public function getAccessMapping(AdminInterface $admin): array
     }
 
     /**
-     * @param object      $subject
-     * @param string|null $workflowName
-     *
-     * @return Workflow
      * @throws InvalidArgumentException
      */
-    protected function getWorkflow($subject, string $workflowName = null): Workflow
+    protected function getWorkflow(object $subject, string $workflowName = null): Workflow
     {
         return $this->registry->get($subject, $workflowName);
     }
 
-    /**
-     * @param OptionsResolver $resolver
-     */
     protected function configureOptions(OptionsResolver $resolver): void
     {
         $resolver
@@ -155,10 +142,6 @@ protected function configureOptions(OptionsResolver $resolver): void
         ;
     }
 
-    /**
-     * @param MenuItemInterface $menu
-     * @param AdminInterface    $admin
-     */
     protected function noTransitions(MenuItemInterface $menu, AdminInterface $admin): void
     {
         if ($this->options['no_transition_display']) {
@@ -175,16 +158,13 @@ protected function noTransitions(MenuItemInterface $menu, AdminInterface $admin)
     }
 
     /**
-     * @param MenuItemInterface     $menu
-     * @param AdminInterface        $admin
-     * @param iterable|Transition[] $transitions
-     * @param object                $subject
+     * @param iterable&Transition[] $transitions
      */
     protected function transitionsDropdown(
         MenuItemInterface $menu,
         AdminInterface $admin,
         iterable $transitions,
-        $subject
+        object $subject
     ): void {
         $workflowMenu = $menu->addChild($this->options['dropdown_transitions_label'], [
             'attributes' => [
@@ -201,17 +181,11 @@ protected function transitionsDropdown(
         }
     }
 
-    /**
-     * @param MenuItemInterface $menu
-     * @param AdminInterface    $admin
-     * @param Transition        $transition
-     * @param object            $subject
-     */
     protected function transitionsItem(
         MenuItemInterface $menu,
         AdminInterface $admin,
         Transition $transition,
-        $subject
+        object $subject
     ): void {
         $options = [
             'attributes' => [],
@@ -234,11 +208,6 @@ protected function transitionsItem(
         );
     }
 
-    /**
-     * @param Transition $transition
-     *
-     * @return string|null
-     */
     protected function getTransitionIcon(Transition $transition): ?string
     {
         if (isset($this->options['transitions_icons'][$transition->getName()])) {
@@ -248,14 +217,7 @@ protected function getTransitionIcon(Transition $transition): ?string
         return $this->options['transitions_default_icon'];
     }
 
-    /**
-     * @param AdminInterface $admin
-     * @param Transition     $transition
-     * @param object         $subject
-     *
-     * @return string
-     */
-    protected function generateTransitionUri(AdminInterface $admin, Transition $transition, $subject): string
+    protected function generateTransitionUri(AdminInterface $admin, Transition $transition, object $subject): string
     {
         return $admin->generateObjectUrl(
             'workflow_apply_transition',
@@ -264,13 +226,7 @@ protected function generateTransitionUri(AdminInterface $admin, Transition $tran
         );
     }
 
-    /**
-     * @param AdminInterface $admin
-     * @param object         $subject
-     *
-     * @return bool
-     */
-    protected function isGrantedView(AdminInterface $admin, $subject): bool
+    protected function isGrantedView(AdminInterface $admin, object $subject): bool
     {
         try {
             $admin->checkAccess('viewTransitions', $subject);
@@ -281,13 +237,7 @@ protected function isGrantedView(AdminInterface $admin, $subject): bool
         return true;
     }
 
-    /**
-     * @param AdminInterface $admin
-     * @param object         $subject
-     *
-     * @return bool
-     */
-    protected function isGrantedApply(AdminInterface $admin, $subject): bool
+    protected function isGrantedApply(AdminInterface $admin, object $subject): bool
     {
         try {
             $admin->checkAccess('applyTransitions', $subject);