Merge pull request #17 from andreaswolf/streamlining-and-refactoring

[TASK] Streamline folder and files naming

Author: sabbelasichon

.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));

fractor-xml/src/XmlFileProcessor.php

@@ -2,8 +2,8 @@
 
 namespace a9f\FractorXml;
 
-use a9f\Fractor\Contract\FileProcessor;
-use a9f\Fractor\ValueObject\File;
+use a9f\Fractor\Application\Contract\FileProcessor;
+use a9f\Fractor\Application\ValueObject\File;
 use a9f\FractorXml\Contract\XmlFractor;
 
 final class XmlFileProcessor implements FileProcessor

fractor/config/application.php

@@ -1,10 +1,11 @@
 <?php
 
+use a9f\Fractor\Application\Contract\FileProcessor;
+use a9f\Fractor\Application\FractorRunner;
+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 a9f\Fractor\Configuration\ValueObject\Configuration;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 use Symfony\Component\DependencyInjection\ParameterBag\ContainerBag;
@@ -25,10 +26,10 @@
     $services->load('a9f\\Fractor\\', __DIR__ . '/../src/')
         ->exclude(
             [
-                __DIR__ . '/../src/Configuration',
-                __DIR__ . '/../src/Console',
-                __DIR__ . '/../src/ValueObject',
+                __DIR__ . '/../src/Console/Output',
                 __DIR__ . '/../src/Testing',
+                __DIR__ . '/../src/ValueObject',
+                __DIR__ . '/../src/**/ValueObject',
             ]
         );
 
@@ -41,7 +42,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');
 };

fractor/src/Contract/FilePrinter.php fractor/src/Application/Contract/FilePrinter.php

@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace a9f\Fractor\Contract;
+namespace a9f\Fractor\Application\Contract;
 
-use a9f\Fractor\ValueObject\File;
+use a9f\Fractor\Application\ValueObject\File;
 
 interface FilePrinter
 {

fractor/src/Contract/FileProcessor.php fractor/src/Application/Contract/FileProcessor.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace a9f\Fractor\Contract;
+namespace a9f\Fractor\Application\Contract;
 
-use a9f\Fractor\ValueObject\File;
+use a9f\Fractor\Application\ValueObject\File;
 
 interface FileProcessor
 {

fractor/src/FileSystem/FileCollector.php fractor/src/Application/FilesCollector.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace a9f\Fractor\FileSystem;
+namespace a9f\Fractor\Application;
 
-use a9f\Fractor\ValueObject\File;
+use a9f\Fractor\Application\ValueObject\File;
 
-final class FileCollector
+final class FilesCollector
 {
     /**
      * @var array<string, File>

fractor/src/Fractor/FractorRunner.php fractor/src/Application/FractorRunner.php

@@ -1,14 +1,13 @@
 <?php
 
-namespace a9f\Fractor\Fractor;
-
-use a9f\Fractor\Contract\FilePrinter;
-use a9f\Fractor\Contract\FileProcessor;
-use a9f\Fractor\Contract\Output;
-use a9f\Fractor\FileSystem\FileCollector;
-use a9f\Fractor\FileSystem\FileFinder;
-use a9f\Fractor\ValueObject\Configuration;
-use a9f\Fractor\ValueObject\File;
+namespace a9f\Fractor\Application;
+
+use a9f\Fractor\Application\Contract\FilePrinter;
+use a9f\Fractor\Application\Contract\FileProcessor;
+use a9f\Fractor\Application\ValueObject\File;
+use a9f\Fractor\Configuration\ValueObject\Configuration;
+use a9f\Fractor\Console\Contract\Output;
+use a9f\Fractor\FileSystem\FilesFinder;
 use Nette\Utils\FileSystem;
 
 /**
@@ -18,9 +17,9 @@
 final readonly class FractorRunner
 {
     /**
-     * @param list<FileProcessor> $processors
+     * @param FileProcessor[] $processors
      */
-    public function __construct(private FileFinder $fileFinder, private FileCollector $fileCollector, private iterable $processors, private Configuration $configuration, private FilePrinter $filePrinter)
+    public function __construct(private FilesFinder $fileFinder, private FilesCollector $fileCollector, private iterable $processors, private Configuration $configuration, private FilePrinter $filePrinter)
     {
     }
 

fractor/src/FileSystem/LocalFileSystemPrinter.php fractor/src/Application/LocalFileSystemPrinter.php

@@ -2,10 +2,10 @@
 
 declare(strict_types=1);
 
-namespace a9f\Fractor\FileSystem;
+namespace a9f\Fractor\Application;
 
-use a9f\Fractor\Contract\FilePrinter;
-use a9f\Fractor\ValueObject\File;
+use a9f\Fractor\Application\Contract\FilePrinter;
+use a9f\Fractor\Application\ValueObject\File;
 use Nette\Utils\FileSystem;
 
 final class LocalFileSystemPrinter implements FilePrinter

fractor/src/ValueObject/File.php fractor/src/Application/ValueObject/File.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace a9f\Fractor\ValueObject;
+namespace a9f\Fractor\Application\ValueObject;
 
 final class File
 {

fractor/src/Configuration/AllowedFileExtensionsResolver.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\Fractor\Configuration;
+
+use a9f\Fractor\Application\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);
+    }
+}

fractor/src/Configuration/ConfigurationFactory.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace a9f\Fractor\Configuration;
+
+use a9f\Fractor\Configuration\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),
+        );
+    }
+}

