Initial work on metadata objects for #4502

Author: sebastianbergmann

src/Util/Metadata/Metadata.php

@@ -0,0 +1,97 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Util\Metadata;
+
+/**
+ * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ * @psalm-immutable
+ */
+abstract class Metadata
+{
+    public function isAfter(): bool
+    {
+        return false;
+    }
+
+    public function isAfterClass(): bool
+    {
+        return false;
+    }
+
+    public function isBackupGlobals(): bool
+    {
+        return false;
+    }
+
+    public function isBackupStaticProperties(): bool
+    {
+        return false;
+    }
+
+    public function isBeforeClass(): bool
+    {
+        return false;
+    }
+
+    public function isBefore(): bool
+    {
+        return false;
+    }
+
+    public function isCodeCoverageIgnore(): bool
+    {
+        return false;
+    }
+
+    public function isCoversNothing(): bool
+    {
+        return false;
+    }
+
+    public function isDoesNotPerformAssertions(): bool
+    {
+        return false;
+    }
+
+    public function isGroup(): bool
+    {
+        return false;
+    }
+
+    public function isRunTestsInSeparateProcesses(): bool
+    {
+        return false;
+    }
+
+    public function isRunInSeparateProcess(): bool
+    {
+        return false;
+    }
+
+    public function isTest(): bool
+    {
+        return false;
+    }
+
+    public function isPreCondition(): bool
+    {
+        return false;
+    }
+
+    public function isPostCondition(): bool
+    {
+        return false;
+    }
+
+    public function isPreserveGlobalState(): bool
+    {
+        return false;
+    }
+}

src/Util/Metadata/MetadataCollection.php

@@ -0,0 +1,67 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Util\Metadata;
+
+use function count;
+use Countable;
+use IteratorAggregate;
+
+/**
+ * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ * @psalm-immutable
+ */
+final class MetadataCollection implements Countable, IteratorAggregate
+{
+    /**
+     * @var Metadata[]
+     */
+    private $metadata;
+
+    /**
+     * @param Metadata[] $metadata
+     */
+    public static function fromArray(array $metadata): self
+    {
+        return new self(...$metadata);
+    }
+
+    private function __construct(Metadata ...$metadata)
+    {
+        $this->metadata = $metadata;
+    }
+
+    /**
+     * @return Metadata[]
+     */
+    public function asArray(): array
+    {
+        return $this->metadata;
+    }
+
+    public function count(): int
+    {
+        return count($this->metadata);
+    }
+
+    public function getIterator(): MetadataCollectionIterator
+    {
+        return new MetadataCollectionIterator($this);
+    }
+
+    public function mergeWith(self $other): self
+    {
+        return new self(
+            array_merge(
+                $this->asArray(),
+                $other->asArray()
+            )
+        );
+    }
+}

src/Util/Metadata/MetadataCollectionIterator.php

@@ -0,0 +1,66 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Util\Metadata;
+
+use function count;
+use function iterator_count;
+use Countable;
+use Iterator;
+
+/**
+ * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ */
+final class MetadataCollectionIterator implements Countable, Iterator
+{
+    /**
+     * @var Metadata[]
+     */
+    private $metadata;
+
+    /**
+     * @var int
+     */
+    private $position = 0;
+
+    public function __construct(MetadataCollection $metadata)
+    {
+        $this->metadata = $metadata->asArray();
+    }
+
+    public function count(): int
+    {
+        return iterator_count($this);
+    }
+
+    public function rewind(): void
+    {
+        $this->position = 0;
+    }
+
+    public function valid(): bool
+    {
+        return $this->position < count($this->metadata);
+    }
+
+    public function key(): int
+    {
+        return $this->position;
+    }
+
+    public function current(): Metadata
+    {
+        return $this->metadata[$this->position];
+    }
+
+    public function next(): void
+    {
+        $this->position++;
+    }
+}

src/Util/Metadata/Reader/AnnotationReader.php

@@ -0,0 +1,32 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Util\Metadata;
+
+/**
+ * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ */
+final class AnnotationReader implements Reader
+{
+    /**
+     * @psalm-param class-string $className
+     */
+    public function forClass(string $className): MetadataCollection
+    {
+        return MetadataCollection::fromArray([]);
+    }
+
+    /**
+     * @psalm-param class-string $className
+     */
+    public function forMethod(string $className, string $methodName): MetadataCollection
+    {
+        return MetadataCollection::fromArray([]);
+    }
+}

src/Util/Metadata/Reader/AttributeReader.php

@@ -0,0 +1,32 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Util\Metadata;
+
+/**
+ * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ */
+final class AttributeReader implements Reader
+{
+    /**
+     * @psalm-param class-string $className
+     */
+    public function forClass(string $className): MetadataCollection
+    {
+        return MetadataCollection::fromArray([]);
+    }
+
+    /**
+     * @psalm-param class-string $className
+     */
+    public function forMethod(string $className, string $methodName): MetadataCollection
+    {
+        return MetadataCollection::fromArray([]);
+    }
+}

src/Util/Metadata/Reader/CachingReader.php

@@ -0,0 +1,61 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Util\Metadata;
+
+/**
+ * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ */
+final class CachingReader implements Reader
+{
+    /**
+     * @var Reader
+     */
+    private $reader;
+
+    /**
+     * @var array
+     */
+    private $cache = [];
+
+    public function __construct(Reader $reader)
+    {
+        $this->reader = $reader;
+    }
+
+    /**
+     * @psalm-param class-string $className
+     */
+    public function forClass(string $className): MetadataCollection
+    {
+        if (isset($this->cache[$className])) {
+            return $this->cache[$className];
+        }
+
+        $this->cache[$className] = $this->reader->forClass($className);
+
+        return $this->cache[$className];
+    }
+
+    /**
+     * @psalm-param class-string $className
+     */
+    public function forMethod(string $className, string $methodName): MetadataCollection
+    {
+        $key = $className . '::' . $methodName;
+
+        if (isset($this->cache[$key])) {
+            return $this->cache[$key];
+        }
+
+        $this->cache[$key] = $this->reader->forMethod($className, $methodName);
+
+        return $this->cache[$key];
+    }
+}