Implemented PostProcessorInterface to apply changes to the schema after the generation process.

Moved serialization logic from model template into a post processor

Author: wol-soft

src/Model/GeneratorConfiguration.php

@@ -13,7 +13,6 @@
 use PHPModelGenerator\Utils\ClassNameGenerator;
 use PHPModelGenerator\Utils\ClassNameGeneratorInterface;
 use PHPModelGenerator\Exception\ErrorRegistryException;
-use PHPModelGenerator\Exception\ValidationException;
 
 /**
  * Class GeneratorConfiguration

src/Model/MethodInterface.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\Model;
+
+interface MethodInterface
+{
+    /**
+     * Returns the code of the method including the function signature
+     *
+     * @return string
+     */
+    public function getCode(): string;
+}

src/Model/Property/Serializer/TransformingFilterSerializer.php

@@ -9,6 +9,7 @@
 use PHPMicroTemplate\Exception\UndefinedSymbolException;
 use PHPMicroTemplate\Render;
 use PHPModelGenerator\Model\GeneratorConfiguration;
+use PHPModelGenerator\Model\MethodInterface;
 use PHPModelGenerator\PropertyProcessor\Filter\TransformingFilterInterface;
 use PHPModelGenerator\Utils\RenderHelper;
 
@@ -17,48 +18,51 @@
  *
  * @package PHPModelGenerator\Model\Property\Serializer
  */
