From 4736254ec5e277c652e6922cddfd25f29f37fb90 Mon Sep 17 00:00:00 2001
From: Sebastian Schreiber <me@schreibersebastian.de>
Date: Thu, 18 Apr 2024 08:37:49 +0200
Subject: [PATCH] [TASK] Streamline folder and files naming

---
 .phpstorm.meta.php                            |  8 +++++
 fractor/config/application.php                |  8 ++---
 .../AllowedFileExtensionsResolver.php         | 30 +++++++++++++++++
 .../Configuration/ConfigurationFactory.php    | 23 +++++++++++++
 fractor/src/Factory/ConfigurationFactory.php  | 33 -------------------
 .../AllowedFileExtensionsResolverTest.php     | 26 +++++++++++++++
 .../config/config.php                         | 14 ++++++++
 fractor/tests/FileSystem/FileFinderTest.php   |  4 +--
 .../DirectorToSearchIn/my_empty_file.txt      |  0
 .../DirectorToSearchIn/my_file.txt            |  0
 .../DirectorToSearchIn/my_file.yaml           |  0
 .../DirectorToSearchIn/my_json.json           |  0
 .../DirectorToSearchIn/my_txt.yaml            |  0
 .../FractorRunner/FractorRunnerTest.php       |  2 +-
 .../config/{application.php => config.php}    |  0
 .../AddRenderTypeToFlexFormFractorTest.php    |  2 +-
 .../config/{application.php => config.php}    |  0
 17 files changed, 109 insertions(+), 41 deletions(-)
 create mode 100644 .phpstorm.meta.php
 create mode 100644 fractor/src/Configuration/AllowedFileExtensionsResolver.php
 create mode 100644 fractor/src/Configuration/ConfigurationFactory.php
 delete mode 100644 fractor/src/Factory/ConfigurationFactory.php
 create mode 100644 fractor/tests/Configuration/AllowedFileExtensionsResolver/AllowedFileExtensionsResolverTest.php
 create mode 100644 fractor/tests/Configuration/AllowedFileExtensionsResolver/config/config.php
 rename fractor/tests/FileSystem/{Fixture => Fixtures}/DirectorToSearchIn/my_empty_file.txt (100%)
 rename fractor/tests/FileSystem/{Fixture => Fixtures}/DirectorToSearchIn/my_file.txt (100%)
 rename fractor/tests/FileSystem/{Fixture => Fixtures}/DirectorToSearchIn/my_file.yaml (100%)
 rename fractor/tests/FileSystem/{Fixture => Fixtures}/DirectorToSearchIn/my_json.json (100%)
 rename fractor/tests/FileSystem/{Fixture => Fixtures}/DirectorToSearchIn/my_txt.yaml (100%)
 rename fractor/tests/Fractor/FractorRunner/config/{application.php => config.php} (100%)
 rename typo3-fractor/tests/Rules/FlexForm/config/{application.php => config.php} (100%)

diff --git a/.phpstorm.meta.php b/.phpstorm.meta.php
new file mode 100644
index 00000000..671bf7ce
--- /dev/null
+++ b/.phpstorm.meta.php
@@ -0,0 +1,8 @@
+<?php
+
+declare(strict_types=1);
+
+// see https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata
+namespace PHPSTORM_META;
+
+override(\Psr\Container\ContainerInterface::get(0), type(0));
\ No newline at end of file
diff --git a/fractor/config/application.php b/fractor/config/application.php
index 32d8d001..6ba08e77 100644
--- a/fractor/config/application.php
+++ b/fractor/config/application.php
@@ -1,8 +1,9 @@
 <?php
 
+use a9f\Fractor\Configuration\AllowedFileExtensionsResolver;
+use a9f\Fractor\Configuration\ConfigurationFactory;
 use a9f\Fractor\Configuration\Option;
 use a9f\Fractor\Contract\FileProcessor;
