Merge pull request #343 from basz/change/pass-context-parameter-to-ge…

…tIdentityRoles

Change/pass context parameter to RoleService::getIdentityRoles

config/dependencies.global.php

@@ -23,7 +23,7 @@
             ZfcRbac\Options\ModuleOptions::class                 => ZfcRbac\Container\ModuleOptionsFactory::class,
             ZfcRbac\Role\RoleProviderPluginManager::class        => ZfcRbac\Container\RoleProviderPluginManagerFactory::class,
             ZfcRbac\Service\AuthorizationServiceInterface::class => ZfcRbac\Container\AuthorizationServiceFactory::class,
-            ZfcRbac\Service\RoleService::class                   => ZfcRbac\Container\RoleServiceFactory::class,
+            ZfcRbac\Service\RoleServiceInterface::class          => ZfcRbac\Container\RoleServiceFactory::class,
         ],
     ],
 

src/Service/AuthorizationService.php

@@ -39,7 +39,7 @@ class AuthorizationService implements AuthorizationServiceInterface
     protected $rbac;
 
     /**
-     * @var RoleService
+     * @var RoleServiceInterface
      */
     protected $roleService;
 
@@ -57,11 +57,14 @@ class AuthorizationService implements AuthorizationServiceInterface
      * Constructor
      *
      * @param Rbac                   $rbac
-     * @param RoleService            $roleService
+     * @param RoleServiceInterface   $roleService
      * @param AssertionPluginManager $assertionPluginManager
      */
-    public function __construct(Rbac $rbac, RoleService $roleService, AssertionPluginManager $assertionPluginManager)
-    {
+    public function __construct(
+        Rbac $rbac,
+        RoleServiceInterface $roleService,
+        AssertionPluginManager $assertionPluginManager
+    ) {
         $this->rbac                   = $rbac;
         $this->roleService            = $roleService;
         $this->assertionPluginManager = $assertionPluginManager;
@@ -106,7 +109,7 @@ public function hasAssertion($permission)
      */
     public function isGranted($identity, $permission, $context = null)
     {
-        $roles = $this->roleService->getIdentityRoles($identity);
+        $roles = $this->roleService->getIdentityRoles($identity, $context);
 
         if (empty($roles)) {
             return false;

src/Service/RoleService.php

@@ -29,7 +29,7 @@
  * @author  Michaël Gallego <[email protected]>
  * @licence MIT
  */
-class RoleService
+class RoleService implements RoleServiceInterface
 {
 
     /**
@@ -87,9 +87,10 @@ public function getGuestRole()
      * Get the identity roles from the current identity, applying some more logic
      *
      * @param IdentityInterface $identity
+     * @param null              $context
      * @return RoleInterface[]
      */
-    public function getIdentityRoles(IdentityInterface $identity = null)
+    public function getIdentityRoles(IdentityInterface $identity = null, $context = null)
     {
         if (null === $identity) {
             return $this->convertRoles([$this->guestRole]);

src/Service/RoleServiceInterface.php

@@ -0,0 +1,40 @@
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license.
+ */
+
+namespace ZfcRbac\Service;
+
+use Rbac\Role\RoleInterface;
+use ZfcRbac\Identity\IdentityInterface;
+
+/**
+ * Role service
+ *
+ * @author  Michaël Gallego <[email protected]>
+ * @licence MIT
+ */
+interface RoleServiceInterface
+{
+    /**
+     * Get the identity roles from the current identity, applying some more logic
+     *
+     * @param null|IdentityInterface $identity
+     * @param mixed                   $context
+     * @return RoleInterface[]
+     */
+    public function getIdentityRoles(IdentityInterface $identity = null, $context = null);
+}

test/Service/AuthorizationServiceTest.php

@@ -23,6 +23,7 @@
 use ZfcRbac\Identity\IdentityInterface;
 use ZfcRbac\Service\AuthorizationService;
 use ZfcRbac\Service\RoleService;
+use ZfcRbac\Service\RoleServiceInterface;
 use ZfcRbacTest\Asset\FlatRole;
 use ZfcRbacTest\Asset\Identity;
 use ZfcRbacTest\Asset\SimpleAssertion;
@@ -267,4 +268,18 @@ public function testAssertionMap()
 
         $this->assertFalse($authorizationService->hasAssertion('bar'));
     }
+
+    public function testContextIsPassedToRoleService()
+    {
+        $identity               = new Identity([]);
+        $context                = 'context';
+
+        $rbac                   = $this->getMockBuilder(Rbac::class)->disableOriginalConstructor()->getMock();
+        $roleService            = $this->getMockBuilder(RoleServiceInterface::class)->disableOriginalConstructor()->getMock();
+        $assertionPluginManager = $this->getMockBuilder(AssertionPluginManager::class)->disableOriginalConstructor()->getMock();
+        $authorizationService   = new AuthorizationService($rbac, $roleService, $assertionPluginManager);
+
+        $roleService->expects($this->once())->method('getIdentityRoles')->with($identity, $context)->willReturn([]);
+        $authorizationService->isGranted($identity, 'foo', $context);
+    }
 }