summaryrefslogtreecommitdiff
path: root/vendor/phpunit/phpunit/src/Framework/Constraint/Cardinality/Count.php
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/phpunit/phpunit/src/Framework/Constraint/Cardinality/Count.php')
-rw-r--r--vendor/phpunit/phpunit/src/Framework/Constraint/Cardinality/Count.php142
1 files changed, 142 insertions, 0 deletions
diff --git a/vendor/phpunit/phpunit/src/Framework/Constraint/Cardinality/Count.php b/vendor/phpunit/phpunit/src/Framework/Constraint/Cardinality/Count.php
new file mode 100644
index 000000000..8e27fbfd4
--- /dev/null
+++ b/vendor/phpunit/phpunit/src/Framework/Constraint/Cardinality/Count.php
@@ -0,0 +1,142 @@
+<?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\Framework\Constraint;
+
+use function count;
+use function is_array;
+use function iterator_count;
+use function sprintf;
+use Countable;
+use EmptyIterator;
+use Generator;
+use Iterator;
+use IteratorAggregate;
+use PHPUnit\Framework\Exception;
+use Traversable;
+
+/**
+ * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ */
+class Count extends Constraint
+{
+ /**
+ * @var int
+ */
+ private $expectedCount;
+
+ public function __construct(int $expected)
+ {
+ $this->expectedCount = $expected;
+ }
+
+ public function toString(): string
+ {
+ return sprintf(
+ 'count matches %d',
+ $this->expectedCount
+ );
+ }
+
+ /**
+ * Evaluates the constraint for parameter $other. Returns true if the
+ * constraint is met, false otherwise.
+ *
+ * @throws Exception
+ */
+ protected function matches($other): bool
+ {
+ return $this->expectedCount === $this->getCountOf($other);
+ }
+
+ /**
+ * @throws Exception
+ */
+ protected function getCountOf($other): ?int
+ {
+ if ($other instanceof Countable || is_array($other)) {
+ return count($other);
+ }
+
+ if ($other instanceof EmptyIterator) {
+ return 0;
+ }
+
+ if ($other instanceof Traversable) {
+ while ($other instanceof IteratorAggregate) {
+ try {
+ $other = $other->getIterator();
+ } catch (\Exception $e) {
+ throw new Exception(
+ $e->getMessage(),
+ $e->getCode(),
+ $e
+ );
+ }
+ }
+
+ $iterator = $other;
+
+ if ($iterator instanceof Generator) {
+ return $this->getCountOfGenerator($iterator);
+ }
+
+ if (!$iterator instanceof Iterator) {
+ return iterator_count($iterator);
+ }
+
+ $key = $iterator->key();
+ $count = iterator_count($iterator);
+
+ // Manually rewind $iterator to previous key, since iterator_count
+ // moves pointer.
+ if ($key !== null) {
+ $iterator->rewind();
+
+ while ($iterator->valid() && $key !== $iterator->key()) {
+ $iterator->next();
+ }
+ }
+
+ return $count;
+ }
+
+ return null;
+ }
+
+ /**
+ * Returns the total number of iterations from a generator.
+ * This will fully exhaust the generator.
+ */
+ protected function getCountOfGenerator(Generator $generator): int
+ {
+ for ($count = 0; $generator->valid(); $generator->next()) {
+ $count++;
+ }
+
+ return $count;
+ }
+
+ /**
+ * Returns the description of the failure.
+ *
+ * The beginning of failure messages is "Failed asserting that" in most
+ * cases. This method should return the second part of that sentence.
+ *
+ * @param mixed $other evaluated value or object
+ */
+ protected function failureDescription($other): string
+ {
+ return sprintf(
+ 'actual size %d matches expected size %d',
+ (int) $this->getCountOf($other),
+ $this->expectedCount
+ );
+ }
+}