Merge pull request #176 from laminas/2.23.x-merge-up-into-3.0.x_WZrNdKUo

Merge release 2.23.0 into 3.0.x

Author: Ocramius

psalm-baseline.xml

@@ -618,9 +618,15 @@
     </PropertyNotSetInConstructor>
   </file>
   <file src="src/Helper/Layout.php">
+    <PossiblyNullReference occurrences="1">
+      <code>plugin</code>
+    </PossiblyNullReference>
     <RedundantCastGivenDocblockType occurrences="1">
       <code>(string) $template</code>
     </RedundantCastGivenDocblockType>
+    <UndefinedInterfaceMethod occurrences="1">
+      <code>plugin</code>
+    </UndefinedInterfaceMethod>
   </file>
   <file src="src/Helper/Navigation.php">
     <InvalidFunctionCall occurrences="1">

src/Helper/BasePath.php

@@ -4,43 +4,55 @@
 
 namespace Laminas\View\Helper;
 
-use Laminas\View\Exception;
+use Laminas\View\Exception\RuntimeException;
 
 use function ltrim;
 use function rtrim;
+use function sprintf;
 
 /**
  * Helper for retrieving the base path.
+ *
+ * @final
  */
 class BasePath extends AbstractHelper
 {
-    /**
-     * Base path
-     *
-     * @var string
-     */
+    use DeprecatedAbstractHelperHierarchyTrait;
+
+    /** @var string|null */
     protected $basePath;
 
+    public function __construct(?string $basePath = null)
+    {
+        if ($basePath !== null) {
+            $this->setBasePath($basePath);
+        }
+    }
+
     /**
      * Returns site's base path, or file with base path prepended.
      *
      * $file is appended to the base path for simplicity.
      *
      * @param  string|null $file
-     * @throws Exception\RuntimeException
+     * @throws RuntimeException
      * @return string
      */
     public function __invoke($file = null)
     {
-        if (null === $this->basePath) {
-            throw new Exception\RuntimeException('No base path provided');
+        if ($this->basePath === null) {
+            throw new RuntimeException('No base path provided');
         }
 
-        if (null !== $file) {
-            $file = '/' . ltrim($file, '/');
+        if ($file !== null && $file !== '') {
+            return sprintf(
+                '%s/%s',
+                $this->basePath,
+                ltrim($file, '/')
+            );
         }
 
-        return $this->basePath . $file;
+        return $this->basePath;
     }
 
     /**

src/Helper/Layout.php

@@ -6,7 +6,6 @@
 
 use Laminas\View\Exception;
 use Laminas\View\Model\ModelInterface as Model;
-use Laminas\View\Renderer\PhpRenderer;
 
 use function assert;
 use function sprintf;
@@ -99,12 +98,8 @@ public function setTemplate($template)
     protected function getViewModelHelper()
     {
         if (! $this->viewModelHelper) {
-            /**
-             * @psalm-suppress DeprecatedMethod
-             */
             $renderer = $this->getView();
-            assert($renderer instanceof PhpRenderer);
-            $helper = $renderer->plugin('view_model');
+            $helper   = $renderer->plugin('view_model');
             assert($helper instanceof ViewModel);
             $this->viewModelHelper = $helper;
         }

src/Helper/Service/BasePathFactory.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Laminas\View\Helper\Service;
+
+use ArrayAccess;
+use Laminas\View\Helper\BasePath;
+use Psr\Container\ContainerInterface;
+
+use function assert;
+use function is_array;
+use function is_string;
+
+final class BasePathFactory
+{
+    public function __invoke(ContainerInterface $container): BasePath
+    {
+        $config = $container->has('config')
+            ? $container->get('config')
+            : [];
+
+        assert(is_array($config) || $config instanceof ArrayAccess);
+
+        // The expected location in config for the base path in an MVC application
+        // is config.view_manager.base_path
+        // @link https://docs.laminas.dev/laminas-mvc/services/#viewmanager
+
+        $viewConfig = $config['view_manager'] ?? [];
+        assert(is_array($viewConfig));
+
+        $basePath = $viewConfig['base_path'] ?? null;
+        assert(is_string($basePath) || $basePath === null);
+
+        return new BasePath($basePath);
+    }
+}

src/HelperPluginManager.php

@@ -160,7 +160,7 @@ class HelperPluginManager extends AbstractPluginManager
         Helper\Asset::class          => Helper\Service\AssetFactory::class,
         Helper\HtmlAttributes::class => Helper\Service\HtmlAttributesFactory::class,
         Helper\Identity::class       => Helper\Service\IdentityFactory::class,
-        Helper\BasePath::class       => InvokableFactory::class,
+        Helper\BasePath::class       => Helper\Service\BasePathFactory::class,
         Helper\Cycle::class          => InvokableFactory::class,
         Helper\DeclareVars::class    => InvokableFactory::class,
         // overridden in ViewHelperManagerFactory

test/Helper/BasePathTest.php

@@ -4,40 +4,53 @@
 
 namespace LaminasTest\View\Helper;
 
+use Laminas\View\Exception\RuntimeException;
 use Laminas\View\Helper\BasePath;
 use PHPUnit\Framework\TestCase;
 
 class BasePathTest extends TestCase
 {
-    public function testBasePathWithoutFile(): void
+    /** @return array<array-key, array{0: string, 1: string|null, 2: string}> */
+    public function basePathDataProvider(): array
     {
-        $helper = new BasePath();
-        $helper->setBasePath('/foo');
-
-        $this->assertEquals('/foo', $helper());
+        return [
+            ['/foo', null, '/foo'],
+            ['/foo', 'bar', '/foo/bar'],
+            ['/foo', 'bar/', '/foo/bar/'],
+            ['/foo', '/bar/', '/foo/bar/'],
+            ['/foo/', null, '/foo'],
+            ['/foo/', 'bar', '/foo/bar'],
+            ['/foo/', 'bar/', '/foo/bar/'],
+            ['/foo/', '/bar/', '/foo/bar/'],
+            ['/foo//', '//bar', '/foo/bar'],
+            ['', null, ''],
+            ['', '', ''],
+            ['', 'bar', '/bar'],
+            ['', 'bar/', '/bar/'],
+            ['', '/bar/', '/bar/'],
+            ['', '//bar', '/bar'],
+        ];
     }
 
-    public function testBasePathWithFile(): void
+    /** @dataProvider basePathDataProvider */
+    public function testBasePathHelperYieldsExpectedOutput(string $basePath, ?string $argument, string $expect): void
     {
-        $helper = new BasePath();
-        $helper->setBasePath('/foo');
-
-        $this->assertEquals('/foo/bar', $helper('bar'));
+        $helper = new BasePath($basePath);
+        self::assertEquals($expect, $helper->__invoke($argument));
     }
 
-    public function testBasePathNoDoubleSlashes(): void
+    public function testThatAnExceptionIsThrownWhenTheBasePathIsNull(): void
     {
-        $helper = new BasePath();
-        $helper->setBasePath('/');
-
-        $this->assertEquals('/', $helper('/'));
+        $helper = new BasePath(null);
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('No base path provided');
+        $helper->__invoke();
     }
 
-    public function testBasePathWithFilePrefixedBySlash(): void
+    public function testThatTheBasePathCanBeChanged(): void
     {
-        $helper = new BasePath();
-        $helper->setBasePath('/foo');
-
-        $this->assertEquals('/foo/bar', $helper('/bar'));
+        $helper = new BasePath(null);
+        $helper->setBasePath('something');
+        self::assertEquals('something/else', $helper->__invoke('else'));
     }
 }

test/Helper/Service/BasePathFactoryTest.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LaminasTest\View\Helper\Service;
+
+use Laminas\ServiceManager\ServiceManager;
+use Laminas\View\Helper\BasePath;
+use Laminas\View\Helper\Service\BasePathFactory;
+use Laminas\View\HelperPluginManager;
+use PHPUnit\Framework\TestCase;
+
+class BasePathFactoryTest extends TestCase
+{
+    private ServiceManager $container;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->container = new ServiceManager();
+    }
+
+    /** @return array<string, array{0: array}> */
+    public function configDataProvider(): array
+    {
+        return [
+            'Empty Config'             => [[]],
+            'Base Path Config Missing' => [['view_manager' => []]],
+            'Base Path Config Null'    => [['view_manager' => ['base_path' => null]]],
+            'Base Path Config Set'     => [['view_manager' => ['base_path' => '/foo']]],
+        ];
+    }
+
+    /** @dataProvider configDataProvider */
+    public function testFactoryWithVariousConfigurationSetups(array $config): void
+    {
+        $this->container->setService('config', $config);
+
+        $helper = (new BasePathFactory())($this->container);
+        self::assertInstanceOf(BasePath::class, $helper);
+    }
+
+    public function testHelperWillBeReturnedWhenThereIsNoConfigurationAtAll(): void
+    {
+        self::assertFalse($this->container->has('config'));
+        $helper = (new BasePathFactory())($this->container);
+        self::assertInstanceOf(BasePath::class, $helper);
+    }
+
+    public function testThatTheBasePathFactoryIsWiredUpByDefault(): void
+    {
+        $manager = new HelperPluginManager(new ServiceManager());
+        self::assertInstanceOf(BasePath::class, $manager->get(BasePath::class));
+    }
+}