Merge pull request #24 from picamator/development

Release 2.1.2

Author: picamator

README.md

@@ -8,13 +8,10 @@
 Transfer Object Generator
 ==========================
 
-Would you like to build Symfony-compatible Transfer Objects easily?
+Would you like to build Symfony-compatible Transfer Objects?
 
 You're in the right place! 🎉
 
-Build Transfer Object by Blueprint
-----------------------------------
-
 Imagine you have a Rest API response:
 
 ```json
@@ -59,18 +56,33 @@ Key Features
 
 **Symfony Compatability:**
 
- * includes Symfony console commands: [TransferGeneratorCommand](/src/Command/TransferGeneratorCommand.php) and [DefinitionGeneratorCommand](/src/Command/DefinitionGeneratorCommand.php)
- * includes Symfony services: [TransferGeneratorFacade](/src/TransferGenerator/TransferGeneratorFacade.php) and [DefinitionGeneratorFacade](/src/DefinitionGenerator/DefinitionGeneratorFacade.php)
- * supports mapping Symfony request
+ * includes Symfony console commands:
+   * [TransferGeneratorCommand](/src/Command/TransferGeneratorCommand.php)
+   * [DefinitionGeneratorCommand](/src/Command/DefinitionGeneratorCommand.php)
+ * includes Symfony services:
+   * [TransferGeneratorFacade](/src/TransferGenerator/TransferGeneratorFacade.php)
+   * [DefinitionGeneratorFacade](/src/DefinitionGenerator/DefinitionGeneratorFacade.php)
+ * supports Symfony request data mapping
 
 **Transfer Object:**
-  * implements methods: `fromArray()`, `toArray()`, and `toFilterArray()`
-  * implements standard interfaces: `IteratorAggregate`, `JsonSerializable`, and `Countable`
-  * supports embedded, collections Transfer Objects
-  * supports PHP primitive data types
-  * supports `BackedEnum`, `DateTime`, `DateTimeImmutable`, and `BcMath\Number`
-  * supports asymmetric property visibility
-  * integrates external Transfer Objects
+
+* implements methods:
+  * `fromArray()`
+  * `toArray()`
+  * `toFilterArray()`
+* implements standard interfaces:
+  * `IteratorAggregate`
+  * `JsonSerializable`
+  * `Countable`
+* supports embedded and collection Transfer Objects
+* supports PHP primitive data types
+* supports:
+  * `BackedEnum`
+  * `DateTime`
+  * `DateTimeImmutable`
+  * `BcMath\Number`
+* supports asymmetric property visibility
+* integrates external Transfer Objects
 
 Installation
 ------------
@@ -81,18 +93,25 @@ Composer installation:
 $ composer require picamator/transfer-object
 ```
 
+Samples
+-------
+
+* [Definition Generator](/doc/samples/try-definition-generator.php)
+* [Transfer Generator](/doc/samples/try-transfer-generator.php)
+* [Advanced Transfer Generator](/doc/samples/try-advanced-transfer-generator.php)
+
 Usage Tests
 -----------
 
