Always put properties / constants before methods when no one exists - #75

Author: sandrokeil

src/NodeVisitor/ClassConstant.php

@@ -45,7 +45,7 @@ public function afterTraverse(array $nodes): ?array
                         }
                         \array_splice(
                             $stmt->stmts,
-                            $this->findInsertPositionForType($stmt->stmts, Node\Stmt\ClassConst::class),
+                            $this->findInsertPositionForType($stmt->stmts, Node\Stmt\ClassConst::class, [Node\Stmt\ClassMethod::class]),
                             0,
                             $this->lineGenerator->generate()
                         );
@@ -57,7 +57,7 @@ public function afterTraverse(array $nodes): ?array
                 }
                 \array_splice(
                     $node->stmts,
-                    $this->findInsertPositionForType($node->stmts, Node\Stmt\ClassConst::class),
+                    $this->findInsertPositionForType($node->stmts, Node\Stmt\ClassConst::class, [Node\Stmt\ClassMethod::class]),
                     0,
                     $this->lineGenerator->generate()
                 );

src/NodeVisitor/FindInsertPositionForType.php

@@ -17,20 +17,35 @@ trait FindInsertPositionForType
     /**
      * @param Stmt[] $stmts
      * @param string $type
+     * @param array $decTypes List of types (FQCN) where position should be decremented
+     * @param array $incTypes List of types (FQCN) where position should be incremented
      * @return int
      */
-    private function findInsertPositionForType(array $stmts, string $type): int
-    {
-        $pos = 0;
+    private function findInsertPositionForType(
+        array $stmts,
+        string $type,
+        array $decTypes = [],
+        array $incTypes = []
+    ): int {
+        $pos = -1;
         $length = 0;
 
         foreach ($stmts as $key => $stmt) {
+            $class = \get_class($stmt);
+
             if ($stmt instanceof $type) {
                 $pos = (int) $key;
             }
             $length++;
+
+            if (true === \in_array($class, $decTypes, true)) {
+                $length--;
+            }
+            if (true === \in_array($class, $incTypes, true)) {
+                $length++;
+            }
         }
 
-        return $pos === 0 ? ++$length : ++$pos;
+        return $pos === -1 ? $length : ++$pos;
     }
 }

src/NodeVisitor/Property.php

@@ -46,7 +46,7 @@ public function afterTraverse(array $nodes): ?array
                         }
                         \array_splice(
                             $stmt->stmts,
-                            $this->findInsertPositionForType($stmt->stmts, Node\Stmt\Property::class),
+                            $this->findInsertPositionForType($stmt->stmts, Node\Stmt\Property::class, [Node\Stmt\ClassMethod::class]),
                             0,
                             [$this->propertyGenerator->generate()]
                         );
@@ -58,7 +58,7 @@ public function afterTraverse(array $nodes): ?array
                 }
                 \array_splice(
                     $node->stmts,
-                    $this->findInsertPositionForType($node->stmts, Node\Stmt\Property::class),
+                    $this->findInsertPositionForType($node->stmts, Node\Stmt\Property::class, [Node\Stmt\ClassMethod::class]),
                     0,
                     [$this->propertyGenerator->generate()]
                 );

tests/Builder/ClassBuilderTest.php

@@ -228,6 +228,74 @@ public function test() : void
         $this->assertSame($expected, $this->printer->prettyPrintFile($nodeTraverser->traverse($this->parser->parse(''))));
     }
 
+    /**
+     * @test
+     */
+    public function it_supports_adding_of_class_constants_before_methods_with_doc_blocks(): void
+    {
+        $code = <<<'EOF'
+<?php
+
+declare (strict_types=1);
+namespace My\Awesome\Service;
+
+final class TestClass
+{
+    /**
+     * Define aggregate names using constants
+     *
+     * @example
+     *
+     * const USER = 'User';
+     */
+
+
+    /**
+     * @param EventEngine $eventEngine
+     */
+    public static function describe(EventEngine $eventEngine): void
+    {
+    }
+}
+EOF;
+
+        $ast = $this->parser->parse($code);
+
+        $classFactory = ClassBuilder::fromScratch('TestClass', 'My\Awesome\Service');
+        $classFactory->addConstant(ClassConstBuilder::fromScratch('FIRST', 1));
+        $classFactory->addConstant(ClassConstBuilder::fromScratch('PUB', 'public'));
+
+        $expected = <<<'EOF'
+<?php
+
+declare (strict_types=1);
+namespace My\Awesome\Service;
+
+final class TestClass
+{
+    public const FIRST = 1;
+    public const PUB = 'public';
+    /**
+     * Define aggregate names using constants
+     *
+     * @example
+     *
+     * const USER = 'User';
+     */
+    /**
+     * @param EventEngine $eventEngine
+     */
+    public static function describe(EventEngine $eventEngine) : void
+    {
+    }
+}
+EOF;
+        $nodeTraverser = new NodeTraverser();
+        $classFactory->injectVisitors($nodeTraverser, $this->parser);
+
+        $this->assertSame($expected, $this->printer->prettyPrintFile($nodeTraverser->traverse($ast)));
+    }
+
     /**
      * @test
      */

tests/Builder/ClassPropertyBuilderTest.php

@@ -166,6 +166,74 @@ class TestClass
         $this->assertSame($expected, $this->printer->prettyPrintFile($nodeTraverser->traverse($this->parser->parse(''))));
     }
 
+    /**
+     * @test
+     */
+    public function it_supports_adding_of_properties_before_methods_with_doc_blocks(): void
+    {
+        $code = <<<'EOF'
+        <?php
+        
+        declare (strict_types=1);
+        namespace My\Awesome\Service;
+        
+        final class TestClass
+        {
+            /**
+             * Define aggregate names using constants
+             *
+             * @example
+             *
+             * const USER = 'User';
+             */
+        
+        
+            /**
+             * @param EventEngine $eventEngine
+             */
+            public static function describe(EventEngine $eventEngine): void
+            {
+            }
+        }
+        EOF;
+
+        $ast = $this->parser->parse($code);
+
+        $classFactory = ClassBuilder::fromScratch('TestClass', 'My\Awesome\Service');
+        $classFactory->addProperty(ClassPropertyBuilder::fromScratch('first', 'string'));
+        $classFactory->addProperty(ClassPropertyBuilder::fromScratch('pub', 'array'));
+
+        $expected = <<<'EOF'
+        <?php
+        
+        declare (strict_types=1);
+        namespace My\Awesome\Service;
+        
+        final class TestClass
+        {
+            private string $first;
+            private array $pub;
+            /**
+             * Define aggregate names using constants
+             *
+             * @example
+             *
+             * const USER = 'User';
+             */
+            /**
+             * @param EventEngine $eventEngine
+             */
+            public static function describe(EventEngine $eventEngine) : void
+            {
+            }
+        }
+        EOF;
+        $nodeTraverser = new NodeTraverser();
+        $classFactory->injectVisitors($nodeTraverser, $this->parser);
+
+        $this->assertSame($expected, $this->printer->prettyPrintFile($nodeTraverser->traverse($ast)));
+    }
+
     /**
      * @test
      */