Add file collection to generate classes and interfaces - Close #54

Author: sandrokeil

src/Builder/ClassBuilder.php

@@ -23,7 +23,7 @@
 use PhpParser\NodeVisitor;
 use PhpParser\Parser;
 
-final class ClassBuilder
+final class ClassBuilder implements File
 {
     /** @var string|null */
     private $namespace;

src/Builder/ClassBuilderCollection.php

@@ -13,6 +13,9 @@
 use Countable;
 use Iterator;
 
+/**
+ * @deprecated Use FileCollection instead
+ */
 final class ClassBuilderCollection implements Iterator, Countable
 {
     /**

src/Builder/File.php

@@ -0,0 +1,84 @@
+<?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\Builder;
+
+use PhpParser\NodeTraverser;
+use PhpParser\NodeVisitor;
+use PhpParser\Parser;
+
+interface File
+{
+    public function getNamespace(): ?string;
+
+    public function getName(): ?string;
+
+    /**
+     * @param Parser $parser
+     * @return NodeVisitor[]
+     */
+    public function generate(Parser $parser): array;
+
+    public function injectVisitors(NodeTraverser $nodeTraverser, Parser $parser): void;
+
+    public function hasConstant(string $constantName): bool;
+
+    /**
+     * Removing will not work on existing files
+     *
+     * @param string ...$constants
+     * @return $this
+     */
+    public function removeConstant(string ...$constants): self;
+
+    /**
+     * Uses uasort internally
+     *
+     * @param callable $sort (ClassConstBuilder $a, ClassConstBuilder $b)
+     * @return self
+     */
+    public function sortConstants(callable $sort): self;
+
+    public function hasMethod(string $methodName): bool;
+
+    /**
+     * Removing will not work on existing files
+     *
+     * @param string ...$methodNames
+     * @return $this
+     */
+    public function removeMethod(string ...$methodNames): self;
+
+    /**
+     * Uses uasort internally
+     *
+     * @param callable $sort (ClassMethodBuilder $a, ClassMethodBuilder $b)
+     * @return self
+     */
+    public function sortMethods(callable $sort): self;
+
+    /**
+     * Uses uasort internally
+     *
+     * @param callable $sort (string $a, string $b)
+     * @return self
+     */
+    public function sortNamespaceImports(callable $sort): self;
+
+    /**
+     * Removing will not work on existing files
+     *
+     * @param string ...$namespaceImports
+     * @return $this
+     */
+    public function removeNamespaceImport(string ...$namespaceImports): self;
+
+    public function hasNamespaceImport(string $namespace): bool;
+}

src/Builder/FileCollection.php

@@ -0,0 +1,123 @@
+<?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\Builder;
+
+use Countable;
+use Iterator;
+
+final class FileCollection implements Iterator, Countable
+{
+    /**
+     * @var array<string, File>
+     */
+    private $items;
+
+    public static function fromItems(File ...$files): self
+    {
+        return new self(...$files);
+    }
+
+    public static function emptyList(): self
+    {
+        return new self();
+    }
+
+    private function __construct(File ...$files)
+    {
+        foreach ($files as $file) {
+            $this->items[$this->identifier($file)] = $file;
+        }
+    }
+
+    public function add(File $file): self
+    {
+        $this->items[$this->identifier($file)] = $file;
+
+        return $this;
+    }
+
+    public function remove(File $file): self
+    {
+        unset($this->items[$this->identifier($file)]);
+
+        return $this;
+    }
+
+    public function contains(File $file): bool
+    {
+        return isset($this->items[$this->identifier($file)]);
+    }
+
+    public function filter(callable $filter): self
+    {
+        return new self(...\array_values(
+                \array_filter(
+                    $this->items,
+                    static function (File $file) use ($filter) {
+                        return $filter($file);
+                    }
+                )
+            )
+        );
+    }
+
+    /**
+     * @return array<string, File>
+     */
+    public function items(): array
+    {
+        return $this->items;
+    }
+
+    public function rewind(): void
+    {
+        \reset($this->items);
+    }
+
+    public function current(): File
+    {
+        return \current($this->items);
+    }
+
+    public function key(): string
+    {
+        return \key($this->items);
+    }
+
+    public function next(): void
+    {
+        \next($this->items);
+    }
+
+    public function valid(): bool
+    {
+        return \key($this->items) !== null;
+    }
+
+    public function count(): int
+    {
+        return \count($this->items);
+    }
+
+    private function identifier(File $file): string
+    {
+        $namespace = $file->getNamespace() !== null ? ('\\' . $file->getNamespace()) : '';
+        $name = $file->getName() !== null ? ('\\' . $file->getName()) : '';
+
+        $identifier = $namespace . $name;
+
+        if ($identifier === '') {
+            return \spl_object_hash($file);
+        }
+
+        return $identifier;
+    }
+}

src/Builder/InterfaceBuilder.php

@@ -21,7 +21,7 @@
 use PhpParser\NodeVisitor;
 use PhpParser\Parser;
 
-final class InterfaceBuilder
+final class InterfaceBuilder implements File
 {
     /** @var string|null */
     private $namespace;