Add FileCollection filter and visit methods - close #76

Author: sandrokeil

src/Builder/FileCollection.php

@@ -93,6 +93,15 @@ static function (File $file) use ($filter) {
         );
     }
 
+    public function visit(callable $visitor): self
+    {
+        foreach ($this->items as $file) {
+            ($visitor)($file);
+        }
+
+        return $this;
+    }
+
     /**
      * @return array<string, File>
      */

src/FileCodeGenerator.php

@@ -95,6 +95,8 @@ public function generateFiles(
     }
 
     /**
+     * @deprecated Use addPropertiesGetterMethods
+     *
      * Generation of getter methods. Use $skip callable to skip generation e. g. for value objects
      *
      * @param FileCollection $classBuilderCollection Only ClassBuilder objects are considered
@@ -115,28 +117,45 @@ public function addGetterMethodsForProperties(
         }
 
         foreach ($classBuilderCollection as $classBuilder) {
-            if (! $classBuilder instanceof ClassBuilder) {
+            if (! $classBuilder instanceof ClassBuilder
+                || true === ($skip)($classBuilder)
+            ) {
                 continue;
             }
-            foreach ($classBuilder->getProperties() as $classPropertyBuilder) {
-                $methodName = ($methodNameFilter)($classPropertyBuilder->getName());
+            $this->addPropertiesGetterMethods($classBuilder, $typed, $methodNameFilter);
+        }
+    }
 
-                if (true === ($skip)($classBuilder)
-                    || $classBuilder->hasMethod($methodName)
-                ) {
-                    continue 2;
-                }
-                $classBuilder->addMethod(
-                    ClassMethodBuilder::fromScratch($methodName, $typed)
-                        ->setReturnType($classPropertyBuilder->getType())
-                        ->setReturnTypeDocBlockHint($classPropertyBuilder->getTypeDocBlockHint())
-                        ->setBody('return $this->' . $classPropertyBuilder->getName() . ';')
-                );
+    /**
+     * Generation of getter methods.
+     *
+     * @param ClassBuilder $classBuilder
+     * @param bool $typed Should the generated code be typed
+     * @param callable $methodNameFilter Filter the property name to your desired method name e.g. with "get" prefix
+     */
+    public function addPropertiesGetterMethods(
+        ClassBuilder $classBuilder,
+        bool $typed,
+        callable $methodNameFilter
+    ): void {
+        foreach ($classBuilder->getProperties() as $classPropertyBuilder) {
+            $methodName = ($methodNameFilter)($classPropertyBuilder->getName());
+
+            if ($classBuilder->hasMethod($methodName)) {
+                continue;
             }
+            $classBuilder->addMethod(
+                ClassMethodBuilder::fromScratch($methodName, $typed)
+                    ->setReturnType($classPropertyBuilder->getType())
+                    ->setReturnTypeDocBlockHint($classPropertyBuilder->getTypeDocBlockHint())
+                    ->setBody('return $this->' . $classPropertyBuilder->getName() . ';')
+            );
         }
     }
 
     /**
+     * @deprecated Use addPropertiesClassConstants
+     *
      * Generation of constants for each property. Use $skip callable to skip generation e. g. for value objects
      *
      * @param FileCollection $fileCollection Only ClassBuilder objects are considered
@@ -180,4 +199,34 @@ public function addClassConstantsForProperties(
             }
         }
     }
+
+    /**
+     * Generation of constants for each property.
+     *
+     * @param ClassBuilder $classBuilder
+     * @param callable $constantNameFilter Converts the name to a proper class constant name
+     * @param callable $constantValueFilter Converts the name to a proper class constant value e.g. snake_case or camelCase
+     * @param int $visibility Visibility of the class constant
+     */
+    public function addPropertiesClassConstants(
+        ClassBuilder $classBuilder,
+        callable $constantNameFilter,
+        callable $constantValueFilter,
+        int $visibility = ClassConstGenerator::FLAG_PUBLIC
+    ): void {
+        foreach ($classBuilder->getProperties() as $classPropertyBuilder) {
+            $constantName = ($constantNameFilter)($classPropertyBuilder->getName());
+
+            if ($classBuilder->hasConstant($constantName)) {
+                continue;
+            }
+            $classBuilder->addConstant(
+                ClassConstBuilder::fromScratch(
+                    $constantName,
+                    ($constantValueFilter)($classPropertyBuilder->getName()),
+                    $visibility
+                )
+            );
+        }
+    }
 }

tests/FileCodeGeneratorTest.php

@@ -319,4 +319,70 @@ public function bar() : bool
         $this->assertSame($expectedTestClass, $files['/service/src/TestClass.php']);
         $this->assertSame($expectedTestClassOther, $files['/service/src/TestClassOther.php']);
     }
+
+    /**
+     * @test
+     */
+    public function it_add_getter_methods_for_properties_via_visit(): void
+    {
+        $testClass = ClassBuilder::fromScratch('TestClass', 'MyService')
+            ->setFinal(true)
+            ->addProperty(
+                ClassPropertyBuilder::fromScratch('foo', 'string'),
+                ClassPropertyBuilder::fromScratch('bar', 'int'),
+            );
+
+        $testClassOther = ClassBuilder::fromScratch('TestClassOther', 'MyService')
+            ->setFinal(true)
+            ->addProperty(
+                ClassPropertyBuilder::fromScratch('foo', 'float'),
+                ClassPropertyBuilder::fromScratch('bar', 'bool'),
+            );
+
+        $expectedTestClass = <<<'EOF'
+        <?php
+        
+        declare (strict_types=1);
+        namespace MyService;
+        
+        final class TestClass
+        {
+            private string $foo;
+            private int $bar;
+        }
+        EOF;
+
+        $expectedTestClassOther = <<<'EOF'
+        <?php
+        
+        declare (strict_types=1);
+        namespace MyService;
+        
+        final class TestClassOther
+        {
+            private float $foo;
+            private bool $bar;
+            public function foo() : float
+            {
+                return $this->foo;
+            }
+            public function bar() : bool
+            {
+                return $this->bar;
+            }
+        }
+        EOF;
+
+        $fileCollection = FileCollection::fromItems($testClass, $testClassOther);
+
+        $fileCollection->filter(fn (ClassBuilder $classBuilder) => $classBuilder->getName() === 'TestClassOther')
+            ->visit(fn (ClassBuilder $classBuilder) => $this->fileCodeGenerator->addPropertiesGetterMethods($classBuilder, true, FilterFactory::methodNameFilter()));
+
+        $files = $this->fileCodeGenerator->generateFiles($fileCollection);
+
+        $this->assertArrayHasKey('/service/src/TestClassOther.php', $files);
+        $this->assertArrayHasKey('/service/src/TestClass.php', $files);
+        $this->assertSame($expectedTestClass, $files['/service/src/TestClass.php']);
+        $this->assertSame($expectedTestClassOther, $files['/service/src/TestClassOther.php']);
+    }
 }