-use a9f\Fractor\Factory\ConfigurationFactory;
 use a9f\Fractor\Fractor\FractorRunner;
 use a9f\Fractor\ValueObject\Configuration;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -25,10 +26,9 @@
     $services->load('a9f\\Fractor\\', __DIR__ . '/../src/')
         ->exclude(
             [
-                __DIR__ . '/../src/Configuration',
                 __DIR__ . '/../src/Console',
-                __DIR__ . '/../src/ValueObject',
                 __DIR__ . '/../src/Testing',
+                __DIR__ . '/../src/ValueObject',
             ]
         );
 
@@ -41,7 +41,7 @@
 
     $services->set(Configuration::class)->factory([service(ConfigurationFactory::class), 'create']);
     $services->set(FractorRunner::class)->arg('$processors', tagged_iterator('fractor.file_processor'));
-    $services->set(ConfigurationFactory::class)->arg('$processors', tagged_iterator('fractor.file_processor'));
+    $services->set(AllowedFileExtensionsResolver::class)->arg('$processors', tagged_iterator('fractor.file_processor'));
 
     $containerBuilder->registerForAutoconfiguration(FileProcessor::class)->addTag('fractor.file_processor');
 };
diff --git a/fractor/src/Configuration/AllowedFileExtensionsResolver.php b/fractor/src/Configuration/AllowedFileExtensionsResolver.php
new file mode 100644
index 00000000..2cd9eae6
--- /dev/null
+++ b/fractor/src/Configuration/AllowedFileExtensionsResolver.php
@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\Fractor\Configuration;
+
+use a9f\Fractor\Contract\FileProcessor;
+
+final readonly class AllowedFileExtensionsResolver
+{
+    /**
+     * @param FileProcessor[] $processors
+     */
+    public function __construct(private iterable $processors)
+    {
+    }
+
+    /**
+     * @return list<non-empty-string>
+     */
+    public function resolve(): array
+    {
+        $fileExtensions = [];
+        foreach ($this->processors as $processor) {
+            $fileExtensions = array_merge($processor->allowedFileExtensions(), $fileExtensions);
+        }
+
+        return array_unique($fileExtensions);
+    }
+}
diff --git a/fractor/src/Configuration/ConfigurationFactory.php b/fractor/src/Configuration/ConfigurationFactory.php
new file mode 100644
index 00000000..7f43b46f
--- /dev/null
+++ b/fractor/src/Configuration/ConfigurationFactory.php
@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\Fractor\Configuration;
+
+use a9f\Fractor\ValueObject\Configuration;
+use Symfony\Component\DependencyInjection\ParameterBag\ContainerBagInterface;
+
+final readonly class ConfigurationFactory
+{
+    public function __construct(private ContainerBagInterface $parameterBag, private AllowedFileExtensionsResolver $allowedFileExtensionsResolver)
+    {
+    }
+
+    public function create(): Configuration
+    {
+        return new Configuration(
+            $this->allowedFileExtensionsResolver->resolve(),
+            $this->parameterBag->get(Option::PATHS),
+        );
+    }
+}
diff --git a/fractor/src/Factory/ConfigurationFactory.php b/fractor/src/Factory/ConfigurationFactory.php
deleted file mode 100644
index b23a4817..00000000
--- a/fractor/src/Factory/ConfigurationFactory.php
+++ /dev/null
@@ -1,33 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace a9f\Fractor\Factory;
-
-use a9f\Fractor\Configuration\Option;
-use a9f\Fractor\Contract\FileProcessor;
-use a9f\Fractor\ValueObject\Configuration;
-use Symfony\Component\DependencyInjection\ParameterBag\ContainerBagInterface;
-
-final readonly class ConfigurationFactory
-{
-    /**
-     * @param list<FileProcessor> $processors
-     */
-    public function __construct(private ContainerBagInterface $parameterBag, private iterable $processors)
-    {
-    }
-
-    public function create(): Configuration
-    {
-        $fileExtensions = [];
-        foreach ($this->processors as $processor) {
-            $fileExtensions = array_merge($processor->allowedFileExtensions(), $fileExtensions);
-        }
-
-        return new Configuration(
-            array_unique($fileExtensions),
-            $this->parameterBag->get(Option::PATHS),
-        );
-    }
-}
diff --git a/fractor/tests/Configuration/AllowedFileExtensionsResolver/AllowedFileExtensionsResolverTest.php b/fractor/tests/Configuration/AllowedFileExtensionsResolver/AllowedFileExtensionsResolverTest.php
new file mode 100644
index 00000000..b25ede3f
--- /dev/null
+++ b/fractor/tests/Configuration/AllowedFileExtensionsResolver/AllowedFileExtensionsResolverTest.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\Fractor\Tests\Configuration\AllowedFileExtensionsResolver;
+
+use a9f\Fractor\Configuration\AllowedFileExtensionsResolver;
+use a9f\Fractor\Testing\PHPUnit\AbstractFractorTestCase;
+
+final class AllowedFileExtensionsResolverTest extends AbstractFractorTestCase
+{
+    public function test(): void
+    {
+        // Arrange
+        $allowedFileExtensionsResolver = $this->getService(AllowedFileExtensionsResolver::class);
+
+        // Act & Assert
+        self::assertSame(['txt'], $allowedFileExtensionsResolver->resolve());
+    }
+    protected function additionalConfigurationFiles(): array
+    {
+        return [
+            __DIR__ . '/config/config.php'
+        ];
+    }
+}
diff --git a/fractor/tests/Configuration/AllowedFileExtensionsResolver/config/config.php b/fractor/tests/Configuration/AllowedFileExtensionsResolver/config/config.php
new file mode 100644
index 00000000..e8ad0cea
--- /dev/null
+++ b/fractor/tests/Configuration/AllowedFileExtensionsResolver/config/config.php
@@ -0,0 +1,14 @@
+<?php
+
+use a9f\Fractor\Tests\Helper\FileProcessor\TextFileProcessor;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use function Symfony\Component\DependencyInjection\Loader\Configurator\tagged_iterator;
+
+return static function (ContainerConfigurator $containerConfigurator, ContainerBuilder $containerBuilder): void {
+    $services = $containerConfigurator->services();
+    $services->defaults()
+        ->autowire()
+        ->autoconfigure();
+    $services->set(TextFileProcessor::class)->arg('$rules', tagged_iterator('fractor.text_rules'));
+};
diff --git a/fractor/tests/FileSystem/FileFinderTest.php b/fractor/tests/FileSystem/FileFinderTest.php
index 8cd0c520..34f5ed64 100644
--- a/fractor/tests/FileSystem/FileFinderTest.php
+++ b/fractor/tests/FileSystem/FileFinderTest.php
@@ -29,12 +29,12 @@ public function anExceptionIsThrownWhenDirectoriesAreEmpty(): void
     #[Test]
     public function findAllNonEmptyFilesInGivenDirectories(): void
     {
-        self::assertCount(4, $this->subject->findFiles([__DIR__ . '/Fixture/DirectorToSearchIn'], []));
+        self::assertCount(4, $this->subject->findFiles([__DIR__ . '/Fixtures/DirectorToSearchIn'], []));
     }
 
     #[Test]
     public function findAllNonEmptyFilesInGivenDirectoriesWithGivenExtensions(): void
     {
-        self::assertCount(2, $this->subject->findFiles([__DIR__ . '/Fixture/DirectorToSearchIn'], ['txt', 'json']));
+        self::assertCount(2, $this->subject->findFiles([__DIR__ . '/Fixtures/DirectorToSearchIn'], ['txt', 'json']));
     }
 }
