feat: default value (#389)

Author: PawelSuwinski

composer.json

@@ -51,7 +51,7 @@
         "symfony/string": "^5.2 || ^6.0"
     },
     "require-dev": {
-        "api-platform/core": "^v2.7.0-beta.1",
+        "api-platform/core": "^v2.7.0-rc.1",
         "doctrine/orm": "^2.7",
         "myclabs/php-enum": "^1.7",
         "symfony/doctrine-bridge": "^5.2 || ^6.0",

composer.lock

@@ -14,6 +14,7 @@ parameters:
                 readable: boolean,
                 writable: boolean,
                 nullable: boolean,
+                defaultValue: mixed,
                 required: ?boolean,
                 unique: boolean,
                 embedded: boolean,

phpstan.neon

@@ -27,6 +27,8 @@ abstract class Property
     public string $cardinality;
     /** @var ?string the data type (array and object are not one) */
     public ?string $type = null;
+    /** @var mixed */
+    public $defaultValue = null;
     /** @var ?string the array data type (object is not one) */
     public ?string $arrayType = null;
     /** @var bool can be true and array type false if the property is an array of references */
@@ -148,7 +150,9 @@ public function toNetteProperty(PhpNamespace $namespace, string $visibility = nu
             $property->setNullable($this->isNullable);
         }
 
-        if (($default = $this->guessDefaultGeneratedValue($useDoctrineCollections)) !== -1) {
+        if (null !== $default = $this->defaultValue) {
+            $property->setValue($default);
+        } elseif (-1 !== $default = $this->guessDefaultGeneratedValue($useDoctrineCollections)) {
             $property->setValue($default);
         }
 

src/Model/Property.php

@@ -137,12 +137,14 @@ public function generate(OpenApi $openApi, array $config): array
         }
 
         // Second pass
+        $useInterface = $config['useInterface'];
+        $generateId = $config['id']['generate'];
         foreach ($classes as $class) {
-            if ($config['useInterface']) {
+            if ($useInterface) {
                 (new ClassInterfaceMutator($config['namespaces']['interface']))($class, []);
             }
 
-            if ($config['id']['generate']) {
+            if ($generateId) {
                 (new ClassIdAppender(new IdPropertyGenerator(), $config))($class, []);
             }
 

src/OpenApi/ClassGenerator.php

@@ -45,8 +45,9 @@ public function generate(array $configuration, OutputInterface $output, SymfonyS
             $graphs[] = $graph;
         }
 
+        $relationsUris = $configuration['relations']['uris'];
         $relations = [];
-        foreach ($configuration['relations']['uris'] as $relation) {
+        foreach ($relationsUris as $relation) {
             $relations[] = new \SimpleXMLElement($relation, 0, true);
         }
 

src/Schema/Generator.php

@@ -149,6 +149,7 @@ public function __invoke(string $name, array $config, Class_ $class, array $cont
         $schemaProperty->range = $range;
         $schemaProperty->rangeName = $rangeName;
         $schemaProperty->type = $type;
+        $schemaProperty->defaultValue = $propertyConfig['defaultValue'] ?? null;
         $schemaProperty->cardinality = $cardinality;
         $schemaProperty->isReadable = $propertyConfig['readable'] ?? true;
         $schemaProperty->isWritable = $propertyConfig['writable'] ?? true;

src/Schema/PropertyGenerator/PropertyGenerator.php

@@ -241,6 +241,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                                         ->booleanNode('readable')->defaultTrue()->info('Is the property readable?')->end()
                                         ->booleanNode('writable')->defaultTrue()->info('Is the property writable?')->end()
                                         ->booleanNode('nullable')->defaultNull()->info('Is the property nullable? (if null, cardinality will be used: will be true if no cardinality found)')->end()
+                                        ->variableNode('defaultValue')->defaultNull()->info('The property default value')->end()
                                         ->booleanNode('required')->defaultTrue()->info('Is the property required?')->end()
                                         ->booleanNode('unique')->defaultFalse()->info('The property unique')->end()
                                         ->booleanNode('embedded')->defaultFalse()->info('Is the property embedded?')->end()

src/SchemaGeneratorConfiguration.php

@@ -240,6 +240,9 @@ interface:            null
                     # Is the property nullable? (if null, cardinality will be used: will be true if no cardinality found)
                     nullable:             null
 
+                    # The property default value
+                    defaultValue:         null
+
                     # Is the property required?
                     required:             true
 

tests/Command/DumpConfigurationTest.php

@@ -206,6 +206,22 @@ public function testImplicitAndExplicitPropertyInheritance(): void
         $this->assertStringNotContainsString('setName(', $webPage);
     }
 
+    public function testPropertyDefault(): void
+    {
+        $outputDir = __DIR__.'/../../build/property-default';
+        $config = __DIR__.'/../config/property-default.yaml';
+        $this->fs->mkdir($outputDir);
+        $commandTester = new CommandTester(new GenerateCommand());
+        $this->assertEquals(0, $commandTester->execute(['output' => $outputDir, 'config' => $config]));
+
+        $book = file_get_contents("$outputDir/App/Entity/Book.php");
+
+        $this->assertStringContainsString(<<<'PHP'
+    private string $availability = 'https://schema.org/InStock';
+PHP
+            , $book);
+    }
+
     public function testReadableWritable(): void
     {
         $outputDir = __DIR__.'/../../build/readable-writable';