-class TransformingFilterSerializer
+class TransformingFilterSerializer implements MethodInterface
 {
     /** @var string */
     protected $propertyName;
     /** @var TransformingFilterInterface */
     protected $filter;
     /** @var array */
     private $filterOptions;
+    /** @var GeneratorConfiguration */
+    private $generatorConfiguration;
 
     /**
      * TransformingFilterSerializer constructor.
      *
      * @param string $propertyName
      * @param TransformingFilterInterface $filter
      * @param array $filterOptions
+     * @param GeneratorConfiguration $generatorConfiguration
      */
     public function __construct(
         string $propertyName,
         TransformingFilterInterface $filter,
-        array $filterOptions
+        array $filterOptions,
+        GeneratorConfiguration $generatorConfiguration
     ) {
         $this->propertyName = $propertyName;
         $this->filter = $filter;
         $this->filterOptions = $filterOptions;
+        $this->generatorConfiguration = $generatorConfiguration;
     }
 
     /**
-     * @param GeneratorConfiguration $generatorConfiguration
-     *
      * @return string
      *
      * @throws FileSystemException
      * @throws SyntaxErrorException
      * @throws UndefinedSymbolException
      */
-    public function getSerializer(GeneratorConfiguration $generatorConfiguration): string
+    public function getCode(): string
     {
         return (new Render(join(DIRECTORY_SEPARATOR, [__DIR__, '..', '..', '..', 'Templates']) . DIRECTORY_SEPARATOR))
             ->renderTemplate(
                 DIRECTORY_SEPARATOR . 'Serializer' . DIRECTORY_SEPARATOR . 'TransformingFilterSerializer.phptpl',
                 [
-                    'viewHelper' => new RenderHelper($generatorConfiguration),
+                    'viewHelper' => new RenderHelper($this->generatorConfiguration),
                     'property' => $this->propertyName,
                     'serializerClass' => $this->filter->getSerializer()[0],
                     'serializerMethod' => $this->filter->getSerializer()[1],

src/Model/RenderJob.php

@@ -9,6 +9,7 @@
 use PHPModelGenerator\Exception\FileSystemException;
 use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Exception\ValidationException;
+use PHPModelGenerator\SchemaProcessor\PostProcessor\PostProcessorInterface;
 use PHPModelGenerator\Utils\RenderHelper;
 
 /**
@@ -52,6 +53,16 @@ public function __construct(
         $this->initialClass = $initialClass;
     }
 
+    /**
+     * @param PostProcessorInterface[] $postProcessors
+     */
+    public function postProcess(array $postProcessors)
+    {
+        foreach ($postProcessors as $postProcessor) {
+            $postProcessor->process($this->schema);
+        }
+    }
+
     /**
      * Execute the render job and render the class
      *
@@ -136,9 +147,7 @@ protected function renderClass(GeneratorConfiguration $generatorConfiguration):
                     'namespace'              => $namespace,
                     'use'                    => 'use ' . join(";\nuse ", array_unique($use)) . ';',
                     'class'                  => $this->className,
-                    'baseValidators'         => $this->schema->getBaseValidators(),
-                    'properties'             => $this->schema->getProperties(),
-                    'customSerializer'       => $this->schema->getCustomSerializer(),
+                    'schema'                 => $this->schema,
                     'generatorConfiguration' => $generatorConfiguration,
                     'viewHelper'             => new RenderHelper($generatorConfiguration),
                     'initialClass'           => $this->initialClass,

src/Model/Schema.php

@@ -5,7 +5,6 @@
 namespace PHPModelGenerator\Model;
 
 use PHPModelGenerator\Model\Property\PropertyInterface;
-use PHPModelGenerator\Model\Property\Serializer\TransformingFilterSerializer;
 use PHPModelGenerator\Model\SchemaDefinition\SchemaDefinitionDictionary;
 use PHPModelGenerator\Model\Validator\PropertyValidatorInterface;
 use PHPModelGenerator\Model\Validator\SchemaDependencyValidator;
@@ -22,8 +21,16 @@ class Schema
     protected $className;
     /** @var string */
     protected $classPath;
+
+    /** @var string[] */
+    protected $traits = [];
+    /** @var string[] */
+    protected $interfaces = [];
     /** @var PropertyInterface[] The properties which are part of the class */
     protected $properties = [];
+    /** @var MethodInterface[] */
+    protected $methods = [];
+
     /** @var PropertyValidatorInterface[] A Collection of validators which must be applied
      *                                    before adding properties to the model
      */
@@ -32,8 +39,6 @@ class Schema
     protected $usedClasses = [];
     /** @var SchemaNamespaceTransferDecorator[] */
     protected $namespaceTransferDecorators = [];
-    /** @var TransformingFilterSerializer[] */
-    protected $customSerializer = [];
 
     /** @var SchemaDefinitionDictionary */
     protected $schemaDefinitionDictionary;
@@ -196,23 +201,63 @@ public function getUsedClasses(array $visitedSchema = []): array
     }
 
     /**
-     * @param string $property
-     * @param TransformingFilterSerializer $serializer
+     * @param string $methodKey An unique key in the scope of the schema to identify the method
+     * @param MethodInterface $method
      *
      * @return $this
      */
-    public function addCustomSerializer(string $property, TransformingFilterSerializer $serializer): self
+    public function addMethod(string $methodKey, MethodInterface $method): self
+    {
+        $this->methods[$methodKey] = $method;
+
+        return $this;
+    }
+
+    /**
+     * @return MethodInterface[]
+     */
+    public function getMethods(): array
+    {
+        return $this->methods;
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getTraits(): array
     {
-        $this->customSerializer[$property] = $serializer;
+        return $this->traits;
+    }
+
+    /**
+     * @param string $trait
+     * @return Schema
+     */
+    public function addTrait(string $trait): self
+    {
+        $this->traits[] = $trait;
+        $this->addUsedClass($trait);
 
         return $this;
     }
 
     /**
-     * @return TransformingFilterSerializer[]
+     * @return string[]
      */
-    public function getCustomSerializer(): array
+    public function getInterfaces(): array
     {
-        return $this->customSerializer;
+        return $this->interfaces;
+    }
+
+    /**
+     * @param string $interface
+     * @return Schema
+     */
+    public function addInterface(string $interface): self
+    {
+        $this->interfaces[] = $interface;
+        $this->addUsedClass($interface);
+
+        return $this;
     }
 }

src/ModelGenerator.php

@@ -9,6 +9,8 @@
 use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Exception\SchemaException;
 use PHPModelGenerator\Model\GeneratorConfiguration;
+use PHPModelGenerator\SchemaProcessor\PostProcessor\PostProcessorInterface;
+use PHPModelGenerator\SchemaProcessor\PostProcessor\SerializationPostProcessor;
 use PHPModelGenerator\SchemaProcessor\RenderQueue;
 use PHPModelGenerator\SchemaProcessor\SchemaProcessor;
 use PHPModelGenerator\SchemaProvider\SchemaProviderInterface;
@@ -24,6 +26,8 @@ class ModelGenerator
 {
     /** @var GeneratorConfiguration */
     protected $generatorConfiguration;
+    /** @var PostProcessorInterface[] */
+    protected $postProcessors = [];
 
     /**
      * Generator constructor.
@@ -33,6 +37,22 @@ class ModelGenerator
     public function __construct(GeneratorConfiguration $generatorConfiguration = null)
     {
         $this->generatorConfiguration = $generatorConfiguration ?? new GeneratorConfiguration();
+
+        if ($this->generatorConfiguration->hasSerializationEnabled()) {
+            $this->addPostProcessor(new SerializationPostProcessor());
+        }
+    }
+
+    /**
+     * @param PostProcessorInterface $postProcessor
+     *
+     * @return $this
+     */
+    public function addPostProcessor(PostProcessorInterface $postProcessor): self
+    {
+        $this->postProcessors[] = $postProcessor;
+
+        return $this;
     }
 
     /**
@@ -93,7 +113,7 @@ public function generateModels(SchemaProviderInterface $schemaProvider, string $
         }
 
         // render all collected classes
-        $renderQueue->execute($destination, $this->generatorConfiguration);
+        $renderQueue->execute($destination, $this->generatorConfiguration, $this->postProcessors);
 
         if ($this->generatorConfiguration->hasPrettyPrintEnabled()) {
             // @codeCoverageIgnoreStart

src/PropertyProcessor/Filter/FilterProcessor.php

@@ -101,10 +101,17 @@ public function process(
                         $schema->addUsedClass($typeAfterFilter->getName());
                     }
 
-                    $schema->addCustomSerializer(
-                            $property->getAttribute(),
-                            new TransformingFilterSerializer($property->getAttribute(), $filter, $filterOptions)
+                    if ($generatorConfiguration->hasSerializationEnabled()) {
+                        $schema->addMethod(
+                            "serialize{$property->getAttribute()}",
+                            new TransformingFilterSerializer(
+                                $property->getAttribute(),
+                                $filter,
+                                $filterOptions,
+                                $generatorConfiguration
+                            )
                         );
+                    }
                 }
             }
         }

src/SchemaProcessor/PostProcessor/PostProcessorInterface.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\SchemaProcessor\PostProcessor;
+
+use PHPModelGenerator\Model\Schema;
+
+interface PostProcessorInterface
+{
+    /**
+     * Have fun doin' crazy stuff with the schema
+     *
+     * @param Schema $schema
+     */
+    public function process(Schema $schema): void;
+}

src/SchemaProcessor/PostProcessor/SerializationPostProcessor.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\SchemaProcessor\PostProcessor;
+
+use JsonSerializable;
+use PHPModelGenerator\Interfaces\SerializationInterface;
+use PHPModelGenerator\Model\Schema;
+use PHPModelGenerator\Traits\SerializableTrait;
+
+/**
+ * Class SerializationPostProcessor
+ *
+ * @package PHPModelGenerator\SchemaProcessor\PostProcessor
+ */
+class SerializationPostProcessor implements PostProcessorInterface
+{
+    public function process(Schema $schema): void
+    {
+        $schema
+            ->addTrait(SerializableTrait::class)
+            ->addInterface(JsonSerializable::class)
+            ->addInterface(SerializationInterface::class);
+    }
+}

src/SchemaProcessor/RenderQueue.php

@@ -8,6 +8,7 @@
 use PHPModelGenerator\Exception\RenderException;
 use PHPModelGenerator\Model\GeneratorConfiguration;
 use PHPModelGenerator\Model\RenderJob;
+use PHPModelGenerator\SchemaProcessor\PostProcessor\PostProcessorInterface;
 
 /**
  * Class RenderQueue
@@ -34,15 +35,20 @@ public function addRenderJob(RenderJob $renderJob): self
     /**
      * Render all collected jobs of the RenderProxy and clear the queue
      *
-     * @param string                 $destination
-     * @param GeneratorConfiguration $generatorConfiguration
+     * @param string                   $destination
+     * @param GeneratorConfiguration   $generatorConfiguration
+     * @param PostProcessorInterface[] $postProcessors
      *
      * @throws FileSystemException
      * @throws RenderException
      */
-    public function execute(string $destination, GeneratorConfiguration $generatorConfiguration): void
-    {
+    public function execute(
+        string $destination,
+        GeneratorConfiguration $generatorConfiguration,
+        array $postProcessors
+    ): void {
         foreach ($this->jobs as $job) {
+            $job->postProcess($postProcessors);
             $job->render($destination, $generatorConfiguration);
         }