diff --git a/fractor/tests/FileSystem/Fixture/DirectorToSearchIn/my_empty_file.txt b/fractor/tests/FileSystem/Fixtures/DirectorToSearchIn/my_empty_file.txt
similarity index 100%
rename from fractor/tests/FileSystem/Fixture/DirectorToSearchIn/my_empty_file.txt
rename to fractor/tests/FileSystem/Fixtures/DirectorToSearchIn/my_empty_file.txt
diff --git a/fractor/tests/FileSystem/Fixture/DirectorToSearchIn/my_file.txt b/fractor/tests/FileSystem/Fixtures/DirectorToSearchIn/my_file.txt
similarity index 100%
rename from fractor/tests/FileSystem/Fixture/DirectorToSearchIn/my_file.txt
rename to fractor/tests/FileSystem/Fixtures/DirectorToSearchIn/my_file.txt
diff --git a/fractor/tests/FileSystem/Fixture/DirectorToSearchIn/my_file.yaml b/fractor/tests/FileSystem/Fixtures/DirectorToSearchIn/my_file.yaml
similarity index 100%
rename from fractor/tests/FileSystem/Fixture/DirectorToSearchIn/my_file.yaml
rename to fractor/tests/FileSystem/Fixtures/DirectorToSearchIn/my_file.yaml
diff --git a/fractor/tests/FileSystem/Fixture/DirectorToSearchIn/my_json.json b/fractor/tests/FileSystem/Fixtures/DirectorToSearchIn/my_json.json
similarity index 100%
rename from fractor/tests/FileSystem/Fixture/DirectorToSearchIn/my_json.json
rename to fractor/tests/FileSystem/Fixtures/DirectorToSearchIn/my_json.json
diff --git a/fractor/tests/FileSystem/Fixture/DirectorToSearchIn/my_txt.yaml b/fractor/tests/FileSystem/Fixtures/DirectorToSearchIn/my_txt.yaml
similarity index 100%
rename from fractor/tests/FileSystem/Fixture/DirectorToSearchIn/my_txt.yaml
rename to fractor/tests/FileSystem/Fixtures/DirectorToSearchIn/my_txt.yaml
diff --git a/fractor/tests/Fractor/FractorRunner/FractorRunnerTest.php b/fractor/tests/Fractor/FractorRunner/FractorRunnerTest.php
index 6c9f51e9..f4f26f9c 100644
--- a/fractor/tests/Fractor/FractorRunner/FractorRunnerTest.php
+++ b/fractor/tests/Fractor/FractorRunner/FractorRunnerTest.php
@@ -16,7 +16,7 @@ public function test(): void
     protected function additionalConfigurationFiles(): array
     {
         return [
-            __DIR__ . '/config/application.php'
+            __DIR__ . '/config/config.php'
         ];
     }
 }
