Always put properties before methods - close #75

Author: sandrokeil

src/Builder/ClassPropertyBuilder.php

@@ -144,6 +144,15 @@ public function getType(): ?string
         return $this->type;
     }
 
+    public function setType(string $type): self
+    {
+        $this->type = $type;
+
+        $this->propertyGenerator->setType($type);
+
+        return $this;
+    }
+
     public function setTyped(bool $typed): self
     {
         $this->typed = $typed;

src/NodeVisitor/ClassConstant.php

@@ -18,6 +18,8 @@
 
 final class ClassConstant extends NodeVisitorAbstract
 {
+    use FindInsertPositionForType;
+
     /**
      * @var IdentifierGenerator
      */
@@ -41,8 +43,10 @@ public function afterTraverse(array $nodes): ?array
                         if ($this->checkConstantExists($stmt)) {
                             return null;
                         }
-                        $stmt->stmts = \array_merge(
+                        \array_splice(
                             $stmt->stmts,
+                            $this->findInsertPositionForType($stmt->stmts, Node\Stmt\ClassConst::class),
+                            0,
                             $this->lineGenerator->generate()
                         );
                     }
@@ -51,8 +55,10 @@ public function afterTraverse(array $nodes): ?array
                 if ($this->checkConstantExists($node)) {
                     return null;
                 }
-                $node->stmts = \array_merge(
+                \array_splice(
                     $node->stmts,
+                    $this->findInsertPositionForType($node->stmts, Node\Stmt\ClassConst::class),
+                    0,
                     $this->lineGenerator->generate()
                 );
             }

src/NodeVisitor/FindInsertPositionForType.php

@@ -0,0 +1,36 @@
+<?php
+
+/**
+ * @see       https://github.com/open-code-modeling/php-code-ast for the canonical source repository
+ * @copyright https://github.com/open-code-modeling/php-code-ast/blob/master/COPYRIGHT.md
+ * @license   https://github.com/open-code-modeling/php-code-ast/blob/master/LICENSE.md MIT License
+ */
+
+declare(strict_types=1);
+
+namespace OpenCodeModeling\CodeAst\NodeVisitor;
+
+use PhpParser\Node\Stmt;
+
+trait FindInsertPositionForType
+{
+    /**
+     * @param Stmt[] $stmts
+     * @param string $type
+     * @return int
+     */
+    private function findInsertPositionForType(array $stmts, string $type): int
+    {
+        $pos = 0;
+        $length = 0;
+
+        foreach ($stmts as $key => $stmt) {
+            if ($stmt instanceof $type) {
+                $pos = (int) $key;
+            }
+            $length++;
+        }
+
+        return $pos === 0 ? ++$length : ++$pos;
+    }
+}

src/NodeVisitor/Property.php

@@ -19,6 +19,8 @@
 
 final class Property extends NodeVisitorAbstract
 {
+    use FindInsertPositionForType;
+
     /**
      * @var PropertyGenerator
      **/
@@ -42,14 +44,24 @@ public function afterTraverse(array $nodes): ?array
                         if ($this->checkPropertyExists($stmt)) {
                             return null;
                         }
-                        $stmt->stmts[] = $this->propertyGenerator->generate();
+                        \array_splice(
+                            $stmt->stmts,
+                            $this->findInsertPositionForType($stmt->stmts, Node\Stmt\Property::class),
+                            0,
+                            [$this->propertyGenerator->generate()]
+                        );
                     }
                 }
             } elseif ($node instanceof Stmt\Class_) {
                 if ($this->checkPropertyExists($node)) {
                     return null;
                 }
-                $node->stmts[] = $this->propertyGenerator->generate();
+                \array_splice(
+                    $node->stmts,
+                    $this->findInsertPositionForType($node->stmts, Node\Stmt\Property::class),
+                    0,
+                    [$this->propertyGenerator->generate()]
+                );
             }
         }
 

tests/Builder/ClassBuilderTest.php

@@ -177,6 +177,57 @@ final class TestClass
         $this->assertSame($expected, $this->printer->prettyPrintFile($nodeTraverser->traverse($this->parser->parse(''))));
     }
 
+    /**
+     * @test
+     */
+    public function it_supports_adding_of_class_constants_before_property(): void
+    {
+        $code = <<<'EOF'
+<?php
+
+declare (strict_types=1);
+namespace My\Awesome\Service;
+
+final class TestClass
+{
+    use TestTrait;
+    protected $property;
+    
+    public function test(): void
+    {
+    }
+}
+EOF;
+
+        $ast = $this->parser->parse($code);
+
+        $classFactory = ClassBuilder::fromNodes(...$ast);
+        $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
+{
+    use TestTrait;
+    public const FIRST = 1;
+    public const PUB = 'public';
+    protected $property;
+    public function test() : void
+    {
+    }
+}
+EOF;
+        $nodeTraverser = new NodeTraverser();
+        $classFactory->injectVisitors($nodeTraverser, $this->parser);
+
+        $this->assertSame($expected, $this->printer->prettyPrintFile($nodeTraverser->traverse($this->parser->parse(''))));
+    }
+
     /**
      * @test
      */
@@ -191,6 +242,10 @@ public function it_supports_adding_of_class_constants(): void
 final class TestClass
 {
     protected const PROT = 'protected';
+    
+    public function test(): void
+    {
+    }
 }
 EOF;
 
@@ -211,6 +266,9 @@ final class TestClass
     protected const PROT = 'protected';
     public const FIRST = 1;
     public const PUB = 'public';
+    public function test() : void
+    {
+    }
 }
 EOF;
         $nodeTraverser = new NodeTraverser();

tests/Builder/ClassPropertyBuilderTest.php

@@ -179,7 +179,11 @@ public function it_supports_adding_of_class_properties(): void
 
 class TestClass
 {
+    public const TEST = 1;
     private $a;
+    public function test(): void
+    {
+    }
 }
 EOF;
 
@@ -199,10 +203,14 @@ class TestClass
 
 class TestClass
 {
+    public const TEST = 1;
     private string $a;
     private string $b;
     private string $c;
     private string $d;
+    public function test() : void
+    {
+    }
 }
 EOF;