Merge branch 'hotfix/zend-db-role-provider-sync-miles8of9'

bjyoungblood · Sep 20, 2013 · 8214a32 · 8214a32
2 parents cdfb409 + 06b1699
commit 8214a32
Show file tree

Hide file tree

Showing 17 changed files with 163 additions and 146 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -9,7 +9,6 @@ php:
 before_script:
   - composer self-update
   - composer update --prefer-source --dev
-  - wget http://cs.sensiolabs.org/get/php-cs-fixer.phar
 
 script:
   - ./vendor/bin/phpunit --coverage-clover ./build/logs/clover.xml

diff --git a/README.md b/README.md
@@ -107,9 +107,10 @@ return array(
             // this will load roles from the user_role table in a database
             // format: user_role(role_id(varchar), parent(varchar))
             'BjyAuthorize\Provider\Role\ZendDb' => array(
-                'table'             => 'user_role',
-                'role_id_field'     => 'role_id',
-                'parent_role_field' => 'parent',
+                'table'                 => 'user_role',
+                'identifier_field_name' => 'id',
+                'role_id_field'         => 'role_id',
+                'parent_role_field'     => 'parent_id',
             ),
 
             // this will load roles from

diff --git a/config/module.config.php b/config/module.config.php
@@ -79,6 +79,7 @@
                 => 'BjyAuthorize\Service\ZfcUserZendDbIdentityProviderServiceFactory',
             'BjyAuthorize\View\UnauthorizedStrategy'
                 => 'BjyAuthorize\Service\UnauthorizedStrategyServiceFactory',
+            'BjyAuthorize\Service\RoleDbTableGateway' => 'BjyAuthorize\Service\UserRoleServiceFactory',
         ),
         'invokables'  => array(
             'BjyAuthorize\View\RedirectionStrategy' => 'BjyAuthorize\View\RedirectionStrategy',

diff --git a/data/Role.php.dist b/data/Role.php.dist
@@ -31,13 +31,14 @@ class Role implements HierarchicalRoleInterface
 
     /**
      * @var string
-     * @ORM\Column(type="string", length=255, unique=true, nullable=true)
+     * @ORM\Column(type="string", name="role_id", length=255, unique=true, nullable=true)
      */
     protected $roleId;
 
     /**
      * @var Role
      * @ORM\ManyToOne(targetEntity="MyNamespace\Role")
+     * @ORM\JoinColumn(name="parent_id", referencedColumnName="id", nullable=true)
      */
     protected $parent;
 

diff --git a/data/schema.sql b/data/schema.sql
@@ -1,14 +1,20 @@
-CREATE TABLE IF NOT EXISTS `user_role` (
-  `id` int(11) NOT NULL AUTO_INCREMENT,
-  `roleId` varchar(255) NOT NULL,
-  `is_default` tinyint(1) NOT NULL,
-  `parent_id` int(11) DEFAULT NULL,
-  PRIMARY KEY (`id`)
-) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+CREATE  TABLE IF NOT EXISTS `user_role` (
+  `id` INT(11) NOT NULL AUTO_INCREMENT,
+  `role_id` VARCHAR(255) NOT NULL,
+  `is_default` TINYINT(1) NOT NULL DEFAULT 0,
+  `parent_id` INT(11) NULL,
+  PRIMARY KEY (`id`),
+  UNIQUE INDEX `unique_role` (`role_id` ASC),
+  INDEX `idx_parent_id` (`parent_id` ASC),
+  CONSTRAINT `fk_parent_id` FOREIGN KEY (`parent_id`) REFERENCES `user_role` (`id`) ON DELETE SET NULL
+) ENGINE = InnoDB DEFAULT CHARACTER SET = utf8 COLLATE = utf8_unicode_ci;
 
-CREATE TABLE IF NOT EXISTS `user_role_linker` (
-  `user_id` int(11) unsigned NOT NULL,
-  `role_id` int(11) NOT NULL,
-  PRIMARY KEY (`user_id`,`role_id`),
-  KEY `role_id` (`role_id`)
-) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+CREATE  TABLE IF NOT EXISTS `user_role_linker` (
+  `user_id` INT UNSIGNED NOT NULL,
+  `role_id` INT(11) NOT NULL,
+  PRIMARY KEY (`user_id`, `role_id`),
+  INDEX `idx_role_id` (`role_id` ASC),
+  INDEX `idx_user_id` (`user_id` ASC),
+  CONSTRAINT `fk_role_id` FOREIGN KEY (`role_id`) REFERENCES `user_role` (`id`) ON DELETE CASCADE,
+  CONSTRAINT `fk_user_id` FOREIGN KEY (`user_id`) REFERENCES `user` (`user_id`) ON DELETE CASCADE
+) ENGINE = InnoDB DEFAULT CHARACTER SET = utf8 COLLATE = utf8_unicode_ci;
diff --git a/data/schema.sqlite.sql b/data/schema.sqlite.sql
diff --git a/src/BjyAuthorize/Guard/Controller.php b/src/BjyAuthorize/Guard/Controller.php
@@ -15,8 +15,6 @@
 use Zend\EventManager\EventManagerInterface;
 use Zend\Mvc\MvcEvent;
 use Zend\ServiceManager\ServiceLocatorInterface;
-use Zend\Mvc\ApplicationInterface;
-use BjyAuthorize\Service\Authorize;
 use Zend\Http\Request as HttpRequest;
 
 /**

diff --git a/src/BjyAuthorize/Module.php b/src/BjyAuthorize/Module.php
@@ -14,7 +14,6 @@
 use Zend\ModuleManager\Feature\ConfigProviderInterface;
 use Zend\ModuleManager\Feature\ControllerPluginProviderInterface;
 use Zend\ModuleManager\Feature\ViewHelperProviderInterface;
-use Zend\Mvc\ApplicationInterface;
 use Zend\ServiceManager\AbstractPluginManager;
 
 /**

diff --git a/src/BjyAuthorize/Provider/Identity/ZfcUserZendDb.php b/src/BjyAuthorize/Provider/Identity/ZfcUserZendDb.php
@@ -9,9 +9,8 @@
 namespace BjyAuthorize\Provider\Identity;
 
 use BjyAuthorize\Exception\InvalidRoleException;
-use Zend\Db\Adapter\Adapter;
-use Zend\Db\Sql\Where;
-use Zend\Db\Sql\Sql;
+use Zend\Db\TableGateway\TableGateway;
+use Zend\Db\Sql\Select;
 use Zend\Permissions\Acl\Role\RoleInterface;
 use ZfcUser\Service\User;
 
@@ -38,13 +37,18 @@ class ZfcUserZendDb implements ProviderInterface
     protected $tableName = 'user_role_linker';
 
     /**
-     * @param \Zend\Db\Adapter\Adapter $adapter
-     * @param \ZfcUser\Service\User    $userService
+     * @var \Zend\Db\TableGateway\TableGateway
      */
-    public function __construct(Adapter $adapter, User $userService)
+    private $tableGateway;
+
+    /**
+     * @param \Zend\Db\TableGateway\TableGateway $tableGateway
+     * @param \ZfcUser\Service\User              $userService
+     */
+    public function __construct(TableGateway $tableGateway, User $userService)
     {
-        $this->adapter     = $adapter;
-        $this->userService = $userService;
+        $this->tableGateway = $tableGateway;
+        $this->userService  = $userService;
     }
 
     /**
@@ -59,17 +63,19 @@ public function getIdentityRoles()
         }
 
         // get roles associated with the logged in user
-        $sql    = new Sql($this->adapter);
-        $select = $sql->select()->from($this->tableName);
-        $where  = new Where();
+        $sql = new Select();
+
+        $sql->from($this->tableName);
+        // @todo these fields should eventually be configurable
+        $sql->join('user_role', 'user_role.id = ' . $this->tableName . '.role_id');
+        $sql->where(array('user_id' => $authService->getIdentity()->getId()));
 
-        $where->equalTo('user_id', $authService->getIdentity()->getId());
+        $results = $this->tableGateway->selectWith($sql);
 
-        $results = $sql->prepareStatementForSqlObject($select->where($where))->execute();
-        $roles     = array();
+        $roles = array();
 
-        foreach ($results as $i) {
-            $roles[] = $i['role_id'];
+        foreach ($results as $role) {
+            $roles[] = $role['role_id'];
         }
 
         return $roles;

diff --git a/src/BjyAuthorize/Provider/Role/ZendDb.php b/src/BjyAuthorize/Provider/Role/ZendDb.php
@@ -9,7 +9,6 @@
 namespace BjyAuthorize\Provider\Role;
 
 use BjyAuthorize\Acl\Role;
-use Zend\Db\TableGateway\TableGateway;
 use Zend\Db\Sql\Select;
 use Zend\ServiceManager\ServiceLocatorInterface;
 
@@ -28,22 +27,22 @@ class ZendDb implements ProviderInterface
     /**
      * @var string
      */
-    protected $adapterName         = 'bjyauthorize_zend_db_adapter';
+    protected $tableName = 'user_role';
 
     /**
      * @var string
      */
-    protected $tableName           = 'user_role';
+    protected $identifierFieldName = 'id';
 
     /**
      * @var string
      */
-    protected $roleIdFieldName     = 'role_id';
+    protected $roleIdFieldName = 'role_id';
 
     /**
      * @var string
      */
-    protected $parentRoleFieldName = 'parent';
+    protected $parentRoleFieldName = 'parent_id';
 
     /**
      * @param                         $options
@@ -53,14 +52,14 @@ public function __construct($options, ServiceLocatorInterface $serviceLocator)
     {
         $this->serviceLocator = $serviceLocator;
 
-        if (isset($options['adapter'])) {
-            $this->adapterName = $options['adapter'];
-        }
-
         if (isset($options['table'])) {
             $this->tableName = $options['table'];
         }
 
+        if (isset($options['identifier_field_name'])) {
+            $this->identifierFieldName = $options['identifier_field_name'];
+        }
+
         if (isset($options['role_id_field'])) {
             $this->roleIdFieldName = $options['role_id_field'];
         }
@@ -75,29 +74,36 @@ public function __construct($options, ServiceLocatorInterface $serviceLocator)
      */
     public function getRoles()
     {
-        /* @var $adapter \Zend\Db\Adapter\Adapter */
-        $adapter      = $this->serviceLocator->get($this->adapterName);
-        $tableGateway = new TableGateway($this->tableName, $adapter);
-        $sql          = new Select;
+        /* @var $tableGateway \Zend\Db\TableGateway\TableGateway */
+        $tableGateway = $this->serviceLocator->get('BjyAuthorize\Service\RoleDbTableGateway');
+        $sql          = new Select();
 
         $sql->from($this->tableName);
 
-        $rowset = $tableGateway->selectWith($sql);
-        $roles  = array();
+        /* @var $roles Role[] */
+        $roles       = array();
+        $indexedRows = array();
+        $rowset      = $tableGateway->selectWith($sql);
 
-        // Pass One: Build each object
+        // Pass 1: collect all rows and index them by PK
         foreach ($rowset as $row) {
-            $roleId = $row[$this->roleIdFieldName];
-            $roles[$roleId] = new Role($roleId, $row[$this->parentRoleFieldName]);
+            $indexedRows[$row[$this->identifierFieldName]] = $row;
+        }
+
+        // Pass 2: build a role for each indexed row
+        foreach ($indexedRows as $row) {
+            $parentRoleId   = isset($row[$this->parentRoleFieldName])
+                ? $indexedRows[$row[$this->parentRoleFieldName]][$this->roleIdFieldName] : null;
+            $roleId         = $row[$this->roleIdFieldName];
+            $roles[$roleId] = new Role($roleId, $parentRoleId);
         }
 
-        // Pass Two: Re-inject parent objects to preserve hierarchy
-        /* @var $roleObj Role */
-        foreach ($roles as $roleObj) {
-            $parentRoleObj = $roleObj->getParent();
+        // Pass 3: Re-inject parent objects to preserve hierarchy
+        foreach ($roles as $role) {
+            $parentRoleObj = $role->getParent();
 
-            if ($parentRoleObj && $parentRoleObj->getRoleId()) {
-                $roleObj->setParent($roles[$parentRoleObj->getRoleId()]);
+            if ($parentRoleObj && ($parentRoleId = $parentRoleObj->getRoleId())) {
+                $role->setParent($roles[$parentRoleId]);
             }
         }
 

diff --git a/src/BjyAuthorize/Service/AuthorizeAwareServiceInitializer.php b/src/BjyAuthorize/Service/AuthorizeAwareServiceInitializer.php
@@ -10,7 +10,6 @@
 
 namespace BjyAuthorize\Service;
 
-use BjyAuthorize\Service\AuthorizeAwareInterface;
 use Zend\ServiceManager\InitializerInterface;
 use Zend\ServiceManager\ServiceLocatorInterface;
 

diff --git a/src/BjyAuthorize/Service/UserRoleServiceFactory.php b/src/BjyAuthorize/Service/UserRoleServiceFactory.php
@@ -0,0 +1,31 @@
+<?php
+/**
+ * BjyAuthorize Module (https://github.com/bjyoungblood/BjyAuthorize)
+ *
+ * @link https://github.com/bjyoungblood/BjyAuthorize for the canonical source repository
+ * @license http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace BjyAuthorize\Service;
+
+use Zend\ServiceManager\FactoryInterface;
+use Zend\ServiceManager\ServiceLocatorInterface;
+use Zend\Db\TableGateway\TableGateway;
+
+/**
+ * @author Simone Castellaneta <[email protected]>
+ * 
+ * @return \Zend\Db\TableGateway\TableGateway
+ */
+class UserRoleServiceFactory implements FactoryInterface
+{
+    /**
+     * {@inheritDoc}
+     * 
+     * @return \Zend\Db\TableGateway\TableGateway
+     */
+    public function createService(ServiceLocatorInterface $serviceLocator)
+    {
+        return new TableGateway('user_role', $serviceLocator->get('bjyauthorize_zend_db_adapter'));
+    }
+}
diff --git a/src/BjyAuthorize/Service/ZfcUserZendDbIdentityProviderServiceFactory.php b/src/BjyAuthorize/Service/ZfcUserZendDbIdentityProviderServiceFactory.php
@@ -10,6 +10,7 @@
 
 use BjyAuthorize\Provider\Identity\ZfcUserZendDb;
 use Zend\ServiceManager\FactoryInterface;
+use Zend\Db\TableGateway\TableGateway;
 use Zend\ServiceManager\ServiceLocatorInterface;
 
 /**
@@ -26,13 +27,13 @@ class ZfcUserZendDbIdentityProviderServiceFactory implements FactoryInterface
      */
     public function createService(ServiceLocatorInterface $serviceLocator)
     {
-        /* @var $adapter \Zend\Db\Adapter\Adapter */
-        $adapter     = $serviceLocator->get('zfcuser_zend_db_adapter');
+        /* @var $tableGateway \Zend\Db\TableGateway\TableGateway */
+        $tableGateway = new TableGateway('user_role_linker', $serviceLocator->get('zfcuser_zend_db_adapter'));
         /* @var $userService \ZfcUser\Service\User */
         $userService = $serviceLocator->get('zfcuser_user_service');
         $config      = $serviceLocator->get('BjyAuthorize\Config');
 
-        $provider = new ZfcUserZendDb($adapter, $userService);
+        $provider = new ZfcUserZendDb($tableGateway, $userService);
 
         $provider->setDefaultRole($config['default_role']);
 

diff --git a/tests/BjyAuthorizeTest/Provider/Identity/ZfcUserZendDbTest.php b/tests/BjyAuthorizeTest/Provider/Identity/ZfcUserZendDbTest.php
@@ -29,9 +29,9 @@ class ZfcUserZendDbTest extends PHPUnit_Framework_TestCase
     protected $userService;
 
     /**
-     * @var \Zend\Db\Adapter\Adapter|\PHPUnit_Framework_MockObject_MockObject
+     * @var \Zend\Db\TableGateway\TableGateway|\PHPUnit_Framework_MockObject_MockObject
      */
-    protected $adapter;
+    private $tableGateway;
 
     /**
      * @var \BjyAuthorize\Provider\Identity\ZfcUserZendDb
@@ -45,17 +45,17 @@ class ZfcUserZendDbTest extends PHPUnit_Framework_TestCase
      */
     public function setUp()
     {
-        $this->authService = $this->getMock('Zend\Authentication\AuthenticationService');
-        $this->userService = $this->getMock('ZfcUser\Service\User');
-        $this->adapter     = $this->getMock('Zend\Db\Adapter\Adapter', array(), array(), '', false);
+        $this->authService  = $this->getMock('Zend\Authentication\AuthenticationService');
+        $this->userService  = $this->getMock('ZfcUser\Service\User');
+        $this->tableGateway = $this->getMock('Zend\Db\TableGateway\TableGateway', array(), array(), '', false);
 
         $this
             ->userService
             ->expects($this->any())
             ->method('getAuthService')
             ->will($this->returnValue($this->authService));
 
-        $this->provider = new ZfcUserZendDb($this->adapter, $this->userService);
+        $this->provider = new ZfcUserZendDb($this->tableGateway, $this->userService);
     }
 
     /**
@@ -90,6 +90,7 @@ public function testSetGetDefaultRole()
      */
     public function testGetIdentityRoles()
     {
-        $this->markTestIncomplete();
+        $roles = $this->provider->getIdentityRoles();
+        $this->assertEquals($roles, array(null));
     }
 }