diff --git a/fractor/tests/Fractor/FractorRunner/config/application.php b/fractor/tests/Fractor/FractorRunner/config/config.php
similarity index 100%
rename from fractor/tests/Fractor/FractorRunner/config/application.php
rename to fractor/tests/Fractor/FractorRunner/config/config.php
diff --git a/typo3-fractor/tests/Rules/FlexForm/AddRenderTypeToFlexFormFractorTest.php b/typo3-fractor/tests/Rules/FlexForm/AddRenderTypeToFlexFormFractorTest.php
index a80c2762..b40ac2ee 100644
--- a/typo3-fractor/tests/Rules/FlexForm/AddRenderTypeToFlexFormFractorTest.php
+++ b/typo3-fractor/tests/Rules/FlexForm/AddRenderTypeToFlexFormFractorTest.php
@@ -14,7 +14,7 @@ public function test(): void
     protected function additionalConfigurationFiles(): array
     {
         return [
-            __DIR__ . '/config/application.php',
+            __DIR__ . '/config/config.php',
         ];
     }
 }
diff --git a/typo3-fractor/tests/Rules/FlexForm/config/application.php b/typo3-fractor/tests/Rules/FlexForm/config/config.php
similarity index 100%
rename from typo3-fractor/tests/Rules/FlexForm/config/application.php
rename to typo3-fractor/tests/Rules/FlexForm/config/config.php