Improve high level API

Author: sandrokeil

README.md

@@ -24,7 +24,7 @@ $classFactory = OpenCodeModeling\CodeAst\Builder\ClassBuilder::fromScratch('Test
 $classFactory
     ->setFinal(true)
     ->setExtends('BaseClass')
-    ->setNamespaceUse('Foo\\Bar')
+    ->setNamespaceImports('Foo\\Bar')
     ->setImplements('\\Iterator', 'Bar');
 
 $nodeTraverser = new PhpParser\NodeTraverser();

src/Builder/ClassBuilder.php

@@ -50,7 +50,7 @@ final class ClassBuilder
     private $implements = [];
 
     /** @var string[] */
-    private $namespaceUse = [];
+    private $namespaceImports = [];
 
     /** @var string[] */
     private $traits = [];
@@ -129,20 +129,47 @@ public function setImplements(string ...$interfaces): self
         return $this;
     }
 
-    public function setNamespaceUse(string ...$namespaces): self
+    public function setNamespace(string $namespace): self
     {
-        $this->namespaceUse = $namespaces;
+        $this->namespace = $namespace;
 
         return $this;
     }
 
-    public function setUseTrait(string ...$traits): self
+    public function setNamespaceImports(string ...$namespaceImports): self
+    {
+        $this->namespaceImports = $namespaceImports;
+
+        return $this;
+    }
+
+    /**
+     * @deprecated Use setNamespaceImports()
+     * @param string ...$namespaces
+     * @return self
+     */
+    public function setNamespaceUse(string ...$namespaces): self
+    {
+        return $this->setNamespaceImports(...$namespaces);
+    }
+
+    public function setTraits(string ...$traits): self
     {
         $this->traits = $traits;
 
         return $this;
     }
 
+    /**
+     * @deprecated Use setTraits()
+     * @param string ...$traits
+     * @return self
+     */
+    public function setUseTrait(string ...$traits): self
+    {
+        return $this->setTraits(...$traits);
+    }
+
     public function setConstants(ClassConstBuilder ...$constants): self
     {
         $this->constants = $constants;
@@ -208,21 +235,39 @@ public function getImplements(): array
     }
 
     /**
+     * @deprecated Use namespaceImports()
      * @return string[]
      */
     public function getNamespaceUse(): array
     {
-        return $this->namespaceUse;
+        return $this->namespaceImports;
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getNamespaceImports(): array
+    {
+        return $this->namespaceImports;
     }
 
     /**
+     * @deprecated Use getTraits()
      * @return string[]
      */
     public function getUseTrait(): array
     {
         return $this->traits;
     }
 
+    /**
+     * @return string[]
+     */
+    public function getTraits(): array
+    {
+        return $this->traits;
+    }
+
     /**
      * @return ClassConstBuilder[]
      */
@@ -305,13 +350,23 @@ public function sortTraits(callable $sort): self
      * @param callable $sort (string $a, string $b)
      * @return $this
      */
-    public function sortNamespaceUse(callable $sort): self
+    public function sortNamespaceImports(callable $sort): self
     {
-        \usort($this->namespaceUse, $sort);
+        \usort($this->namespaceImports, $sort);
 
         return $this;
     }
 
+    /**
+     * @deprecated Use sortNamespaceImports()
+     * @param callable $sort
+     * @return $this
+     */
+    public function sortNamespaceUse(callable $sort): self
+    {
+        return $this->sortNamespaceImports($sort);
+    }
+
     /**
      * @param Parser $parser
      * @return NodeVisitor[]
@@ -328,8 +383,8 @@ public function generate(Parser $parser): array
         if ($this->namespace) {
             $visitors[] = new ClassNamespace($this->namespace);
         }
-        if ($this->namespaceUse) {
-            $visitors[] = new NamespaceUse(...$this->namespaceUse);
+        if ($this->namespaceImports) {
+            $visitors[] = new NamespaceUse(...$this->namespaceImports);
         }
 
         $visitors[] = new ClassFile($this->classGenerator());
@@ -402,7 +457,7 @@ private function unpackNode(Node $node): void
                 }
                 break;
             case $node instanceof Node\Stmt\UseUse:
-                $this->namespaceUse[] = $node->name instanceof Node\Name\FullyQualified
+                $this->namespaceImports[] = $node->name instanceof Node\Name\FullyQualified
                     ? '\\' . $node->name->toString()
                     : $node->name->toString();
                 break;

tests/Builder/ClassBuilderTest.php

@@ -47,9 +47,9 @@ public function it_generates_class_for_empty_file(): void
         $classFactory
             ->setFinal(true)
             ->setExtends('BaseClass')
-            ->setNamespaceUse('Foo\\Bar')
+            ->setNamespaceImports('Foo\\Bar')
             ->setImplements('\\Iterator', 'Bar')
-            ->setUseTrait('\\My\\TestTrait')
+            ->setTraits('\\My\\TestTrait')
             ->setConstants(ClassConstBuilder::fromScratch('PRIV', 'private')->setPrivate());
 
         $nodeTraverser = new NodeTraverser();
@@ -103,7 +103,7 @@ final class TestClass extends BaseClass implements \Iterator, Bar
         $this->assertTrue($classFactory->isFinal());
         $this->assertTrue($classFactory->isStrict());
         $this->assertFalse($classFactory->isAbstract());
-        $this->assertSame(['\\My\\TestTrait'], $classFactory->getUseTrait());
+        $this->assertSame(['\\My\\TestTrait'], $classFactory->getTraits());
 
         $nodeTraverser = new NodeTraverser();
         $classFactory->injectVisitors($nodeTraverser, $this->parser);
@@ -191,11 +191,11 @@ final class TestClass
 
         $classFactory = ClassBuilder::fromNodes(...$ast);
 
-        $classFactory->sortNamespaceUse(function (string $a, string $b) {
+        $classFactory->sortNamespaceImports(function (string $a, string $b) {
             return $a <=> $b;
         });
 
-        $namespaceUse = $classFactory->getNamespaceUse();
+        $namespaceUse = $classFactory->getNamespaceImports();
         $this->assertCount(4, $namespaceUse);
         $this->assertSame('My\\A', $namespaceUse[0]);
         $this->assertSame('My\\B', $namespaceUse[1]);
@@ -250,7 +250,7 @@ final class TestClass
             return $a <=> $b;
         });
 
-        $useTrait = $classFactory->getUseTrait();
+        $useTrait = $classFactory->getTraits();
         $this->assertCount(4, $useTrait);
         $this->assertSame('My\\A', $useTrait[0]);
         $this->assertSame('My\\B', $useTrait[1]);