Merge branch 'feature/62' into develop

Close #62

Author: weierophinney

CHANGELOG.md

@@ -8,23 +8,11 @@ All notable changes to this project will be documented in this file, in reverse
 
 - Nothing.
 
-### Deprecated
-
-- Nothing.
-
-### Removed
-
-- Nothing.
+### Changed
 
-### Fixed
-
-- Nothing.
-
-## 1.2.4 - TBD
-
-### Added
-
-- Nothing.
+- [#62](https://github.com/zfcampus/zf-apigility-documentation/pull/62) updates the `ZF\Apigility\Documentation\Controller` to accept a `BasePath`
+  view helper as a construction aregument; this is then used to prefix any generated links with
+  the currently detected/configured base path to the application.
 
 ### Deprecated
 

phpunit.xml.dist

@@ -4,4 +4,9 @@
             <directory>./test</directory>
         </testsuite>
     </testsuites>
+    <filter>
+        <whitelist>
+            <directory>src</directory>
+        </whitelist>
+    </filter>
 </phpunit>

src/Controller.php

@@ -7,6 +7,7 @@
 namespace ZF\Apigility\Documentation;
 
 use Zend\Mvc\Controller\AbstractActionController;
+use Zend\View\Helper\BasePath;
 use Zend\View\Helper\ServerUrl;
 use ZF\ContentNegotiation\ViewModel;
 
@@ -22,14 +23,21 @@ class Controller extends AbstractActionController
      */
     protected $serverUrlViewHelper;
 
+    /**
+     * @var BasePath|null
+     */
+    private $basePath;
+
     /**
      * @param ApiFactory $apiFactory
      * @param ServerUrl $serverUrlViewHelper
+     * @param BasePath $basePath
      */
-    public function __construct(ApiFactory $apiFactory, ServerUrl $serverUrlViewHelper)
+    public function __construct(ApiFactory $apiFactory, ServerUrl $serverUrlViewHelper, BasePath $basePath = null)
     {
         $this->apiFactory = $apiFactory;
         $this->serverUrlViewHelper = $serverUrlViewHelper;
+        $this->basePath = $basePath;
     }
 
     /**
@@ -42,13 +50,15 @@ public function __construct(ApiFactory $apiFactory, ServerUrl $serverUrlViewHelp
      */
     public function showAction()
     {
+        $basePath = $this->basePath ? $this->basePath->__invoke() : null;
+
         $apiName = $this->normalizeApiName($this->params()->fromRoute('api'));
         $apiVersion = $this->params()->fromRoute('version', '1');
         $serviceName = $this->params()->fromRoute('service');
 
         $viewModel = new ViewModel();
         $viewModel->setTemplate('zf-apigility-documentation/show');
-        $viewModel->setVariable('baseUrl', $this->serverUrlViewHelper->__invoke());
+        $viewModel->setVariable('baseUrl', $this->serverUrlViewHelper->__invoke($basePath));
 
         if (!$apiName) {
             $apiList = $this->apiFactory->createApiList();

src/ControllerFactory.php

@@ -21,9 +21,12 @@ class ControllerFactory implements FactoryInterface
      */
     public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
     {
+        $viewHelpers = $container->get('ViewHelperManager');
+
         return new Controller(
             $container->get(ApiFactory::class),
-            $container->get('ViewHelperManager')->get('ServerUrl')
+            $viewHelpers->get('ServerUrl'),
+            $viewHelpers->get('BasePath')
         );
     }
 

test/ControllerFactoryTest.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace ZFTest\Apigility\Documentation;
+
+use Zend\ServiceManager\ServiceManager;
+use Zend\View\Helper\BasePath;
+use Zend\View\Helper\ServerUrl;
+use ZF\Apigility\Documentation\ApiFactory;
+use ZF\Apigility\Documentation\Controller;
+use ZF\Apigility\Documentation\ControllerFactory;
+
+class ControllerFactoryTest extends \PHPUnit_Framework_TestCase
+{
+    public function testCreateController()
+    {
+        $apiFactory = $this->getMockBuilder(ApiFactory::class)->disableOriginalConstructor()->getMock();
+
+        $viewHelpers = new ServiceManager();
+        $viewHelpers->setService('ServerUrl', new ServerUrl());
+        $viewHelpers->setService('BasePath', new BasePath());
+
+        $container = new ServiceManager();
+        $container->setService('ViewHelperManager', $viewHelpers);
+        $container->setService(
+            ApiFactory::class,
+            $apiFactory
+        );
+
+        $controller = (new ControllerFactory())->createService($container);
+
+        self::assertInstanceOf(Controller::class, $controller);
+    }
+}

test/ControllerTest.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace ZFTest\Apigility\Documentation;
+
+use Zend\Mvc\MvcEvent;
+use Zend\View\Helper\BasePath;
+use Zend\View\Helper\ServerUrl;
+use Zend\View\Model\ModelInterface;
+use ZF\Apigility\Documentation\ApiFactory;
+use ZF\Apigility\Documentation\Controller;
+
+class ControllerTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var MvcEvent
+     */
+    private $event;
+
+    /**
+     * @var ServerUrl
+     */
+    private $serverUrl;
+
+    /**
+     * @var BasePath
+     */
+    private $basePath;
+
+    /**
+     * @var ApiFactory|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $apiFactory;
+
+    protected function setUp()
+    {
+        $this->apiFactory = $this->getMockBuilder(ApiFactory::class)->disableOriginalConstructor()->getMock();
+        $this->serverUrl = new ServerUrl();
+        $this->basePath = new BasePath();
+
+        $this->event = new MvcEvent();
+
+        if (class_exists('Zend\Router\RouteMatch', true)) {
+            $this->event->setRouteMatch(new \Zend\Router\RouteMatch([]));
+        } elseif (class_exists('Zend\Mvc\Router\RouteMatch', true)) {
+            $this->event->setRouteMatch(new \Zend\Mvc\Router\RouteMatch([]));
+        }
+    }
+
+    public function testViewModelMissingBasePath()
+    {
+        $this->serverUrl->setScheme('https');
+        $this->serverUrl->setHost('localhost');
+        $this->basePath->setBasePath('/controller_test');
+
+        $sut = new Controller($this->apiFactory, $this->serverUrl);
+        $sut->setEvent($this->event);
+
+        /** @var ModelInterface $viewModel */
+        $viewModel = $sut->showAction();
+        self::assertInstanceOf(ModelInterface::class, $viewModel);
+
+        self::assertEquals('https://localhost', $viewModel->getVariable('baseUrl'));
+    }
+
+    public function testSetBaseUrlIntoViewModel()
+    {
+        $this->serverUrl->setScheme('https');
+        $this->serverUrl->setHost('localhost');
+        $this->basePath->setBasePath('/controller_test');
+
+        $sut = new Controller($this->apiFactory, $this->serverUrl, $this->basePath);
+        $sut->setEvent($this->event);
+
+        /** @var ModelInterface $viewModel */
+        $viewModel = $sut->showAction();
+        self::assertInstanceOf(ModelInterface::class, $viewModel);
+
+        self::assertEquals('https://localhost/controller_test', $viewModel->getVariable('baseUrl'));
+    }
+}