feat: configuration to generate code with strict types

Author: MrMeshok

CHANGELOG.md

@@ -6,6 +6,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- [GH#180](https://github.com/jolicode/automapper/pull/180) Add configuration to generate code with strict types
+
 ### Fixed
 - [GH#167](https://github.com/jolicode/automapper/pull/167) Fix property metadata attribute name in docs
 - [GH#166](https://github.com/jolicode/automapper/pull/166) Remove cache for property info, use specific services instead

src/Attribute/Mapper.php

@@ -23,6 +23,7 @@ public function __construct(
         public ?bool $checkAttributes = null,
         public ?ConstructorStrategy $constructorStrategy = null,
         public ?bool $allowReadOnlyTargetToPopulate = null,
+        public ?bool $strictTypes = null,
         public int $priority = 0,
         public ?string $dateTimeFormat = null,
     ) {

src/Configuration.php

@@ -36,6 +36,10 @@ public function __construct(
          * Does the mapper should throw an exception if the target is read-only.
          */
         public bool $allowReadOnlyTargetToPopulate = false,
+        /**
+         * Add declare(strict_types=1) to generated code.
+         */
+        public bool $strictTypes = false,
     ) {
     }
 }

src/Event/GenerateMapperEvent.php

@@ -22,6 +22,7 @@ public function __construct(
         public ?bool $checkAttributes = null,
         public ?ConstructorStrategy $constructorStrategy = null,
         public ?bool $allowReadOnlyTargetToPopulate = null,
+        public ?bool $strictTypes = null,
     ) {
     }
 }

src/EventListener/MapperListener.php

@@ -72,6 +72,7 @@ public function __invoke(GenerateMapperEvent $event): void
         $event->checkAttributes ??= $mapper->checkAttributes;
         $event->constructorStrategy ??= $mapper->constructorStrategy;
         $event->allowReadOnlyTargetToPopulate ??= $mapper->allowReadOnlyTargetToPopulate;
+        $event->strictTypes ??= $mapper->strictTypes;
         $event->mapperMetadata->dateTimeFormat = $mapper->dateTimeFormat;
     }
 }

src/Generator/MapperGenerator.php

@@ -20,6 +20,9 @@
 use PhpParser\Node\Stmt;
 use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
 
+use function AutoMapper\PhpParser\create_declare_item;
+use function AutoMapper\PhpParser\create_scalar_int;
+
 /**
  * Generates code for a mapping class.
  *
@@ -58,22 +61,31 @@ public function __construct(
     /**
      * Generate Class AST given metadata for a mapper.
      *
+     * @return Stmt[]
+     *
      * @throws CompileException
      * @throws InvalidMappingException
      */
-    public function generate(GeneratorMetadata $metadata): Stmt\Class_
+    public function generate(GeneratorMetadata $metadata): array
     {
         if ($this->disableGeneratedMapper) {
             throw new InvalidMappingException('No mapper found for source ' . $metadata->mapperMetadata->source . ' and target ' . $metadata->mapperMetadata->target);
         }
 
-        return (new Builder\Class_($metadata->mapperMetadata->className))
+        $statements = [];
+        if ($metadata->strictTypes) {
+            // @phpstan-ignore argument.type
+            $statements[] = new Stmt\Declare_([create_declare_item('strict_types', create_scalar_int(1))]);
+        }
+        $statements[] = (new Builder\Class_($metadata->mapperMetadata->className))
             ->makeFinal()
             ->extend(GeneratedMapper::class)
             ->addStmt($this->constructorMethod($metadata))
             ->addStmt($this->mapMethod($metadata))
             ->addStmt($this->registerMappersMethod($metadata))
             ->getNode();
+
+        return $statements;
     }
 
     /**

src/Loader/EvalLoader.php

@@ -31,9 +31,9 @@ public function __construct(
 
     public function loadClass(MapperMetadata $mapperMetadata): void
     {
-        $class = $this->generator->generate($this->metadataFactory->getGeneratorMetadata($mapperMetadata->source, $mapperMetadata->target));
-
-        eval($this->printer->prettyPrint([$class]));
+        eval($this->printer->prettyPrint($this->generator->generate(
+            $this->metadataFactory->getGeneratorMetadata($mapperMetadata->source, $mapperMetadata->target)
+        )));
     }
 
     public function buildMappers(MetadataRegistry $registry): bool

src/Loader/FileLoader.php

@@ -78,8 +78,9 @@ public function createGeneratedMapper(MapperMetadata $mapperMetadata): string
         $className = $mapperMetadata->className;
         $classPath = $this->directory . \DIRECTORY_SEPARATOR . $className . '.php';
 
-        $generatorMetadata = $this->metadataFactory->getGeneratorMetadata($mapperMetadata->source, $mapperMetadata->target);
-        $classCode = $this->printer->prettyPrint([$this->generator->generate($generatorMetadata)]);
+        $classCode = $this->printer->prettyPrint($this->generator->generate(
+            $this->metadataFactory->getGeneratorMetadata($mapperMetadata->source, $mapperMetadata->target)
+        ));
 
         $this->write($classPath, "<?php\n\n" . $classCode . "\n");
 

src/Metadata/GeneratorMetadata.php

@@ -24,7 +24,8 @@ public function __construct(
         public readonly array $propertiesMetadata,
         public readonly bool $checkAttributes = true,
         public readonly ConstructorStrategy $constructorStrategy = ConstructorStrategy::AUTO,
-        public bool $allowReadOnlyTargetToPopulate = false,
+        public readonly bool $allowReadOnlyTargetToPopulate = false,
+        public readonly bool $strictTypes = false,
         public readonly ?string $provider = null,
     ) {
         $this->variableRegistry = new VariableRegistry();

src/Metadata/MetadataFactory.php

@@ -312,6 +312,7 @@ private function createGeneratorMetadata(MapperMetadata $mapperMetadata): Genera
             $mapperEvent->checkAttributes ?? $this->configuration->attributeChecking,
             $mapperEvent->constructorStrategy ?? $this->configuration->constructorStrategy,
             $mapperEvent->allowReadOnlyTargetToPopulate ?? $this->configuration->allowReadOnlyTargetToPopulate,
+            $mapperEvent->strictTypes ?? $this->configuration->strictTypes,
             $mapperEvent->provider,
         );
     }