Add support to generate getter methods - Close #13

Author: sandrokeil

src/ClassGenerator.php

@@ -12,6 +12,7 @@
 
 use OpenCodeModeling\CodeAst\Builder\ClassBuilder;
 use OpenCodeModeling\CodeAst\Builder\ClassBuilderCollection;
+use OpenCodeModeling\CodeAst\Builder\ClassMethodBuilder;
 use OpenCodeModeling\CodeAst\Builder\ClassPropertyBuilder;
 use OpenCodeModeling\CodeAst\Package\ClassInfoList;
 use OpenCodeModeling\JsonSchemaToPhp\Type\ArrayType;
@@ -39,23 +40,16 @@ final class ClassGenerator
      */
     private $propertyNameFilter;
 
-    /**
-     * @var callable
-     */
-    private $methodNameFilter;
-
     public function __construct(
         ClassInfoList $classInfoList,
         ValueObjectFactory $valueObjectFactory,
         callable $classNameFilter,
-        callable $propertyNameFilter,
-        callable $methodNameFilter
+        callable $propertyNameFilter
     ) {
         $this->classInfoList = $classInfoList;
         $this->valueObjectFactory = $valueObjectFactory;
         $this->classNameFilter = $classNameFilter;
         $this->propertyNameFilter = $propertyNameFilter;
-        $this->methodNameFilter = $methodNameFilter;
     }
 
     /**
@@ -172,6 +166,34 @@ public function generateClasses(
         }
     }
 
+    /**
+     * @param ClassBuilderCollection $classBuilderCollection
+     * @param bool $typed
+     * @param callable $methodNameFilter Filter the property name to your desired method name e.g. with get prefix
+     */
+    public function addGetterMethods(
+        ClassBuilderCollection $classBuilderCollection,
+        bool $typed,
+        callable $methodNameFilter
+    ): void {
+        foreach ($classBuilderCollection as $classBuilder) {
+            foreach ($classBuilder->getProperties() as $classPropertyBuilder) {
+                $methodName = ($methodNameFilter)($classPropertyBuilder->getName());
+
+                if ($this->isValueObject($classBuilder)
+                    || $classBuilder->hasMethod($methodName)) {
+                    continue 2;
+                }
+                $classBuilder->addMethod(
+                    ClassMethodBuilder::fromScratch($methodName, $typed)
+                        ->setReturnType($classPropertyBuilder->getType())
+                        ->setReturnTypeDocBlockHint($classPropertyBuilder->getTypeDocBlockHint())
+                        ->setBody('return $this->' . $classPropertyBuilder->getName() . ';')
+                );
+            }
+        }
+    }
+
     public function generateValueObject(string $className, string $classNamespace, TypeDefinition $definition): ClassBuilder
     {
         $classBuilder = $this->valueObjectFactory->classBuilder($definition);
@@ -204,6 +226,7 @@ public function generateFiles(
                 $classInfo = $this->classInfoList->classInfoForNamespace($previousNamespace);
                 $path = $classInfo->getPath($classBuilder->getNamespace() . '\\' . $classBuilder->getName());
             }
+            // @phpstan-ignore-next-line
             $filename = $classInfo->getFilenameFromPathAndName($path, $classBuilder->getName());
 
             $nodeTraverser = new NodeTraverser();
@@ -239,4 +262,13 @@ private function addNamespaceImport(ClassBuilder $classBuilder, TypeDefinition $
                 break;
         }
     }
+
+    private function isValueObject(ClassBuilder $classBuilder): bool
+    {
+        return $classBuilder->hasMethod('fromItems')
+            || $classBuilder->hasMethod('toString')
+            || $classBuilder->hasMethod('toInt')
+            || $classBuilder->hasMethod('toFloat')
+            || $classBuilder->hasMethod('toBool');
+    }
 }

tests/ClassGeneratorTest.php

@@ -116,6 +116,8 @@ public function it_generates_files(): void
 
         $this->assertCount(7, $classBuilderCollection);
 
+        $this->classGenerator->addGetterMethods($classBuilderCollection, true, FilterFactory::methodNameFilter());
+
         $files = $this->classGenerator->generateFiles($classBuilderCollection, $this->parser, $this->printer);
 
         $this->assertCount(7, $files);
@@ -310,6 +312,14 @@ final class Order
 {
     private Address $billingAddress;
     private ShippingAddresses $shippingAddresses;
+    public function billingAddress() : Address
+    {
+        return $this->billingAddress;
+    }
+    public function shippingAddresses() : ShippingAddresses
+    {
+        return $this->shippingAddresses;
+    }
 }
 PHP;
         $this->assertSame($expected, $code);
@@ -460,6 +470,18 @@ final class Address
     private StreetAddress $streetAddress;
     private City $city;
     private State $federalState;
+    public function streetAddress() : StreetAddress
+    {
+        return $this->streetAddress;
+    }
+    public function city() : City
+    {
+        return $this->city;
+    }
+    public function federalState() : State
+    {
+        return $this->federalState;
+    }
 }
 PHP;
         $this->assertSame($expected, $code);
@@ -481,6 +503,18 @@ final class BillingAddress
     private StreetAddress $streetAddress;
     private City $city;
     private State $federalState;
+    public function streetAddress() : StreetAddress
+    {
+        return $this->streetAddress;
+    }
+    public function city() : City
+    {
+        return $this->city;
+    }
+    public function federalState() : State
+    {
+        return $this->federalState;
+    }
 }
 PHP;
         $this->assertSame($expected, $code);