Add PHP 8 support

.gitignore

@@ -1,3 +1,5 @@
+/.phpcs-cache
+/.phpunit.result.cache
 /clover.xml
 /composer.lock
 /coveralls-upload.json

.travis.yml

@@ -6,30 +6,30 @@ cache:
 
 env:
   global:
-    - COMPOSER_ARGS="--no-interaction"
+    - COMPOSER_ARGS="--no-interaction --ignore-platform-reqs"
     - COVERAGE_DEPS="php-coveralls/php-coveralls"
 
 matrix:
   fast_finish: true
   include:
-    - php: 7.1
+    - php: 7.3
       env:
         - DEPS=lowest
-    - php: 7.1
+    - php: 7.3
       env:
         - DEPS=latest
-        - CS_CHECK=true
-        - TEST_COVERAGE=true
-    - php: 7.2
+    - php: 7.4
       env:
         - DEPS=lowest
-    - php: 7.2
+    - php: 7.4
       env:
         - DEPS=latest
-    - php: 7.3
+        - CS_CHECK=true
+        - TEST_COVERAGE=true
+    - php: nightly
       env:
         - DEPS=lowest
-    - php: 7.3
+    - php: nightly
       env:
         - DEPS=latest
 

composer.json

@@ -19,16 +19,14 @@
     "config": {
         "sort-packages": true
     },
