Rejig routes to separate "My Profile" page from ZfcUser/ScnSocialAuth

Author: adamlundrigan

config/application.config.php

@@ -5,13 +5,13 @@
     'modules' => [
         'ZF\DevelopmentMode',
         'AssetManager',
+        'EdpModuleLayouts',
         'ZfcBase',
         'ZfcUser',
         'ScnSocialAuth',
         'EdpGithub',
         'Application',
         'User',
-        'EdpModuleLayouts',
         'ZfModule',
     ],
     'module_listener_options' => [

config/autoload/global.php

@@ -1,7 +1,8 @@
 <?php
 return [
     'module_layouts' => [
-        'ZfcUser' => 'layout/layout-small-header.phtml',
+        'ZfcUser'  => 'layout/layout-small-header.phtml',
+        'User'     => 'layout/layout-small-header.phtml',
         'ZfModule' => 'layout/layout-small-header.phtml',
     ],
     'asset_manager' => [

config/autoload/zfcuser.global.php

@@ -142,7 +142,7 @@
      * Accepted values: A valid route name within your application
      *
      */
-    //'login_redirect_route' => 'zfcuser',
+    'login_redirect_route' => 'user',
 
     /**
      * Logout Redirect Route

module/Application/view/layout/layout-small-header.phtml

@@ -33,13 +33,13 @@
                         <li class="sep">|</li>
                         <li class="user-info">
                             <div class="gravatar-container"><a class="login" href="<?php
-                                echo $this->url('zfcuser');
+                                echo $this->url('user');
                                 ?>" title="My profile">
                                     <img src="<?php
                                     echo $this->escapeHtmlAttr($this->zfcUserIdentity()->getPhotoUrl());
                                     ?>" alt="<?php echo $this->escapeHtmlAttr($this->zfcUserDisplayName());
                                     ?>" style="width:23px;height:23px;" />
-                                </a></div><a class="login" href="<?php echo $this->url('zfcuser') ?>" title="My profile"> Hello <?php echo $this->escapeHtml(ucfirst($userDisplayName)); ?></a>
+                                </a></div><a class="login" href="<?php echo $this->url('user') ?>" title="My profile"> Hello <?php echo $this->escapeHtml(ucfirst($userDisplayName)); ?></a>
                         </li>
                         <li class="sep">|</li>
                         <li ><a href="<?php echo $this->url('zfcuser/logout'); ?>">Logout</a></li>

module/Application/view/layout/layout.phtml

@@ -35,12 +35,12 @@
                         ?>
                         <li class="sep">|</li>
                         <li class="user-info">
-                            <div class="gravatar-container"><a class="login" href="<?php echo $this->url('zfcuser') ?>" title="My profile">
+                            <div class="gravatar-container"><a class="login" href="<?php echo $this->url('user') ?>" title="My profile">
                                     <img src="<?php
                                     echo $this->escapeHtmlAttr($this->zfcUserIdentity()->getPhotoUrl());
                                     ?>" alt="<?php echo $this->escapeHtmlAttr($this->zfcUserDisplayName());
                                     ?>" style="width:23px;height:23px;" />
-                                </a></div><a class="login" href="<?php echo $this->url('zfcuser') ?>" title="My profile"> Hello <?php echo $this->escapeHtml(ucfirst($userDisplayName)) ?></a>
+                                </a></div><a class="login" href="<?php echo $this->url('user') ?>" title="My profile"> Hello <?php echo $this->escapeHtml(ucfirst($userDisplayName)) ?></a>
                         </li>
                         <li class="sep">|</li>
                         <li ><a href="<?php echo $this->url('zfcuser/logout') ?>">Logout</a></li>

module/User/config/module.config.php

@@ -16,9 +16,36 @@
             __DIR__ . '/../view',
         ],
     ],
+    'router' => [
+        'routes' => [
+            'zfcuser' => [
+                'options' => [
+                    'route' => '/auth',
+                ],
+            ],
+            'scn-social-auth-user' => [
+                'options' => [
+                    'route' => '/auth',
+                    'defaults' => [
+                        'controller' => 'User\Controller\Index',
+                    ],
+                ],
+            ],
+            'user' => [
+                'type' => 'Segment',
+                'options' => [
+                    'route' => '/user',
+                    'defaults' => [
+                        'controller' => 'User\Controller\Index',
+                        'action'     => 'index',
+                    ],
+                ],
+            ],
+        ],
+    ],
     'controllers' => [
         'invokables' => [
-            'User\Controller\Module' => 'User\Controller\ModuleController',
+            'User\Controller\Index' => 'User\Controller\IndexController',
         ],
     ],
     'view_helpers' => [

module/User/src/User/Controller/IndexController.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace User\Controller;
+
+use Zend\Mvc\Controller\AbstractActionController;
+use Zend\View\Model\ViewModel;
+
+class IndexController extends AbstractActionController
+{
+    public function indexAction()
+    {
+        $vm = new ViewModel();
+
+        return $vm;
+    }
+}

module/User/src/User/Controller/IndexControllerFactory.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace User\Controller;
+
+class IndexControllerFactory implements FactoryInterface
+{
+    /**
+     * @param ServiceLocatorInterface $controllerManager
+     * @return IndexController
+     */
+    public function createService(ServiceLocatorInterface $controllerManager)
+    {
+        return new IndexController();
+    }
+}

module/User/test/UserTest/Integration/Controller/IndexControllerTest.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace UserTest\Integration\Controller;
+
+use ApplicationTest\Integration\Util\Bootstrap;
+use User\Entity\User as UserEntity;
+use Zend\Http\Response as HttpResponse;
+use Zend\Test\PHPUnit\Controller\AbstractHttpControllerTestCase;
+
+class IndexControllerTest extends AbstractHttpControllerTestCase
+{
+    protected $viewHelperManager;
+
+    protected function setUp()
+    {
+        parent::setUp();
+        $this->setApplicationConfig(Bootstrap::getConfig());
+        $this->getApplicationServiceLocator()->setAllowOverride(true);
+
+        $mockTotalModules = $this->getMockBuilder('ZfModule\View\Helper\TotalModules')
+                                 ->disableOriginalConstructor()
+                                 ->getMock();
+
+        $mockListModule = $this->getMockBuilder('ZfModule\View\Helper\ListModule')
+                               ->disableOriginalConstructor()
+                               ->getMock();
+
+        $this->viewHelperManager = $this->getApplicationServiceLocator()->get('ViewHelperManager');
+        $this->viewHelperManager->setService('totalModules', $mockTotalModules);
+        $this->viewHelperManager->setService('listModule', $mockListModule);
+
+        $mockAuthService = $this->getMockBuilder('Zend\Authentication\AuthenticationService')
+                                ->disableOriginalConstructor()
+                                ->getMock();
+        $mockAuthService->expects($this->any())
+                        ->method('hasIdentity')
+                        ->will($this->returnValue(true));
+        $mockAuthService->expects($this->any())
+                        ->method('getIdentity')
+                        ->will($this->returnValue(new UserEntity()));
+
+        $this->getApplicationServiceLocator()->setService('zfcuser_auth_service', $mockAuthService);
+        $this->viewHelperManager->get('zfcUserIdentity')->setAuthService($mockAuthService);
+    }
+
+    public function testIndexActionCanBeAccessed()
+    {
+        $mockListModule = $this->viewHelperManager->get('listModule');
+        $mockListModule->expects($this->once())
+                       ->method('__invoke')
+                       ->will($this->returnValue([]));
+
+        $this->dispatch('/user');
+
+        $this->assertControllerName('User\Controller\Index');
+        $this->assertActionName('index');
+        $this->assertTemplateName('user/index/index');
+        $this->assertResponseStatusCode(HttpResponse::STATUS_CODE_200);
+    }
+}