FRW-7289 Fixed Development module dependency BC-break. (#10806)

FRW-7289 Fixed Development module dependency BC-break.

Author: yaroslav-spryker

composer.json

@@ -4,7 +4,7 @@
     "description": "Development module",
     "license": "proprietary",
     "require": {
-        "nette/di": "^2.4.7 || ^3.0.0",
+        "nette/di": "^2.4.7 || ^3.2.0",
         "php": ">=8.1",
         "phpmd/phpmd": "^2.0.0",
         "spryker/config": "^3.0.0",

phpstan.neon

@@ -9,7 +9,9 @@ parameters:
         - '#Call to an undefined method ReflectionType::getName\(\)#'
         - '#Call to function method_exists\(\) with Symfony\\Component\\Console\\Helper\\ProgressBar and ''maxSecondsBetweenRe…'' will always evaluate to false.#'
         - '#Call to an undefined method ReflectionType::isBuiltin\(\)#'
+        - '#Call to an undefined method Nette\\DI\\Config\\Adapter::dump\(\)#'
         - '#Comparison operation ">" between int<2, max> and 1 is always true.#'
+        - '#Instanceof between string and Nette\\DI\\Config\\Adapter will always evaluate to false.#'
         - '#Parameter \#1 \$[a-zA-Z]* of class ReflectionClass constructor expects class-string<T of object>\|T of object, string given.#'
         - '#Parameter \#1 \$callback of function spl_autoload_unregister expects callable\(\): mixed, array given.#'
         - '#Parameter \#1 \$callback of function spl_autoload_unregister expects callable\(\): mixed, non-empty-array given.#'

src/Spryker/Zed/Development/Business/DevelopmentBusinessFactory.php

@@ -189,6 +189,8 @@
 use Spryker\Zed\Development\Business\Phpstan\Config\PhpstanConfigFileFinderInterface;
 use Spryker\Zed\Development\Business\Phpstan\Config\PhpstanConfigFileManager;
 use Spryker\Zed\Development\Business\Phpstan\Config\PhpstanConfigFileManagerInterface;
+use Spryker\Zed\Development\Business\Phpstan\Config\PhpstanConfigFileSaver;
+use Spryker\Zed\Development\Business\Phpstan\Config\PhpstanConfigFileSaverInterface;
 use Spryker\Zed\Development\Business\Phpstan\PhpstanRunner;
 use Spryker\Zed\Development\Business\Propel\PropelAbstractClassValidator;
 use Spryker\Zed\Development\Business\Propel\PropelAbstractClassValidatorInterface;
@@ -2114,7 +2116,12 @@ protected function createPhpstanConfigFileFinder(): PhpstanConfigFileFinderInter
      */
     protected function createPhpstanConfigFileManager(): PhpstanConfigFileManagerInterface
     {
-        return new PhpstanConfigFileManager($this->getFilesystem(), $this->getConfig(), $this->getConfigLoader());
+        return new PhpstanConfigFileManager(
+            $this->getFilesystem(),
+            $this->getConfig(),
+            $this->getConfigLoader(),
+            $this->createPhpstanConfigFileSaver(),
+        );
     }
 
     /**
@@ -2176,4 +2183,22 @@ protected function createTargetDirectoryResolver(): TargetDirectoryResolver
             $this->getConfig(),
         );
     }
+
+    /**
+     * @return \Spryker\Zed\Development\Business\Phpstan\Config\PhpstanConfigFileSaverInterface
+     */
+    public function createPhpstanConfigFileSaver(): PhpstanConfigFileSaverInterface
+    {
+        return new PhpstanConfigFileSaver(
+            $this->getPhpstanFileAdapters(),
+        );
+    }
+
+    /**
+     * @return array<string, string>
+     */
+    public function getPhpstanFileAdapters(): array
+    {
+        return $this->getProvidedDependency(DevelopmentDependencyProvider::PHPSTAN_ADAPTERS);
+    }
 }

src/Spryker/Zed/Development/Business/Phpstan/Config/PhpstanConfigFileManager.php

@@ -16,28 +16,39 @@ class PhpstanConfigFileManager implements PhpstanConfigFileManagerInterface
     /**
      * @var \Symfony\Component\Filesystem\Filesystem
      */
-    protected $filesystem;
+    protected Filesystem $filesystem;
 
     /**
      * @var \Spryker\Zed\Development\DevelopmentConfig
      */
-    protected $config;
+    protected DevelopmentConfig $config;
 
     /**
      * @var \Nette\DI\Config\Loader
      */
-    protected $configLoader;
+    protected Loader $configLoader;
+
+    /**
+     * @var \Spryker\Zed\Development\Business\Phpstan\Config\PhpstanConfigFileSaverInterface
+     */
+    protected PhpstanConfigFileSaverInterface $phpstanConfigFileSaver;
 
     /**
      * @param \Symfony\Component\Filesystem\Filesystem $filesystem
      * @param \Spryker\Zed\Development\DevelopmentConfig $config
      * @param \Nette\DI\Config\Loader $configLoader
+     * @param \Spryker\Zed\Development\Business\Phpstan\Config\PhpstanConfigFileSaverInterface $phpstanConfigFileSaver
      */
-    public function __construct(Filesystem $filesystem, DevelopmentConfig $config, Loader $configLoader)
-    {
+    public function __construct(
+        Filesystem $filesystem,
+        DevelopmentConfig $config,
+        Loader $configLoader,
+        PhpstanConfigFileSaverInterface $phpstanConfigFileSaver
+    ) {
         $this->filesystem = $filesystem;
         $this->config = $config;
         $this->configLoader = $configLoader;
+        $this->phpstanConfigFileSaver = $phpstanConfigFileSaver;
     }
 
     /**
@@ -113,7 +124,10 @@ protected function saveConfig(string $newConfigFileName, array $mergedConfig): s
         }
 
         $newConfigFilePath = $directory . $newConfigFileName;
-        $this->configLoader->save($mergedConfig, $newConfigFilePath . $this->config->getPhpstanConfigFilename());
+        $this->phpstanConfigFileSaver->save(
+            $newConfigFilePath . $this->config->getPhpstanConfigFilename(),
+            $mergedConfig,
+        );
 
         return $newConfigFilePath;
     }

src/Spryker/Zed/Development/Business/Phpstan/Config/PhpstanConfigFileSaver.php

@@ -0,0 +1,77 @@
+<?php
+
+/**
+ * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
+ * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
+ */
+
+namespace Spryker\Zed\Development\Business\Phpstan\Config;
+
+use InvalidArgumentException;
+use Nette\DI\Config\Adapter;
+use RuntimeException;
+
+class PhpstanConfigFileSaver implements PhpstanConfigFileSaverInterface
+{
+    /**
+     * @var string
+     */
+    protected const ERROR_CANNOT_WRITE_FILE = "Cannot write file '%s'.";
+
+    /**
+     * @var string
+     */
+    protected const ERROR_UNKNOWN_FILE_EXTENSION = "Unknown file extension '%s'.";
+
+    /**
+     * @var array<string, string>
+     */
+    protected array $fileAdapters;
+
+    /**
+     * @param array<string, string> $fileAdapters
+     */
+    public function __construct(array $fileAdapters = [])
+    {
+        $this->fileAdapters = $fileAdapters;
+    }
+
+    /**
+     * @param string $configFilePath
+     * @param array<mixed> $data
+     *
+     * @throws \RuntimeException
+     *
+     * @return void
+     */
+    public function save(string $configFilePath, array $data): void
+    {
+        if (file_put_contents($configFilePath, $this->getAdapter($configFilePath)->dump($data)) === false) {
+            throw new RuntimeException(sprintf(static::ERROR_CANNOT_WRITE_FILE, $configFilePath));
+        }
+    }
+
+    /**
+     * @param string $filePath
+     *
+     * @throws \InvalidArgumentException
+     *
+     * @return \Nette\DI\Config\Adapter
+     */
+    protected function getAdapter(string $filePath): Adapter
+    {
+        $extension = strtolower(pathinfo($filePath, PATHINFO_EXTENSION));
+        if (!isset($this->fileAdapters[$extension])) {
+            throw new InvalidArgumentException(sprintf(static::ERROR_UNKNOWN_FILE_EXTENSION, $filePath));
+        }
+
+        if ($this->fileAdapters[$extension] instanceof Adapter) {
+            return $this->fileAdapters[$extension];
+        }
+
+        /** @var \Nette\DI\Config\Adapter $adapter */
+        $adapter = new $this->fileAdapters[$extension]();
+
+        return $adapter;
+    }
+}

src/Spryker/Zed/Development/Business/Phpstan/Config/PhpstanConfigFileSaverInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
+ * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
+ */
+
+namespace Spryker\Zed\Development\Business\Phpstan\Config;
+
+interface PhpstanConfigFileSaverInterface
+{
+    /**
+     * @param string $configFilePath
+     * @param array<mixed> $data
+     *
+     * @return void
+     */
+    public function save(string $configFilePath, array $data): void;
+}

src/Spryker/Zed/Development/DevelopmentDependencyProvider.php

@@ -7,6 +7,8 @@
 
 namespace Spryker\Zed\Development;
 
+use Nette\DI\Config\Adapters\NeonAdapter;
+use Nette\DI\Config\Adapters\PhpAdapter;
 use Nette\DI\Config\Loader;
 use Spryker\Zed\Development\Dependency\Facade\DevelopmentToModuleFinderFacadeBridge;
 use Spryker\Zed\Graph\Communication\Plugin\GraphPlugin;
@@ -57,6 +59,11 @@ class DevelopmentDependencyProvider extends AbstractBundleDependencyProvider
      */
     public const TWIG_LOADER_FILESYSTEM = 'twig loader filesystem';
 
+    /**
+     * @var string
+     */
+    public const PHPSTAN_ADAPTERS = 'PHPSTAN_ADAPTERS';
+
     /**
      * @param \Spryker\Zed\Kernel\Container $container
      *
@@ -89,6 +96,7 @@ public function provideBusinessLayerDependencies(Container $container)
         });
 
         $container = $this->addModuleFinderFacade($container);
+        $container = $this->addPhpstanAdapters($container);
 
         return $container;
     }
@@ -158,4 +166,21 @@ protected function addModuleFinderFacade(Container $container): Container
 
         return $container;
     }
+
+    /**
+     * @param \Spryker\Zed\Kernel\Container $container
+     *
+     * @return \Spryker\Zed\Kernel\Container
+     */
+    protected function addPhpstanAdapters(Container $container): Container
+    {
+        $container->set(static::PHPSTAN_ADAPTERS, function (Container $container) {
+            return [
+                'php' => PhpAdapter::class,
+                'neon' => NeonAdapter::class,
+            ];
+        });
+
+        return $container;
+    }
 }