-Definition Files and Transfer Object generators have been tested against API responses such as:
+Definition Files and Transfer Object generators have been tested against following APIs:
 
 * [NASA Open Api](https://api.nasa.gov/neo/rest/v1/neo/2465633?api_key=DEMO_KEY)
 * [OpenWeather](https://openweathermap.org/current#example_JSON)
 * [Content API for Shopping](https://developers.google.com/shopping-content/guides/products/products-api?hl=en)
 * [Frankfurter is a free, open-source currency data API](https://api.frankfurter.dev/v1/latest)
 * [Tagesschau API](https://tagesschau.api.bund.dev)
 
-### Test Scenario
+### Scenario
 
 1. Rest API response is used as a blueprint to generate Definition Files
 2. Transfer Objects are generated based on Definition Files
@@ -104,16 +123,6 @@ In all cases, data **100%** are matched ✅.
 
 For detailed information, please check [DefinitionGeneratorFacadeTest](/tests/integration/DefinitionGenerator/DefinitionGeneratorFacadeTest.php).
 
-### Samples
-
-- [Definition Generator](/doc/samples/try-definition-generator.php)
-- [Transfer Generator](/doc/samples/try-transfer-generator.php)
-- [Advanced Transfer Generator](/doc/samples/try-advanced-transfer-generator.php)
-
-### Practice
-
-Definition Files and Transfer Objects generators use [Transfer Objects](/src/Generated).
-
 Acknowledgment
 --------------
 
@@ -127,8 +136,8 @@ Follow the project to stay updated with all activities.
 
 If you have suggestions for improvements or new features, feel free to:
 
-- Create an issue
-- Submit a pull request
+* Create an issue
+* Submit a pull request
 
 Here is a [Contribution Guide](CONTRIBUTING.md).
 

bin/definition-generate

@@ -9,9 +9,10 @@ use Symfony\Component\Console\Application;
 include $_composer_autoload_path ?? __DIR__ . '/../vendor/autoload.php';
 
 $application = new Application(name:'TransferObject', version:'current');
+
 $command = new DefinitionGeneratorCommand();
 
 $application->add($command);
+$application->setDefaultCommand($command->getName(), isSingleCommand: true);
 
-$application->setDefaultCommand($command->getName(), true);
 $application->run();

bin/transfer-generate

@@ -9,9 +9,10 @@ use Symfony\Component\Console\Application;
 include $_composer_autoload_path ?? __DIR__ . '/../vendor/autoload.php';
 
 $application = new Application(name:'TransferObject', version:'current');
+
 $command = new TransferGeneratorCommand();
 
 $application->add($command);
+$application->setDefaultCommand($command->getName(), isSingleCommand: true);
 
-$application->setDefaultCommand($command->getName(), true);
 $application->run();

composer.json

@@ -53,7 +53,7 @@
         "squizlabs/php_codesniffer": "^3.11"
     },
     "suggest": {
-        "ext-bcmath": "Required for supporting the `numberType` in Transfer Object Definition Files."
+        "ext-bcmath": "Required for supporting BcMath Number."
     },
     "bin": [
         "bin/transfer-generate",

docker/sdk

@@ -101,7 +101,7 @@ case $1 in
     $DOCKER_EXEC composer captainhook $2
     ;;
   to-generate)
-     $DOCKER_EXEC composer transfer-generate -- -c ./config/generator.config.yml
+     $DOCKER_EXEC composer transfer-generate -- -c ./config/generator.config.yml -v
     ;;
   df-generate)
      $DOCKER_EXEC composer definition-generate

src/Command/DefinitionGeneratorCommand.php

@@ -9,6 +9,7 @@
 use Picamator\TransferObject\DefinitionGenerator\DefinitionGeneratorFacadeInterface;
 use Picamator\TransferObject\DefinitionGenerator\Generator\Builder\DefinitionGeneratorBuilderInterface;
 use Picamator\TransferObject\Generated\DefinitionGeneratorTransfer;
+use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Input\InputInterface;
@@ -17,12 +18,14 @@
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Throwable;
 
+#[AsCommand(
+    name: 'picamator:definition:generate',
+    description: 'Generate Transfer Object definition files from a JSON blueprint.'
+)]
 class DefinitionGeneratorCommand extends Command
 {
     use InputNormalizerTrait;
 
-    private const string NAME = 'picamator:definition:generate';
-    private const string DESCRIPTION = 'Generate Transfer Object definition files from a JSON blueprint.';
     private const string HELP = <<<'HELP'
 This command allows you to generate Transfer Object definition files based on a JSON file as a blueprint.
 
@@ -51,12 +54,7 @@ public function __construct(
 
     protected function configure(): void
     {
-        if ($this->getName() === null) {
-            $this->setName(name: self::NAME);
-        }
-
-        $this->setDescription(description: self::DESCRIPTION)
-            ->setHelp(help: self::HELP);
+        $this->setHelp(help: self::HELP);
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int

src/Command/TransferGeneratorCommand.php

@@ -8,18 +8,21 @@
 use Picamator\TransferObject\Generated\TransferGeneratorTransfer;
 use Picamator\TransferObject\TransferGenerator\TransferGeneratorFacade;
 use Picamator\TransferObject\TransferGenerator\TransferGeneratorFacadeInterface;
+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;
 use Symfony\Component\Console\Style\SymfonyStyle;
 
+#[AsCommand(
+    name: 'picamator:definition:generate',
+    description: 'Generate Transfer Objects from definition templates.'
+)]
 class TransferGeneratorCommand extends Command
 {
     use InputNormalizerTrait;
 
-    private const string NAME = 'picamator:transfer:generate';
-    private const string DESCRIPTION = 'Generate Transfer Objects from definition templates.';
     private const string HELP = <<<'HELP'
 This command generates Transfer Objects based on YML definitions.
 The command requires a path to the configuration file in YML format.
@@ -40,8 +43,10 @@ class TransferGeneratorCommand extends Command
 The required -c option is missing. Please provide the path to the YML configuration file.
 MESSAGE;
 
-    private const string TRANSFER_OBJECT_MESSAGE_TEMPLATE = 'Processing Transfer Object: "%s".';
-    private const string DEFINITION_MESSAGE_TEMPLATE = 'Using definition file: "%s".';
+    private const string TRANSFER_OBJECT_MESSAGE_TEMPLATE = 'Processing Transfer Object: <info>%s</info>.';
+    private const string DEFINITION_MESSAGE_TEMPLATE = 'Using Definition File: <comment>%s</comment>.';
+
+    private const string DEBUG_MESSAGE_TEMPLATE = '<comment>%s</comment>: <info>%s</info>';
 
     private const string SUCCESS_MESSAGE = 'All Transfer Objects were generated successfully! 🎉';
 
@@ -54,12 +59,7 @@ public function __construct(
 
     protected function configure(): void
     {
-        if ($this->getName() === null) {
-            $this->setName(name:self::NAME);
-        }
-
-        $this->setDescription(description: self::DESCRIPTION)
-            ->setHelp(help: self::HELP);
+        $this->setHelp(help: self::HELP);
 
         $this->addOption(
             name: self::OPTION_NAME_CONFIGURATION,
@@ -93,30 +93,67 @@ private function generateTransfers(string $configPath, SymfonyStyle $styleOutput
         $generatorFiber = $this->generatorFacade->getTransferGeneratorFiber();
 
         $generatorTransfer = $generatorFiber->start($configPath);
-        $this->writelnGeneratorError($generatorTransfer, $styleOutput);
+
+        $this->writelnErrorMessages($generatorTransfer, $styleOutput);
+        $this->writelnDebugMessages($generatorTransfer, $styleOutput);
 
         while (!$generatorFiber->isTerminated()) {
             $generatorTransfer = $generatorFiber->resume();
-            $this->writelnGeneratorError($generatorTransfer, $styleOutput);
+
+            $this->writelnErrorMessages($generatorTransfer, $styleOutput);
+            $this->writelnDebugMessages($generatorTransfer, $styleOutput);
         }
 
         return $generatorFiber->getReturn();
     }
 
-    private function writelnGeneratorError(
+    private function writelnDebugMessages(
+        ?TransferGeneratorTransfer $generatorTransfer,
+        SymfonyStyle $styleOutput,
+    ): void {
+        if (
+            !$styleOutput->isVerbose()
+            || $generatorTransfer === null
+            || $generatorTransfer->validator->isValid === false
+            || $generatorTransfer->fileName === null
+            || $generatorTransfer->className === null
+        ) {
+            return;
+        }
+
+        static $fileName = $generatorTransfer->fileName;
+
+        if ($fileName !== $generatorTransfer->fileName) {
+            $fileName = $generatorTransfer->fileName;
+
+            $styleOutput->newLine();
+        }
+
+        $styleOutput->writeln(
+            sprintf(
+                self::DEBUG_MESSAGE_TEMPLATE,
+                $generatorTransfer->fileName,
+                $generatorTransfer->className,
+            )
+        );
+    }
+
+    private function writelnErrorMessages(
         ?TransferGeneratorTransfer $generatorTransfer,
         SymfonyStyle $styleOutput,
     ): void {
         if ($generatorTransfer === null || $generatorTransfer->validator->isValid === true) {
             return;
         }
 
-        if ($generatorTransfer->className !== null) {
-            $styleOutput->info(sprintf(self::TRANSFER_OBJECT_MESSAGE_TEMPLATE, $generatorTransfer->className));
+        $className = $generatorTransfer->className ?? '';
+        if ($className !== '') {
+            $styleOutput->writeln(sprintf(self::TRANSFER_OBJECT_MESSAGE_TEMPLATE, $className));
         }
 
-        if ($generatorTransfer->fileName !== null) {
-            $styleOutput->info(sprintf(self::DEFINITION_MESSAGE_TEMPLATE, $generatorTransfer->fileName));
+        $fileName = $generatorTransfer->fileName ?? '';
+        if ($fileName !== '') {
+            $styleOutput->writeln(sprintf(self::DEFINITION_MESSAGE_TEMPLATE, $fileName));
         }
 
         foreach ($generatorTransfer->validator->errorMessages as $errorMessage) {

src/DefinitionGenerator/Exception/DefinitionGeneratorException.php

@@ -4,9 +4,9 @@
 
 namespace Picamator\TransferObject\DefinitionGenerator\Exception;
 
-use Exception;
 use Picamator\TransferObject\Shared\Exception\TransferExceptionInterface;
+use RuntimeException;
 
-class DefinitionGeneratorException extends Exception implements TransferExceptionInterface
+class DefinitionGeneratorException extends RuntimeException implements TransferExceptionInterface
 {
 }

src/Dependency/DependencyContainer.php

@@ -4,7 +4,7 @@
 
 namespace Picamator\TransferObject\Dependency;
 
-use Picamator\TransferObject\Dependency\Exception\DependencyNotFoundException;
+use Picamator\TransferObject\Dependency\Exception\ServiceNotFoundException;
 use Picamator\TransferObject\Dependency\Filesystem\FilesystemBridge;
 use Picamator\TransferObject\Dependency\Finder\FinderBridge;
 use Picamator\TransferObject\Dependency\YmlParser\YmlParserBridge;
@@ -30,16 +30,17 @@ class DependencyContainer implements ContainerInterface
     protected static array $container = [];
 
     /**
-     * @uses static::createYmlParser()
+     *
      * @uses static::createFinder()
      * @uses static::createFileSystem()
+     * @uses static::createYmlParser()
      *
-     * @throws \Picamator\TransferObject\Dependency\Exception\DependencyNotFoundException
+     * @throws \Picamator\TransferObject\Dependency\Exception\ServiceNotFoundException
      */
     public function get(string $id): mixed
     {
         if (!$this->has($id)) {
-            throw new DependencyNotFoundException(
+            throw new ServiceNotFoundException(
                 sprintf('Dependency "%s" not found.', $id),
             );
         }

src/Dependency/DependencyFactoryTrait.php

@@ -11,15 +11,15 @@
 trait DependencyFactoryTrait
 {
     /**
-     * @throws \Picamator\TransferObject\Dependency\Exception\DependencyNotFoundException
+     * @throws \Picamator\TransferObject\Dependency\Exception\ServiceNotFoundException
      */
     final protected function getDependency(string $id): mixed
     {
         return new DependencyContainer()->get($id);
     }
 
     /**
-     * @throws \Picamator\TransferObject\Dependency\Exception\DependencyNotFoundException
+     * @throws \Picamator\TransferObject\Dependency\Exception\ServiceNotFoundException
      */
     final protected function getFilesystem(): FilesystemInterface
     {
@@ -30,7 +30,7 @@ final protected function getFilesystem(): FilesystemInterface
     }
 
     /**
-     * @throws \Picamator\TransferObject\Dependency\Exception\DependencyNotFoundException
+     * @throws \Picamator\TransferObject\Dependency\Exception\ServiceNotFoundException
      */
     final protected function getFinder(): FinderInterface
     {
@@ -41,7 +41,7 @@ final protected function getFinder(): FinderInterface
     }
 
     /**
-     * @throws \Picamator\TransferObject\Dependency\Exception\DependencyNotFoundException
+     * @throws \Picamator\TransferObject\Dependency\Exception\ServiceNotFoundException
      */
     final protected function getYmlParser(): YmlParserInterface
     {