Chore: Improvements

- Replaced json_decode with Symfony DecoderInterface;
- Tests fixes;
- Small psalm-type fixes;
- Added --show-info=true to psalm GitHub job;
- Fixed CI for installing php-cs-fixer;

Signed-off-by: Oleksii Bulba <[email protected]>

Author: OleksiiBulba

.github/workflows/static.yaml

@@ -42,7 +42,7 @@ jobs:
           tools: cs2pr
 
       - name: Install php-cs-fixer
-        uses: ramsey/composer-install@v1
+        uses: ramsey/composer-install@v2
 
       - name: PHP-CS-Fixer
         run: ./vendor/bin/php-cs-fixer fix --verbose --dry-run --format=checkstyle --using-cache=no | cs2pr
@@ -68,7 +68,7 @@ jobs:
         uses: ramsey/composer-install@v2
 
       - name: Psalm
-        run: ./vendor/bin/psalm --no-progress
+        run: ./vendor/bin/psalm --no-progress --show-info=true
 
   composer-normalize:
     name: Composer Normalize

composer.json

@@ -12,7 +12,8 @@
     ],
     "require": {
         "php": "^8.1 || ^8.2",
-        "micro/plugin-twig": "^0"
+        "micro/plugin-twig": "^0",
+        "symfony/serializer": "^6.2"
     },
     "require-dev": {
         "ergebnis/composer-normalize": "^2.29",

src/Asset/EntrypointLookup.php

@@ -13,15 +13,20 @@
 
 use Boo\WebpackEncorePlugin\Exception\EntrypointNotFoundException;
 use Boo\WebpackEncorePlugin\WebpackEncorePluginConfigurationInterface;
+use Symfony\Component\Serializer\Encoder\DecoderInterface;
+use Symfony\Component\Serializer\Encoder\JsonEncoder;
+use Symfony\Component\Serializer\Exception\UnexpectedValueException;
 
 class EntrypointLookup implements EntrypointLookupInterface
 {
-    private mixed $entriesData = null;
+    private ?array $entriesData = null;
 
     private array $returnedFiles = [];
 
-    public function __construct(private readonly WebpackEncorePluginConfigurationInterface $configuration)
-    {
+    public function __construct(
+        private readonly WebpackEncorePluginConfigurationInterface $configuration,
+        private readonly DecoderInterface $decoder
+    ) {
     }
 
     /**
@@ -51,6 +56,7 @@ private function getEntryFiles(string $entryName, string $key): array
     {
         $this->validateEntryName($entryName);
         $entriesData = $this->getEntriesData();
+        /** @var array $entryData */
         $entryData = $entriesData['entrypoints'][$entryName] ?? [];
 
         if (!isset($entryData[$key])) {
@@ -59,15 +65,17 @@ private function getEntryFiles(string $entryName, string $key): array
         }
 
         // make sure to not return the same file multiple times
+        /** @var array $entryFiles */
         $entryFiles = $entryData[$key];
         $newFiles = array_values(array_diff($entryFiles, $this->returnedFiles));
         $this->returnedFiles = array_merge($this->returnedFiles, $newFiles);
 
         return $newFiles;
     }
 
-    private function validateEntryName(string $entryName)
+    private function validateEntryName(string $entryName): void
     {
+        /** @var array<string, array> $entriesData */
         $entriesData = $this->getEntriesData();
         if (!isset($entriesData['entrypoints'][$entryName])) {
             if (false !== $dotPos = strrpos($entryName, '.')) {
@@ -92,7 +100,11 @@ private function getEntriesData(): array
             throw new \InvalidArgumentException(sprintf('Could not find the entrypoints file from Webpack: the file "%s" does not exist.', $this->getEntrypointJsonPath()));
         }
 
-        $this->entriesData = json_decode(file_get_contents($this->getEntrypointJsonPath()), true);
+        try {
+            $this->entriesData = $this->decoder->decode(file_get_contents($this->getEntrypointJsonPath()), JsonEncoder::FORMAT);
+        } catch (UnexpectedValueException $e) {
+            throw new \InvalidArgumentException(sprintf('There was a problem JSON decoding the "%s" file', $this->getEntrypointJsonPath()), 0, $e);
+        }
 
         if (null === $this->entriesData) {
             throw new \InvalidArgumentException(sprintf('There was a problem JSON decoding the "%s" file', $this->getEntrypointJsonPath()));

src/Asset/EntrypointLookupInterface.php

@@ -17,11 +17,15 @@ interface EntrypointLookupInterface
 {
     /**
      * @throws EntrypointNotFoundException if an entry name is passed that does not exist in entrypoints.json
+     *
+     * @psalm-return array<string>
      */
     public function getJavaScriptFiles(string $entryName): array;
 
     /**
      * @throws EntrypointNotFoundException if an entry name is passed that does not exist in entrypoints.json
+     *
+     * @psalm-return array<string>
      */
     public function getCssFiles(string $entryName): array;
 

src/TagRenderer/TagRenderer.php

@@ -70,9 +70,9 @@ private function convertArrayToAttributes(array $attributesMap): string
         });
 
         return implode(' ', array_map(
-            static function ($key, $value) {
+            static function ($key, string|null|bool $value) {
                 // allows for things like defer: true to only render "defer"
-                if (true === $value || null === $value) {
+                if (\is_bool($value) || null === $value) {
                     return $key;
                 }
 

src/WebpackEncorePlugin.php

@@ -19,9 +19,13 @@
 use Micro\Framework\Kernel\Plugin\ConfigurableInterface;
 use Micro\Framework\Kernel\Plugin\PluginConfigurationTrait;
 use Micro\Plugin\Twig\Plugin\TwigExtensionPluginInterface;
+use Symfony\Component\Serializer\Encoder\DecoderInterface;
+use Symfony\Component\Serializer\Encoder\JsonDecode;
 use Twig\Extension\ExtensionInterface;
 
 /**
+ * @psalm-suppress ImplementedReturnTypeMismatch
+ *
  * @method WebpackEncorePluginConfigurationInterface configuration()
  *
  * @codeCoverageIgnore
@@ -47,6 +51,11 @@ protected function createTagRenderer(): TagRendererInterface
 
     protected function createEntrypointLookup(): EntrypointLookupInterface
     {
-        return new EntrypointLookup($this->configuration());
+        return new EntrypointLookup($this->configuration(), $this->createDecoder());
+    }
+
+    protected function createDecoder(): DecoderInterface
+    {
+        return new JsonDecode([JsonDecode::ASSOCIATIVE => true]);
     }
 }

src/WebpackEncorePluginConfiguration.php

@@ -22,8 +22,8 @@ class WebpackEncorePluginConfiguration extends PluginConfiguration implements We
 
     public function getOutputPath(): string
     {
-        return $this->configuration->get(self::CFG_OUTPUT_PATH,
-            $this->configuration->get('BASE_PATH').'/public/build'
+        return (string) $this->configuration->get(self::CFG_OUTPUT_PATH,
+            ((string) $this->configuration->get('BASE_PATH')).'/public/build'
         );
     }
 }

tests/unit/Asset/EntrypointLookupTest.php

@@ -16,6 +16,7 @@
 use Boo\WebpackEncorePlugin\WebpackEncorePluginConfigurationInterface;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Serializer\Encoder\JsonDecode;
 
 /**
  * @covers \Boo\WebpackEncorePlugin\Asset\EntrypointLookup
@@ -33,7 +34,7 @@ protected function setUp(): void
             ->onlyMethods(['getOutputPath'])
             ->getMockForAbstractClass();
 
-        $this->model = new EntrypointLookup($this->configurationMock);
+        $this->model = new EntrypointLookup($this->configurationMock, new JsonDecode([JsonDecode::ASSOCIATIVE => true]));
     }
 
     /**