-    "extra": {
-    },
     "require": {
-        "php": "^7.1",
+        "php": "^7.3 || ~8.0.0",
         "laminas/laminas-zendframework-bridge": "^1.0"
     },
     "require-dev": {
-        "laminas/laminas-coding-standard": "~1.0.0",
+        "laminas/laminas-coding-standard": "~2.1.0",
         "malukenho/docheader": "^0.1.6",
-        "phpunit/phpunit": "^7.0.2"
+        "phpunit/phpunit": "^9.3"
     },
     "suggest": {
         "mezzio/mezzio-laminasviewrenderer": "^2.0 to use the laminas-view PhpRenderer template renderer",

phpcs.xml

@@ -1,8 +1,20 @@
 <?xml version="1.0"?>
-<ruleset name="Laminas coding standard">
-    <rule ref="./vendor/laminas/laminas-coding-standard/ruleset.xml"/>
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">
+
+    <arg name="basepath" value="."/>
+    <arg name="cache" value=".phpcs-cache"/>
+    <arg name="colors"/>
+    <arg name="extensions" value="php"/>
+    <arg name="parallel" value="80"/>
+
+    <!-- Show progress -->
+    <arg value="p"/>
 
     <!-- Paths to check -->
     <file>src</file>
     <file>test</file>
+
+    <!-- Include all rules from the Laminas Coding Standard -->
+    <rule ref="LaminasCodingStandard"/>
 </ruleset>

phpunit.xml.dist

@@ -1,17 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
-         bootstrap="vendor/autoload.php"
-         colors="true">
-    <testsuites>
-        <testsuite name="Mezzio Tests">
-            <directory>./test</directory>
-        </testsuite>
-    </testsuites>
-
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">src</directory>
-        </whitelist>
-    </filter>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true">
+  <coverage processUncoveredFiles="true">
+    <include>
+      <directory suffix=".php">./src</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="mezzio-template">
+      <directory>./test</directory>
+    </testsuite>
+  </testsuites>
 </phpunit>

src/ArrayParametersTrait.php

@@ -12,7 +12,6 @@
 
 use Traversable;
 
-use function get_class;
 use function gettype;
 use function is_array;
 use function is_object;
@@ -36,9 +35,9 @@ trait ArrayParametersTrait
      * - scalar values result in an exception
      *
      * @param mixed $params
-     * @throws Exception\InvalidArgumentException for non-array, non-object parameters.
+     * @throws Exception\InvalidArgumentException
      */
-    private function normalizeParams($params) : array
+    private function normalizeParams($params): array
     {
         if (null === $params) {
             return [];
@@ -65,7 +64,7 @@ private function normalizeParams($params) : array
         throw new Exception\InvalidArgumentException(sprintf(
             '%s template adapter can only handle arrays, Traversables, and objects '
             . 'when rendering; received %s',
-            get_class($this),
+            static::class,
             gettype($params)
         ));
     }

src/DefaultParamsTrait.php

@@ -17,9 +17,7 @@
  */
 trait DefaultParamsTrait
 {
-    /**
-     * @var array
-     */
+    /** @var array */
     private $defaultParams = [];
 
     /**
@@ -39,10 +37,10 @@ trait DefaultParamsTrait
      * @param string $templateName Name of template to which the param applies;
      *     use TEMPLATE_ALL to apply to all templates.
      * @param string $param Param name.
-     * @param mixed $value
+     * @param mixed  $value
      * @throws Exception\InvalidArgumentException
      */
-    public function addDefaultParam(string $templateName, string $param, $value) : void
+    public function addDefaultParam(string $templateName, string $param, $value): void
     {
         if (! $templateName) {
             throw new Exception\InvalidArgumentException('$templateName must be a non-empty string');
@@ -62,9 +60,9 @@ public function addDefaultParam(string $templateName, string $param, $value) : v
     /**
      * Returns merged global, template-specific and given params
      */
-    private function mergeParams(string $template, array $params) : array
+    private function mergeParams(string $template, array $params): array
     {
-        $globalDefaults = $this->defaultParams[TemplateRendererInterface::TEMPLATE_ALL] ?? [];
+        $globalDefaults   = $this->defaultParams[TemplateRendererInterface::TEMPLATE_ALL] ?? [];
         $templateDefaults = $this->defaultParams[$template] ?? [];
 
         return array_replace_recursive($globalDefaults, $templateDefaults, $params);

src/Exception/InvalidArgumentException.php

@@ -10,6 +10,8 @@
 
 namespace Mezzio\Template\Exception;
 
-class InvalidArgumentException extends \InvalidArgumentException implements ExceptionInterface
+use InvalidArgumentException as SplInvalidArgumentException;
+
+class InvalidArgumentException extends SplInvalidArgumentException implements ExceptionInterface
 {
 }

src/TemplatePath.php

@@ -12,17 +12,13 @@
 
 class TemplatePath
 {
-    /**
-     * @var string
-     */
+    /** @var string */
     protected $path;
 
-    /**
-     * @var null|string
-     */
+    /** @var null|string */
     protected $namespace;
 
-    public function __construct(string $path, string $namespace = null)
+    public function __construct(string $path, ?string $namespace = null)
     {
         $this->path      = $path;
         $this->namespace = $namespace;
@@ -31,23 +27,23 @@ public function __construct(string $path, string $namespace = null)
     /**
      * Casts to string by returning the path only.
      */
-    public function __toString() : string
+    public function __toString(): string
     {
         return $this->path;
     }
 
     /**
      * Get the namespace
      */
-    public function getNamespace() : ?string
+    public function getNamespace(): ?string
     {
         return $this->namespace;
     }
 
     /**
      * Get the path
      */
-    public function getPath() : string
+    public function getPath(): string
     {
         return $this->path;
     }

src/TemplateRendererInterface.php

@@ -28,22 +28,22 @@ interface TemplateRendererInterface
      *
      * @param array|object $params
      */
-    public function render(string $name, $params = []) : string;
+    public function render(string $name, $params = []): string;
 
     /**
      * Add a template path to the engine.
      *
      * Adds a template path, with optional namespace the templates in that path
      * provide.
      */
-    public function addPath(string $path, string $namespace = null) : void;
+    public function addPath(string $path, ?string $namespace = null): void;
 
     /**
      * Retrieve configured paths from the engine.
      *
      * @return TemplatePath[]
      */
-    public function getPaths() : array;
+    public function getPaths(): array;
 
     /**
      * Add a default parameter to use with a template.
@@ -62,7 +62,7 @@ public function getPaths() : array;
      * @param string $templateName Name of template to which the param applies;
      *     use TEMPLATE_ALL to apply to all templates.
      * @param string $param Param name.
-     * @param mixed $value
+     * @param mixed  $value
      */
-    public function addDefaultParam(string $templateName, string $param, $value) : void;
+    public function addDefaultParam(string $templateName, string $param, $value): void;
 }

test/ArrayParametersTraitTest.php

@@ -19,7 +19,7 @@ class ArrayParametersTraitTest extends TestCase
     /** @var TestAsset\ArrayParameters */
     private $subject;
 
-    public function setUp()
+    protected function setUp(): void
     {
         $this->subject = new TestAsset\ArrayParameters();
     }
@@ -74,8 +74,7 @@ public function nonNullScalarParameters()
 
     /**
      * @dataProvider nonNullScalarParameters
-     *
-     * @param mixed $scalar
+     * @param mixed  $scalar
      * @param string $expectedString
      */
     public function testNonNullScalarsRaiseAnException($scalar, $expectedString)

test/DefaultParamsTraitTest.php

@@ -18,17 +18,13 @@
 
 class DefaultParamsTraitTest extends TestCase
 {
-    /**
-     * @var ArrayParameters
-     */
+    /** @var ArrayParameters */
     private $arrayParams;
 
-    /**
-     * @var DefaultParameters
-     */
+    /** @var DefaultParameters */
     private $defaultParams;
 
-    protected function setUp()
+    protected function setUp(): void
     {
         $this->arrayParams   = new ArrayParameters();
         $this->defaultParams = new DefaultParameters();

test/ExceptionTest.php

@@ -22,7 +22,7 @@
 
 class ExceptionTest extends TestCase
 {
-    public function exception() : Generator
+    public function exception(): Generator
     {
         $namespace = substr(ExceptionInterface::class, 0, strrpos(ExceptionInterface::class, '\\') + 1);
 
@@ -37,9 +37,9 @@ public function exception() : Generator
     /**
      * @dataProvider exception
      */
-    public function testExceptionIsInstanceOfExceptionInterface(string $exception) : void
+    public function testExceptionIsInstanceOfExceptionInterface(string $exception): void
     {
-        self::assertContains('Exception', $exception);
+        self::assertStringContainsString('Exception', $exception);
         self::assertTrue(is_a($exception, ExceptionInterface::class, true));
     }
 }

test/TemplatePathAssertionsTrait.php

@@ -17,19 +17,22 @@
 
 trait TemplatePathAssertionsTrait
 {
-    public function assertTemplatePath($path, TemplatePath $templatePath, $message = null)
+    /** @param mixed $path */
+    public function assertTemplatePath($path, TemplatePath $templatePath, ?string $message = null)
     {
         $message = $message ?: sprintf('Failed to assert TemplatePath contained path %s', $path);
         $this->assertEquals($path, $templatePath->getPath(), $message);
     }
 
-    public function assertTemplatePathString($path, TemplatePath $templatePath, $message = null)
+    /** @param mixed $path */
+    public function assertTemplatePathString($path, TemplatePath $templatePath, ?string $message = null)
     {
         $message = $message ?: sprintf('Failed to assert TemplatePath casts to string path %s', $path);
         $this->assertEquals($path, (string) $templatePath, $message);
     }
 
-    public function assertTemplatePathNamespace($namespace, TemplatePath $templatePath, $message = null)
+    /** @param mixed $namespace */
+    public function assertTemplatePathNamespace($namespace, TemplatePath $templatePath, ?string $message = null)
     {
         $message = $message ?: sprintf(
             'Failed to assert TemplatePath namespace matched %s',
@@ -38,16 +41,17 @@ public function assertTemplatePathNamespace($namespace, TemplatePath $templatePa
         $this->assertEquals($namespace, $templatePath->getNamespace(), $message);
     }
 
-    public function assertEmptyTemplatePathNamespace(TemplatePath $templatePath, $message = null)
+    public function assertEmptyTemplatePathNamespace(TemplatePath $templatePath, ?string $message = null)
     {
         $message = $message ?: 'Failed to assert TemplatePath namespace was empty';
         $this->assertEmpty($templatePath->getNamespace(), $message);
     }
 
-    public function assertEqualTemplatePath(TemplatePath $expected, TemplatePath $received, $message = null)
+    public function assertEqualTemplatePath(TemplatePath $expected, TemplatePath $received, ?string $message = null)
     {
         $message = $message ?: 'Failed to assert TemplatePaths are equal';
-        if ($expected->getPath() !== $received->getPath()
+        if (
+            $expected->getPath() !== $received->getPath()
             || $expected->getNamespace() !== $received->getNamespace()
         ) {
             $this->fail($message);

test/TestAsset/ArrayParameters.php

@@ -16,7 +16,8 @@ class ArrayParameters
 {
     use ArrayParametersTrait;
 
-    public function normalize($params)
+    /** @param mixed $params */
+    public function normalize($params): array
     {
         return $this->normalizeParams($params);
     }