Updated dependencies + PHP strict type

yokai-php · Jun 30, 2020 · 3cb39fe · 3cb39fe
1 parent cc3b584
commit 3cb39fe
Show file tree

Hide file tree

Showing 14 changed files with 134 additions and 215 deletions.
diff --git a/README.md b/README.md
@@ -6,10 +6,6 @@ Yokai Sonata Workflow
 [![Total Downloads](https://poser.pugx.org/yokai/sonata-workflow/downloads)](https://packagist.org/packages/yokai/sonata-workflow)
 [![License](https://poser.pugx.org/yokai/sonata-workflow/license)](https://packagist.org/packages/yokai/sonata-workflow)
 
-[![Build Status](https://api.travis-ci.org/yokai-php/sonata-workflow.png?branch=master)](https://travis-ci.org/yokai-php/sonata-workflow)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/yokai-php/sonata-workflow/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/yokai-php/sonata-workflow/?branch=master)
-[![Code Coverage](https://scrutinizer-ci.com/g/yokai-php/sonata-workflow/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/yokai-php/sonata-workflow/?branch=master)
-
 
 Introduction
 ------------
@@ -44,38 +40,6 @@ 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:
-    workflows:
-        pull_request:
-            type: state_machine
-            marking_store:
-                type: single_state
-                arguments:
-                    - status
-            supports:
-                - App\Entity\PullRequest
-            places:
-                - opened
-                - pending_review
-                - merged
-                - closed
-            initial_place: opened
-            transitions:
-                start_review:
-                    from: opened
-                    to:   pending_review
-                merge:
-                    from: pending_review
-                    to:   merged
-                close:
-                    from: pending_review
-                    to:   closed
-```
-
-#### symfony/workflow ^4.3|^5.0
 ```yaml
 # config/packages/workflow.yml
 framework:
@@ -224,18 +188,21 @@ services:
 <?php
 // src/Admin/Controller/PullRequestController.php
 
+declare(strict_types=1);
+
 namespace App\Admin\Controller;
 
 use App\Entity\PullRequest;
 use App\Form\PullRequest\StartReviewType;
 use Sonata\AdminBundle\Controller\CRUDController;
+use Symfony\Component\HttpFoundation\Response;
 use Yokai\SonataWorkflow\Controller\WorkflowControllerTrait;
 
 class PullRequestController extends CRUDController
 {
     use WorkflowControllerTrait;
 
-    protected function preApplyTransition($object, $transition)
+    protected function preApplyTransition($object, string $transition): ?Response
     {
         switch ($transition) {
             case 'start_review':
@@ -245,7 +212,7 @@ class PullRequestController extends CRUDController
         return null;
     }
 
-    protected function startReview(PullRequest $object, $transition)
+    protected function startReview(PullRequest $object, string $transition): ?Response
     {
         $form = $this->createForm(
             StartReviewType::class,

diff --git a/composer.json b/composer.json
@@ -25,12 +25,12 @@
     }
   },
   "require": {
-    "php": "^5.6|^7.0",
+    "php": "^7.1",
     "sonata-project/admin-bundle": "^3.0",
-    "symfony/workflow": "^3.2|^4.0|^5.0"
+    "symfony/workflow": "^4.4|^5.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "^5.0",
+    "phpunit/phpunit": "^7.5",
     "squizlabs/php_codesniffer": "^3.5"
   },
   "minimum-stability": "stable",

diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -11,6 +11,7 @@
     <rule ref="PSR12"/>
 
     <file>src/</file>
+    <file>tests/</file>
 
     <rule ref="Generic.PHP.ForbiddenFunctions">
         <properties>

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -7,7 +7,6 @@
          convertWarningsToExceptions="true"
          processIsolation="false"
          stopOnFailure="false"
-         syntaxCheck="false"
          colors="true"
          bootstrap="vendor/autoload.php"
         >

diff --git a/src/Admin/Extension/WorkflowExtension.php b/src/Admin/Extension/WorkflowExtension.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Yokai\SonataWorkflow\Admin\Extension;
 
 use Knp\Menu\ItemInterface as MenuItemInterface;
@@ -42,7 +44,7 @@ public function __construct(Registry $registry, array $options = [])
     /**
      * @inheritdoc
      */
-    public function configureRoutes(AdminInterface $admin, RouteCollection $collection)
+    public function configureRoutes(AdminInterface $admin, RouteCollection $collection): void
     {
         $collection->add(
             'workflow_apply_transition',
@@ -53,7 +55,7 @@ public function configureRoutes(AdminInterface $admin, RouteCollection $collecti
     /**
      * @inheritdoc
      */
-    public function alterNewInstance(AdminInterface $admin, $object)
+    public function alterNewInstance(AdminInterface $admin, $object): void
     {
         try {
             $workflow = $this->getWorkflow($object, $this->options['workflow_name']);
@@ -72,7 +74,7 @@ public function configureSideMenu(
         MenuItemInterface $menu,
         $action,
         AdminInterface $childAdmin = null
-    ) {
+    ): void {
         if (null !== $childAdmin || !in_array($action, $this->options['render_actions'], true)) {
             return;
         }
@@ -100,7 +102,7 @@ public function configureSideMenu(
     /**
      * @inheritdoc
      */
-    public function getAccessMapping(AdminInterface $admin)
+    public function getAccessMapping(AdminInterface $admin): array
     {
         return [
             'viewTransitions' => $this->options['view_transitions_role'],
@@ -115,15 +117,15 @@ public function getAccessMapping(AdminInterface $admin)
      * @return Workflow
      * @throws InvalidArgumentException
      */
-    protected function getWorkflow($subject, $workflowName = null)
+    protected function getWorkflow($subject, string $workflowName = null): Workflow
     {
         return $this->registry->get($subject, $workflowName);
     }
 
     /**
      * @param OptionsResolver $resolver
      */
-    protected function configureOptions(OptionsResolver $resolver)
+    protected function configureOptions(OptionsResolver $resolver): void
     {
         $resolver
             ->setDefaults([
@@ -157,7 +159,7 @@ protected function configureOptions(OptionsResolver $resolver)
      * @param MenuItemInterface $menu
      * @param AdminInterface    $admin
      */
-    protected function noTransitions(MenuItemInterface $menu, AdminInterface $admin)
+    protected function noTransitions(MenuItemInterface $menu, AdminInterface $admin): void
     {
         if ($this->options['no_transition_display']) {
             $menu->addChild($this->options['no_transition_label'], [
@@ -173,13 +175,17 @@ protected function noTransitions(MenuItemInterface $menu, AdminInterface $admin)
     }
 
     /**
-     * @param MenuItemInterface $menu
-     * @param AdminInterface    $admin
-     * @param Transition[]      $transitions
-     * @param object            $subject
+     * @param MenuItemInterface     $menu
+     * @param AdminInterface        $admin
+     * @param iterable|Transition[] $transitions
+     * @param object                $subject
      */
-    protected function transitionsDropdown(MenuItemInterface $menu, AdminInterface $admin, $transitions, $subject)
-    {
+    protected function transitionsDropdown(
+        MenuItemInterface $menu,
+        AdminInterface $admin,
+        iterable $transitions,
+        $subject
+    ): void {
         $workflowMenu = $menu->addChild($this->options['dropdown_transitions_label'], [
             'attributes' => [
                 'dropdown' => true,
@@ -201,8 +207,12 @@ protected function transitionsDropdown(MenuItemInterface $menu, AdminInterface $
      * @param Transition        $transition
      * @param object            $subject
      */
-    protected function transitionsItem(MenuItemInterface $menu, AdminInterface $admin, Transition $transition, $subject)
-    {
+    protected function transitionsItem(
+        MenuItemInterface $menu,
+        AdminInterface $admin,
+        Transition $transition,
+        $subject
+    ): void {
         $options = [
             'attributes' => [],
             'extras' => [
@@ -229,7 +239,7 @@ protected function transitionsItem(MenuItemInterface $menu, AdminInterface $admi
      *
      * @return string|null
      */
-    protected function getTransitionIcon(Transition $transition)
+    protected function getTransitionIcon(Transition $transition): ?string
     {
         if (isset($this->options['transitions_icons'][$transition->getName()])) {
             return $this->options['transitions_icons'][$transition->getName()];
@@ -245,7 +255,7 @@ protected function getTransitionIcon(Transition $transition)
      *
      * @return string
      */
-    protected function generateTransitionUri(AdminInterface $admin, Transition $transition, $subject)
+    protected function generateTransitionUri(AdminInterface $admin, Transition $transition, $subject): string
     {
         return $admin->generateObjectUrl(
             'workflow_apply_transition',
@@ -260,7 +270,7 @@ protected function generateTransitionUri(AdminInterface $admin, Transition $tran
      *
      * @return bool
      */
-    protected function isGrantedView(AdminInterface $admin, $subject)
+    protected function isGrantedView(AdminInterface $admin, $subject): bool
     {
         try {
             $admin->checkAccess('viewTransitions', $subject);
@@ -277,7 +287,7 @@ protected function isGrantedView(AdminInterface $admin, $subject)
      *
      * @return bool
      */
-    protected function isGrantedApply(AdminInterface $admin, $subject)
+    protected function isGrantedApply(AdminInterface $admin, $subject): bool
     {
         try {
             $admin->checkAccess('applyTransitions', $subject);

diff --git a/src/Controller/WorkflowController.php b/src/Controller/WorkflowController.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Yokai\SonataWorkflow\Controller;
 
 use Sonata\AdminBundle\Controller\CRUDController;

diff --git a/src/Controller/WorkflowControllerTrait.php b/src/Controller/WorkflowControllerTrait.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Yokai\SonataWorkflow\Controller;
 
 use Psr\Container\ContainerInterface;
@@ -43,7 +45,7 @@ trait WorkflowControllerTrait
      *
      * @required Symfony DI autowiring
      */
-    public function setWorkflowRegistry(Registry $workflowRegistry)
+    public function setWorkflowRegistry(Registry $workflowRegistry): void
     {
         $this->workflowRegistry = $workflowRegistry;
     }
@@ -53,7 +55,7 @@ public function setWorkflowRegistry(Registry $workflowRegistry)
      *
      * @return Response
      */
-    public function workflowApplyTransitionAction(Request $request)
+    public function workflowApplyTransitionAction(Request $request): Response
     {
         $id = $request->get($this->admin->getIdParameter());
 
@@ -153,7 +155,7 @@ public function workflowApplyTransitionAction(Request $request)
      * @return Workflow
      * @throws InvalidArgumentException
      */
-    protected function getWorkflow($object)
+    protected function getWorkflow($object): Workflow
     {
         $registry = $this->workflowRegistry;
         if ($registry === null) {
@@ -183,7 +185,7 @@ protected function getWorkflow($object)
      *
      * @return null|Response
      */
-    protected function preApplyTransition($object, $transition)
+    protected function preApplyTransition($object, string $transition): ?Response
     {
         return null;
     }