Merge pull request zendframework/zendframework#7328 from kanellov/fea…

…ture/acl_callback_assertion

Acl callback assertion

src/Assertion/CallbackAssertion.php

@@ -0,0 +1,60 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/).
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ *
+ * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+namespace Zend\Permissions\Acl\Assertion;
+
+use Zend\Permissions\Acl\Acl;
+use Zend\Permissions\Acl\Exception\InvalidArgumentException;
+use Zend\Permissions\Acl\Resource\ResourceInterface;
+use Zend\Permissions\Acl\Role\RoleInterface;
+
+class CallbackAssertion implements AssertionInterface
+{
+    /**
+     * @var callable
+     */
+    protected $callback;
+
+    /**
+     * Class constructor.
+     *
+     * @param callable $callback the autentication callback
+     */
+    public function __construct($callback)
+    {
+        if (!is_callable($callback)) {
+            throw new InvalidArgumentException('Invalid callback provided; not callable');
+        }
+        $this->callback = $callback;
+    }
+
+    /**
+     * Returns true if and only if the assertion conditions are met.
+     *
+     * This method is passed the ACL, Role, Resource, and privilege to which the
+     * authorization query applies. If the
+     * $role, $resource, or $privilege parameters are null, it means that the
+     * query applies to all Roles, Resources, or privileges, respectively.
+     *
+     * @param Acl               $acl
+     * @param RoleInterface     $role
+     * @param ResourceInterface $resource
+     * @param string            $privilege
+     *
+     * @return bool
+     */
+    public function assert(
+        Acl $acl,
+        RoleInterface $role = null,
+        ResourceInterface $resource = null,
+        $privilege = null
+    ) {
+        return (bool) call_user_func($this->callback, $acl, $role, $resource, $privilege);
+    }
+}

test/Assertion/CallbackAssertionTest.php

@@ -0,0 +1,80 @@
+<?php
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+namespace ZendTest\Permissions\Acl\Assertion;
+
+use Zend\Permissions\Acl;
+
+class CallbackAssertionTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * Ensures constructor throws InvalidArgumentException if not callable is provided
+     */
+    public function testConstructorThrowsExceptionIfNotCallable()
+    {
+        $this->setExpectedException(
+            'Zend\Permissions\Acl\Exception\InvalidArgumentException',
+            'Invalid callback provided; not callable'
+        );
+        new Acl\Assertion\CallbackAssertion('I\'m not callable!');
+    }
+
+    /**
+     * Ensures callback is set in object
+     */
+    public function testCallbackIsSet()
+    {
+        $callback   = function () {};
+        $assert     = new Acl\Assertion\CallbackAssertion($callback);
+        $this->assertAttributeSame($callback, 'callback', $assert);
+    }
+
+    /**
+     * Ensures assert method provides callback with its arguments
+     */
+    public function testAssertMethodPassArgsToCallback()
+    {
+        $acl       = new Acl\Acl();
+        $that      = $this;
+        $assert    = new Acl\Assertion\CallbackAssertion(
+            function ($aclArg, $roleArg, $resourceArg, $privilegeArg) use ($that, $acl) {
+                $that->assertSame($acl, $aclArg);
+                $that->assertInstanceOf('Zend\Permissions\Acl\Role\RoleInterface', $roleArg);
+                $that->assertEquals('guest', $roleArg->getRoleId());
+                $that->assertInstanceOf('Zend\Permissions\Acl\Resource\ResourceInterface', $resourceArg);
+                $that->assertEquals('area1', $resourceArg->getResourceId());
+                $that->assertEquals('somePrivilege', $privilegeArg);
+                return false;
+            }
+        );
+
+        $acl->addRole('guest');
+        $acl->addResource('area1');
+        $acl->allow(null, null, null, $assert);
+        $this->assertFalse($acl->isAllowed('guest', 'area1', 'somePrivilege'));
+    }
+
+    /**
+     * Ensures assert method returns callback's function value
+     */
+    public function testAssertMethod()
+    {
+        $acl       = new Acl\Acl();
+        $roleGuest = new Acl\Role\GenericRole('guest');
+        $assertMock = function ($value) {
+            return function ($aclArg, $roleArg, $resourceArg, $privilegeArg) use ($value) {
+                return $value;
+            };
+        };
+        $acl->addRole($roleGuest);
+        $acl->allow($roleGuest, null, 'somePrivilege', new Acl\Assertion\CallbackAssertion($assertMock(true)));
+        $this->assertTrue($acl->isAllowed($roleGuest, null, 'somePrivilege'));
+        $acl->allow($roleGuest, null, 'somePrivilege', new Acl\Assertion\CallbackAssertion($assertMock(false)));
+        $this->assertFalse($acl->isAllowed($roleGuest, null, 'somePrivilege'));
+    }
+}