Support final and abstract in ClassMethodBuilder - Close #24

Author: sandrokeil

src/Builder/ClassMethodBuilder.php

@@ -57,6 +57,12 @@ final class ClassMethodBuilder
      */
     private $docBlock;
 
+    /** @var bool */
+    private $final = false;
+
+    /** @var bool */
+    private $abstract = false;
+
     private function __construct()
     {
     }
@@ -68,6 +74,8 @@ public static function fromNode(Node\Stmt\ClassMethod $node): self
         $self->name = $node->name->toString();
         $self->returnType = $node->returnType ? $node->returnType->toString() : null;
         $self->visibility = $node->flags;
+        $self->abstract = ($node->flags & MethodGenerator::FLAG_ABSTRACT) > 0;
+        $self->final = ($node->flags & MethodGenerator::FLAG_FINAL) > 0;
 
         foreach ($node->params as $param) {
             $self->parameters[] = ParameterBuilder::fromNode($param);
@@ -182,6 +190,30 @@ public function overrideDocBlock(?DocBlock $docBlock): void
         $this->docBlock = $docBlock;
     }
 
+    public function setFinal(bool $final): self
+    {
+        $this->final = $final;
+
+        return $this;
+    }
+
+    public function setAbstract(bool $abstract): self
+    {
+        $this->abstract = $abstract;
+
+        return $this;
+    }
+
+    public function isFinal(): bool
+    {
+        return $this->final;
+    }
+
+    public function isAbstract(): bool
+    {
+        return $this->abstract;
+    }
+
     public function generate(Parser $parser): NodeVisitor
     {
         return new ClassMethod($this->methodGenerator($parser));
@@ -191,7 +223,18 @@ private function methodGenerator(Parser $parser): MethodGenerator
     {
         $flags = $this->visibility;
 
-        $body = new BodyGenerator($parser, $this->body);
+        if ($this->final) {
+            $flags |= MethodGenerator::FLAG_FINAL;
+        }
+        if ($this->abstract) {
+            $flags |= MethodGenerator::FLAG_ABSTRACT;
+        }
+
+        $body = null;
+
+        if (false === $this->isAbstract()) {
+            $body = new BodyGenerator($parser, $this->body);
+        }
 
         $methodGenerator = new MethodGenerator(
             $this->name,

tests/Builder/ClassMethodBuilderTest.php

@@ -45,7 +45,22 @@ public function it_generates_method_for_empty_class(): void
         $ast = $this->parser->parse('');
 
         $classFactory = ClassBuilder::fromScratch('TestClass', 'My\\Awesome\\Service');
-        $classFactory->setMethods(ClassMethodBuilder::fromScratch('setActive')->setReturnType('void'));
+        $classFactory->setMethods(
+            ClassMethodBuilder::fromScratch('setActive')->setReturnType('void'),
+            ClassMethodBuilder::fromScratch('doSomething')->setReturnType('void')->setFinal(true)
+        );
+
+        $methods = $classFactory->getMethods();
+
+        $this->assertCount(2, $methods);
+
+        $this->assertSame('setActive', $methods[0]->getName());
+        $this->assertFalse($methods[0]->isAbstract());
+        $this->assertFalse($methods[0]->isFinal());
+
+        $this->assertSame('doSomething', $methods[1]->getName());
+        $this->assertFalse($methods[1]->isAbstract());
+        $this->assertTrue($methods[1]->isFinal());
 
         $nodeTraverser = new NodeTraverser();
         $classFactory->injectVisitors($nodeTraverser, $this->parser);
@@ -61,6 +76,45 @@ class TestClass
     public function setActive() : void
     {
     }
+    public final function doSomething() : void
+    {
+    }
+}
+EOF;
+
+        $this->assertSame($expected, $this->printer->prettyPrintFile($nodeTraverser->traverse($ast)));
+    }
+
+    /**
+     * @test
+     */
+    public function it_generates_abstract_method_for_empty_class(): void
+    {
+        $ast = $this->parser->parse('');
+
+        $classFactory = ClassBuilder::fromScratch('TestClass', 'My\\Awesome\\Service');
+        $classFactory->setMethods(ClassMethodBuilder::fromScratch('setActive')->setReturnType('void')->setAbstract(true));
+
+        $methods = $classFactory->getMethods();
+
+        $this->assertCount(1, $methods);
+
+        $this->assertSame('setActive', $methods[0]->getName());
+        $this->assertTrue($methods[0]->isAbstract());
+        $this->assertFalse($methods[0]->isFinal());
+
+        $nodeTraverser = new NodeTraverser();
+        $classFactory->injectVisitors($nodeTraverser, $this->parser);
+
+        $expected = <<<'EOF'
+<?php
+
+declare (strict_types=1);
+namespace My\Awesome\Service;
+
+class TestClass
+{
+    public abstract function setActive() : void;
 }
 EOF;
 
@@ -83,6 +137,48 @@ class TestClass
     public function setActive() : void
     {
     }
+    public final function doSomething() : void
+    {
+    }
+}
+EOF;
+
+        $ast = $this->parser->parse($expected);
+
+        $classFactory = ClassBuilder::fromNodes(...$ast);
+
+        $methods = $classFactory->getMethods();
+
+        $this->assertCount(2, $methods);
+
+        $this->assertSame('setActive', $methods[0]->getName());
+        $this->assertFalse($methods[0]->isAbstract());
+        $this->assertFalse($methods[0]->isFinal());
+
+        $this->assertSame('doSomething', $methods[1]->getName());
+        $this->assertFalse($methods[1]->isAbstract());
+        $this->assertTrue($methods[1]->isFinal());
+
+        $nodeTraverser = new NodeTraverser();
+        $classFactory->injectVisitors($nodeTraverser, $this->parser);
+
+        $this->assertSame($expected, $this->printer->prettyPrintFile($nodeTraverser->traverse($this->parser->parse(''))));
+    }
+
+    /**
+     * @test
+     */
+    public function it_generates_abstract_method_for_empty_class_from_template(): void
+    {
+        $expected = <<<'EOF'
+<?php
+
+declare (strict_types=1);
+namespace My\Awesome\Service;
+
+class TestClass
+{
+    public abstract function setActive() : void;
 }
 EOF;
 
@@ -95,6 +191,8 @@ public function setActive() : void
         $this->assertCount(1, $methods);
 
         $this->assertSame('setActive', $methods[0]->getName());
+        $this->assertTrue($methods[0]->isAbstract());
+        $this->assertFalse($methods[0]->isFinal());
 
         $nodeTraverser = new NodeTraverser();
         $classFactory->injectVisitors($nodeTraverser, $this->parser);