Merge pull request #2 from yokai-php/issue.1-work.with.private.service.in.controller

Work with private services in controller

Author: yann-eugone

README.md

@@ -89,14 +89,17 @@ services:
     admin.pull_request:
         class: App\Admin\PullRequestAdmin
         public: true
-        arguments: [~, App\Entity\PullRequest, 'Yokai\SonataWorkflow\Controller\WorkflowController']
+        arguments: [~, App\Entity\PullRequest, Yokai\SonataWorkflow\Controller\WorkflowController]
         tags:
             - { name: 'sonata.admin', manager_type: orm, label: PullRequest }
     admin.extension.workflow:
         class: Yokai\SonataWorkflow\Admin\Extension\WorkflowExtension
         public: true
         arguments:
-            - "@workflow.registry"
+            - '@workflow.registry'
+    Yokai\SonataWorkflow\Controller\WorkflowController:
+        autowire: true
+        tags: ['controller.service_arguments']
 
 sonata_admin:
     extensions:
@@ -105,6 +108,10 @@ sonata_admin:
                 - admin.pull_request
 ```
 
+> **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.
+
 ### More specific extension per admin
 
 But the extension accepts many options if you wish to customize the behavior.
@@ -124,7 +131,7 @@ services:
         class: Yokai\SonataWorkflow\Admin\Extension\WorkflowExtension
         public: true
         arguments:
-            - "@workflow.registry"
+            - '@workflow.registry'
             - workflow_name: pull_request
               no_transition_label: No transition for pull request
               no_transition_icon: fa fa-times
@@ -135,6 +142,9 @@ services:
                   start_review: fa fa-search
                   merge: fa fa-check
                   close: fa fa-times
+    Yokai\SonataWorkflow\Controller\WorkflowController:
+        autowire: true
+        tags: ['controller.service_arguments']
 
 sonata_admin:
     extensions:
@@ -171,7 +181,7 @@ services:
     admin.pull_request:
         class: App\Admin\PullRequestAdmin
         public: true
-        arguments: [~, App\Entity\PullRequest, 'App\Admin\Controller\PullRequestController']
+        arguments: [~, App\Entity\PullRequest, App\Admin\Controller\PullRequestController]
         tags:
             - { name: 'sonata.admin', manager_type: orm, label: PullRequest }
 ```

src/Controller/WorkflowControllerTrait.php

@@ -6,12 +6,14 @@
 use Sonata\AdminBundle\Admin\AdminInterface;
 use Sonata\AdminBundle\Exception\LockException;
 use Sonata\AdminBundle\Exception\ModelManagerException;
+use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Symfony\Component\Workflow\Exception\InvalidArgumentException;
 use Symfony\Component\Workflow\Exception\LogicException;
+use Symfony\Component\Workflow\Registry;
 use Symfony\Component\Workflow\Workflow;
 
 /**
@@ -31,6 +33,21 @@
  */
 trait WorkflowControllerTrait
 {
+    /**
+     * @var Registry
+     */
+    private $workflowRegistry;
+
+    /**
+     * @param Registry $workflowRegistry
+     *
+     * @required Symfony DI autowiring
+     */
+    public function setWorkflowRegistry(Registry $workflowRegistry)
+    {
+        $this->workflowRegistry = $workflowRegistry;
+    }
+
     /**
      * @param Request $request
      *
@@ -137,11 +154,25 @@ public function workflowApplyTransitionAction(Request $request)
      */
     protected function getWorkflow($object)
     {
-        if (method_exists($this, 'get')) {
-            return $this->get('workflow.registry')->get($object);
+        $registry = $this->workflowRegistry;
+        if ($registry === null) {
+            try {
+                if (method_exists($this, 'get')) {
+                    $registry = $this->get('workflow.registry');
+                } else {
+                    $registry = $this->getContainer()->get('workflow.registry');
+                }
+            } catch (ServiceNotFoundException $exception) {
+                throw new \LogicException('Could not find the "workflow.registry" service. '.
+                    'You should either provide it via setter injection in your controller service definition '.
+                    'or make it public in your project.',
+                    0,
+                    $exception
+                );
+            }
         }
 
-        return $this->getContainer()->get('workflow.registry')->get($object);
+        return $registry->get($object);
     }
 
     /**

tests/Controller/WorkflowControllerTest.php

@@ -7,6 +7,7 @@
 use Sonata\AdminBundle\Admin\Pool;
 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;
@@ -84,10 +85,12 @@ public function setUp()
         $this->container->get('session')->willReturn(new Session(new MockArraySessionStorage(), null, $this->flashBag));
         $this->container->get('translator')->willReturn($this->translator);
         $this->container->has('logger')->willReturn(false);
+        $this->container->get('admin.pull_request.template_registry')->willReturn($this->prophesize(TemplateRegistryInterface::class)->reveal());
 
         $this->admin->isChild()->willReturn(false);
         $this->admin->setRequest($this->request)->willReturn(null);
         $this->admin->getIdParameter()->willReturn('id');
+        $this->admin->getCode()->willReturn('admin.pull_request');
     }
 
     public function tearDown()