fractor/src/ValueObject/Configuration.php fractor/src/Configuration/ValueObject/Configuration.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace a9f\Fractor\ValueObject;
+namespace a9f\Fractor\Configuration\ValueObject;
 
 use Webmozart\Assert\Assert;
 

fractor/src/Command/ProcessCommand.php fractor/src/Console/Command/ProcessCommand.php

@@ -1,17 +1,17 @@
 <?php
 
-namespace a9f\Fractor\Command;
+namespace a9f\Fractor\Console\Command;
 
-use a9f\Fractor\Console\SymfonyConsoleOutput;
-use a9f\Fractor\Fractor\FractorRunner;
+use a9f\Fractor\Application\FractorRunner;
+use a9f\Fractor\Console\Output\SymfonyConsoleOutput;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
 #[AsCommand('process', 'Runs Fractor with the given configuration file')]
-class ProcessCommand extends Command
+final class ProcessCommand extends Command
 {
     public function __construct(private readonly FractorRunner $runner)
     {

fractor/src/Contract/Output.php fractor/src/Console/Contract/Output.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace a9f\Fractor\Contract;
+namespace a9f\Fractor\Console\Contract;
 
 interface Output
 {

fractor/src/Console/NullOutput.php fractor/src/Console/Output/NullOutput.php

@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace a9f\Fractor\Console;
+namespace a9f\Fractor\Console\Output;
 
-use a9f\Fractor\Contract\Output;
+use a9f\Fractor\Console\Contract\Output;
 
 final class NullOutput implements Output
 {

fractor/src/Console/SymfonyConsoleOutput.php fractor/src/Console/Output/SymfonyConsoleOutput.php

@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace a9f\Fractor\Console;
+namespace a9f\Fractor\Console\Output;
 
-use a9f\Fractor\Contract\Output;
+use a9f\Fractor\Console\Contract\Output;
 use Symfony\Component\Console\Exception\RuntimeException;
 use Symfony\Component\Console\Helper\ProgressBar;
 use Symfony\Component\Console\Output\OutputInterface;

fractor/src/Factory/ConfigurationFactory.php

@@ -4,7 +4,7 @@
 
 use Symfony\Component\Finder\Finder;
 
-final class FileFinder
+final class FilesFinder
 {
     /**
      * @param list<non-empty-string> $directories

fractor/src/FileSystem/FileFinder.php fractor/src/FileSystem/FilesFinder.php

@@ -4,19 +4,19 @@
 
 namespace a9f\Fractor\Testing\PHPUnit;
 
-use a9f\Fractor\Console\NullOutput;
+use a9f\Fractor\Application\FilesCollector;
+use a9f\Fractor\Application\FractorRunner;
+use a9f\Fractor\Console\Output\NullOutput;
 use a9f\Fractor\DependencyInjection\ContainerContainerBuilder;
 use a9f\Fractor\Exception\ShouldNotHappenException;
-use a9f\Fractor\FileSystem\FileCollector;
-use a9f\Fractor\Fractor\FractorRunner;
 use PHPUnit\Framework\TestCase;
 use Psr\Container\ContainerInterface;
 
 abstract class AbstractFractorTestCase extends TestCase
 {
     private ?ContainerInterface $currentContainer = null;
     private FractorRunner $fractorRunner;
-    protected FileCollector $fileCollector;
+    protected FilesCollector $fileCollector;
 
     /**
      * @return array<int, string>
@@ -29,7 +29,7 @@ protected function additionalConfigurationFiles(): array
     protected function setUp(): void
     {
         $this->bootFromConfigFile();
-        $this->fileCollector = $this->getService(FileCollector::class);
+        $this->fileCollector = $this->getService(FilesCollector::class);
         $this->fractorRunner = $this->getService(FractorRunner::class);
     }
 

fractor/src/Testing/PHPUnit/AbstractFractorTestCase.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Fractor\FractorRunner;
+namespace a9f\Fractor\Tests\Application\FractorRunner;
 
 use a9f\Fractor\Testing\PHPUnit\AbstractFractorTestCase;
 
@@ -16,7 +16,7 @@ public function test(): void
     protected function additionalConfigurationFiles(): array
     {
         return [
-            __DIR__ . '/config/application.php'
+            __DIR__ . '/config/config.php'
         ];
     }
 }

fractor/tests/Fractor/FractorRunner/Assertions/my_text_file.txt fractor/tests/Application/FractorRunner/Assertions/my_text_file.txt

@@ -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'
+        ];
+    }
+}