From de990f3836d210e07432f9ef4977fc20e72839cd Mon Sep 17 00:00:00 2001 From: Oliver Davies Date: Sat, 9 Dec 2023 15:31:48 +0000 Subject: [PATCH] Rename DTO class and variable names --- src/Action/CreateListOfFilesToGenerate.php | 16 +++---- src/Action/GenerateConfigurationFiles.php | 4 +- src/Action/ValidateConfigurationData.php | 4 +- .../{Config.php => ConfigDto.php} | 2 +- .../Validator/ConfigurationValidatorTest.php | 46 +++++++++---------- 5 files changed, 36 insertions(+), 36 deletions(-) rename src/DataTransferObject/{Config.php => ConfigDto.php} (99%) diff --git a/src/Action/CreateListOfFilesToGenerate.php b/src/Action/CreateListOfFilesToGenerate.php index c8a22a4..5846c3f 100644 --- a/src/Action/CreateListOfFilesToGenerate.php +++ b/src/Action/CreateListOfFilesToGenerate.php @@ -19,12 +19,12 @@ final class CreateListOfFilesToGenerate * @var Config $configurationDataDto, * @var array $configurationData */ - [$configurationData, $configurationDataDTO] = $configurationDataAndDto; + [$configurationData, $configDto] = $configurationDataAndDto; /** @var Collection */ $filesToGenerate = collect(); - switch (strtolower($configurationDataDTO->type)) { + switch (strtolower($configDto->type)) { case (strtolower(ProjectType::Astro->name)): $filesToGenerate = collect([ new TemplateFile(data: 'astro/.envrc', name: '.envrc'), @@ -41,14 +41,14 @@ final class CreateListOfFilesToGenerate new TemplateFile(data: 'fractal/run', name: 'run'), ]); - if ($configurationDataDTO->isDocker) { + if ($configDto->isDocker) { $filesToGenerate->push(new TemplateFile(data: 'fractal/.env.example', name: '.env.example')); $filesToGenerate->push(new TemplateFile(data: 'fractal/.dockerignore', name: '.dockerignore')); $filesToGenerate->push(new TemplateFile(data: 'fractal/.hadolint.yaml', name: '.hadolint.yaml')); $filesToGenerate->push(new TemplateFile(data: 'fractal/.yarnrc', name: '.yarnrc')); $filesToGenerate->push(new TemplateFile(data: 'fractal/Dockerfile', name: 'Dockerfile')); $filesToGenerate->push(new TemplateFile(data: 'fractal/docker-compose.yaml', name: 'docker-compose.yaml')); - } elseif ($configurationDataDTO->isFlake) { + } elseif ($configDto->isFlake) { $filesToGenerate->push(new TemplateFile(data: 'fractal/.envrc', name: '.envrc')); $filesToGenerate->push(new TemplateFile(data: 'fractal/flake.nix', name: 'flake.nix')); } @@ -82,15 +82,15 @@ final class CreateListOfFilesToGenerate )); } - if ($configurationDataDTO->php['phpcs'] !== false) { + if (!isset($configDto->php['phpcs']) || $configDto->php['phpcs'] !== false) { $filesToGenerate->push(new TemplateFile(data: 'drupal/phpcs.xml.dist', name: 'phpcs.xml.dist')); } - if ($configurationDataDTO->php['phpstan'] !== false) { + if (!isset($configDto->php['phpstan']) || $configDto->php['phpstan'] !== false) { $filesToGenerate->push(new TemplateFile(data: 'drupal/phpstan.neon.dist', name: 'phpstan.neon.dist')); } - if ($configurationDataDTO->php['phpunit'] !== false) { + if (!isset($configDto->php['phpunit']) || $configDto->php['phpunit'] !== false) { $filesToGenerate->push(new TemplateFile(data: 'drupal/phpunit.xml.dist', name: 'phpunit.xml.dist')); } @@ -153,7 +153,7 @@ final class CreateListOfFilesToGenerate ); } - return $next([$configurationData, $configurationDataDTO, $filesToGenerate]); + return $next([$configurationData, $configDto, $filesToGenerate]); } private static function isCaddy(?string $webServer): bool diff --git a/src/Action/GenerateConfigurationFiles.php b/src/Action/GenerateConfigurationFiles.php index 62985ee..e73bcb1 100644 --- a/src/Action/GenerateConfigurationFiles.php +++ b/src/Action/GenerateConfigurationFiles.php @@ -4,7 +4,7 @@ declare(strict_types=1); namespace App\Action; -use App\DataTransferObject\Config; +use App\DataTransferObject\ConfigDto; use App\DataTransferObject\TemplateFile; use Illuminate\Support\Collection; use Symfony\Component\Filesystem\Filesystem; @@ -23,7 +23,7 @@ final class GenerateConfigurationFiles { /** * @var Collection $filesToGenerate - * @var Config $configurationDataDto, + * @var ConfigDto $configurationDataDto, * @var array $configurationData */ [$configurationData, $configurationDataDto, $filesToGenerate] = $filesToGenerateAndConfigurationData; diff --git a/src/Action/ValidateConfigurationData.php b/src/Action/ValidateConfigurationData.php index 194f9a6..3babd2e 100644 --- a/src/Action/ValidateConfigurationData.php +++ b/src/Action/ValidateConfigurationData.php @@ -4,7 +4,7 @@ declare(strict_types=1); namespace App\Action; -use App\DataTransferObject\Config; +use App\DataTransferObject\ConfigDto; use Symfony\Component\Serializer\Encoder\JsonEncoder; use Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter; use Symfony\Component\Serializer\Normalizer\ObjectNormalizer; @@ -18,7 +18,7 @@ final class ValidateConfigurationData $normalizer = new ObjectNormalizer(null, new CamelCaseToSnakeCaseNameConverter()); $serializer = new Serializer([$normalizer], [new JsonEncoder()]); - $configurationDataDto = $serializer->deserialize(json_encode($configurationData), Config::class, 'json'); + $configurationDataDto = $serializer->deserialize(json_encode($configurationData), ConfigDto::class, 'json'); $validator = Validation::createValidatorBuilder()->enableAnnotationMapping()->getValidator(); $violations = $validator->validate($configurationDataDto); diff --git a/src/DataTransferObject/Config.php b/src/DataTransferObject/ConfigDto.php similarity index 99% rename from src/DataTransferObject/Config.php rename to src/DataTransferObject/ConfigDto.php index 6a9f38b..4c61653 100644 --- a/src/DataTransferObject/Config.php +++ b/src/DataTransferObject/ConfigDto.php @@ -6,7 +6,7 @@ namespace App\DataTransferObject; use Symfony\Component\Validator\Constraints as Assert; -final class Config +final class ConfigDto { #[Assert\Collection( allowExtraFields: false, diff --git a/tests/Kernel/Validator/ConfigurationValidatorTest.php b/tests/Kernel/Validator/ConfigurationValidatorTest.php index 2ecf65d..c910434 100644 --- a/tests/Kernel/Validator/ConfigurationValidatorTest.php +++ b/tests/Kernel/Validator/ConfigurationValidatorTest.php @@ -2,7 +2,7 @@ namespace App\Tests; -use App\DataTransferObject\Config; +use App\DataTransferObject\ConfigDto; use App\Enum\ProjectType; use App\Enum\WebServer; use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase; @@ -12,13 +12,13 @@ use Symfony\Component\Validator\Validator\ValidatorInterface; class ConfigurationValidatorTest extends KernelTestCase { - private Config $configurationDataDTO; + private ConfigDto $configurationDataDto; private ValidatorInterface $validator; public function setUp(): void { - $this->configurationDataDTO = self::createConfigurationDTO(); + $this->configurationDataDto = self::createConfigurationDto(); $this->validator = Validation::createValidatorBuilder() ->enableAttributeMapping() @@ -34,13 +34,13 @@ class ConfigurationValidatorTest extends KernelTestCase ?string $expectedMessage, ): void { - $this->configurationDataDTO->database = [ + $this->configurationDataDto->database = [ 'extra_databases' => $extraDatabases, 'type' => 'mariadb', 'version' => 10, ]; - $violations = $this->validator->validate($this->configurationDataDTO); + $violations = $this->validator->validate($this->configurationDataDto); self::assertCount( expectedCount: $expectedViolationCount, @@ -72,10 +72,10 @@ class ConfigurationValidatorTest extends KernelTestCase self::expectException(NotNormalizableValueException::class); } - $configurationDataDTO = self::createConfigurationDTO(); - $configurationDataDTO->name = $projectName; + $configurationDataDto = self::createConfigurationDto(); + $configurationDataDto->name = $projectName; - $violations = $this->validator->validate($configurationDataDTO); + $violations = $this->validator->validate($configurationDataDto); self::assertCount( expectedCount: $expectedViolationCount, @@ -98,10 +98,10 @@ class ConfigurationValidatorTest extends KernelTestCase int $expectedViolationCount, ?string $expectedMessage, ): void { - $configurationDataDTO = self::createConfigurationDTO(); - $configurationDataDTO->language = $language; + $configurationDataDto = self::createConfigurationDto(); + $configurationDataDto->language = $language; - $violations = $this->validator->validate($configurationDataDTO); + $violations = $this->validator->validate($configurationDataDto); self::assertCount( expectedCount: $expectedViolationCount, @@ -129,10 +129,10 @@ class ConfigurationValidatorTest extends KernelTestCase int $expectedViolationCount, ?string $expectedMessage, ): void { - $configurationDataDTO = self::createConfigurationDTO(); - $configurationDataDTO->type = $projectType; + $configurationDataDto = self::createConfigurationDto(); + $configurationDataDto->type = $projectType; - $violations = $this->validator->validate($configurationDataDTO); + $violations = $this->validator->validate($configurationDataDto); self::assertCount( expectedCount: $expectedViolationCount, @@ -160,10 +160,10 @@ class ConfigurationValidatorTest extends KernelTestCase int $expectedViolationCount, ?string $expectedMessage, ): void { - $configurationDataDTO = self::createConfigurationDTO(); - $configurationDataDTO->web['type'] = $webServer; + $configurationDataDto = self::createConfigurationDto(); + $configurationDataDto->web['type'] = $webServer; - $violations = $this->validator->validate($configurationDataDTO); + $violations = $this->validator->validate($configurationDataDto); self::assertCount( expectedCount: $expectedViolationCount, @@ -233,13 +233,13 @@ class ConfigurationValidatorTest extends KernelTestCase ]; } - private static function createConfigurationDTO(): Config + private static function createConfigurationDto(): ConfigDto { - $configurationDataDTO = new Config(); - $configurationDataDTO->language = 'php'; - $configurationDataDTO->name = 'test'; - $configurationDataDTO->type = 'drupal'; + $configurationDataDto = new ConfigDto(); + $configurationDataDto->language = 'php'; + $configurationDataDto->name = 'test'; + $configurationDataDto->type = 'drupal'; - return $configurationDataDTO; + return $configurationDataDto; } }