Merge pull request #217 from laminas/renovate/lock-file-maintenance

Lock file maintenance, introduce test case for `templatemap_generator.php`

bin/templatemap_generator.php

@@ -1,7 +1,7 @@
 #!/usr/bin/env php
 <?php
 
-$help = <<< EOH
+$help = <<<'EOH'
 Generate template maps.
 
 Usage:
@@ -86,7 +86,7 @@
 }
 
 $basePath = $argv[1];
-$files = ($argc < 3)
+$files    = $argc < 3
     ? findTemplateFilesInTemplatePath($basePath)
     : array_slice($argv, 2);
 
@@ -99,14 +99,14 @@
 
 $realPath = realpath($basePath);
 
-$entries = array_map(function ($file) use ($basePath, $realPath) {
+$entries = array_map(function (string $file) use ($basePath, $realPath) {
     $file = str_replace('\\', '/', $file);
 
-    $template = (0 === strpos($file, $realPath))
+    $template = 0 === strpos($file, $realPath)
         ? substr($file, strlen($realPath))
         : $file;
 
-    $template = (0 === strpos($template, $basePath))
+    $template = 0 === strpos($template, $basePath)
         ? substr($template, strlen($basePath))
         : $template;
 
@@ -126,7 +126,8 @@
 exit(0);
 
 /**
- * @psalm-return list<mixed>
+ * @param string $templatePath
+ * @return list<string>
  */
 function findTemplateFilesInTemplatePath($templatePath): array
 {
@@ -138,7 +139,8 @@ function findTemplateFilesInTemplatePath($templatePath): array
 
     $files = [];
     foreach ($rii as $file) {
-        if (strtolower($file->getExtension()) != 'phtml') {
+        assert($file instanceof SplFileInfo);
+        if (strtolower($file->getExtension()) !== 'phtml') {
             continue;
         }
 

composer.json

@@ -37,9 +37,9 @@
         "psr/container": "^1 || ^2"
     },
     "require-dev": {
-        "laminas/laminas-authentication": "^2.13",
+        "laminas/laminas-authentication": "^2.15",
         "laminas/laminas-coding-standard": "~2.5.0",
-        "laminas/laminas-feed": "^2.20",
+        "laminas/laminas-feed": "^2.21",
         "laminas/laminas-filter": "^2.32",
         "laminas/laminas-http": "^2.18",
         "laminas/laminas-i18n": "^2.23",
@@ -52,9 +52,9 @@
         "laminas/laminas-permissions-acl": "^2.15",
         "laminas/laminas-router": "^3.11.1",
         "laminas/laminas-uri": "^2.10",
-        "phpunit/phpunit": "^10.1.3",
+        "phpunit/phpunit": "^10.3.2",
         "psalm/plugin-phpunit": "^0.18.4",
-        "vimeo/psalm": "^5.12"
+        "vimeo/psalm": "^5.15"
     },
     "conflict": {
         "container-interop/container-interop": "<1.2",

test/bin/TemplateMapGeneratorTest.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace LaminasTest\View\bin;
+
+use PHPUnit\Framework\TestCase;
+
+use function chdir;
+use function sprintf;
+
+use const PHP_EOL;
+
+final class TemplateMapGeneratorTest extends TestCase
+{
+    private function commandOutput(string $args): string
+    {
+        chdir(__DIR__);
+
+        $command = sprintf(__DIR__ . '/../../bin/templatemap_generator.php %s', $args);
+
+        /** @psalm-suppress ForbiddenCode */
+        $output  = `$command`; // phpcs:ignore
+
+        self::assertIsString($output);
+
+        return $output;
+    }
+
+    public function testThatTheTemplateMapGeneratorProducesTheExpectedOutput(): void
+    {
+        $output = $this->commandOutput('templates');
+
+        self::assertStringStartsWith('<?php' . PHP_EOL . 'return [', $output);
+        self::assertStringEndsWith('];', $output);
+        self::assertStringContainsString("'one' => __DIR__ . '/templates/one.phtml',", $output);
+        self::assertStringContainsString("'two' => __DIR__ . '/templates/two.phtml',", $output);
+
+        self::assertStringNotContainsString('ignored.txt', $output);
+        self::assertStringNotContainsString('ignored', $output);
+    }
+
+    public function testThatHelpTextWillBeOutputWhenRequested(): void
+    {
+        $output = $this->commandOutput('-h');
+        self::assertStringContainsString('Generate template maps.', $output);
+
+        $output = $this->commandOutput('--help');
+        self::assertStringContainsString('Generate template maps.', $output);
+    }
+
+    public function testThatTheMapGeneratorAcceptsAListOfFileNames(): void
+    {
+        $output = $this->commandOutput('. some/foo.txt bar.phtml');
+        self::assertStringStartsWith('<?php' . PHP_EOL . 'return [', $output);
+        self::assertStringEndsWith('];', $output);
+        self::assertStringContainsString("'some/foo' => __DIR__ . '/some/foo.txt',", $output);
+        self::assertStringContainsString("'bar' => __DIR__ . '/bar.phtml',", $output);
+    }
+}