Rework unit tests

composer.json

@@ -17,7 +17,7 @@
         "php": "^8.1"
     },
     "require-dev": {
-        "phpunit/phpunit": "9.5.*",
+        "phpunit/phpunit": "10.0.*",
         "steevanb/php-backtrace": "2.1.*",
         "symfony/config": "6.1.*",
         "symfony/dependency-injection": "6.1.*",

config/ci/phpunit.php-8.1.xml

@@ -1,17 +1,21 @@
+<?xml version="1.0"?>
+<!-- add requireCoverageMetadata="true" -->
 <phpunit
-    cacheResultFile="../../var/ci/phpunit/php-8.1/.phpunit.result.cache"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd"
     colors="true"
+    failOnRisky="true"
+    failOnWarning="true"
+    cacheDirectory="../../var/ci/phpunit/php-8.1"
 >
     <testsuites>
         <testsuite name="default">
             <directory>../../tests</directory>
         </testsuite>
     </testsuites>
-    <coverage
-        cacheDirectory="../../var/ci/phpunit/code-coverage"
-        processUncoveredFiles="true"
-    >
+    <coverage cacheDirectory="../../var/ci/phpunit/code-coverage">
         <include>
+            <directory suffix=".php">../../bridge</directory>
             <directory suffix=".php">../../src</directory>
         </include>
     </coverage>

config/ci/phpunit.php-8.2.xml

@@ -1,6 +1,12 @@
+<?xml version="1.0"?>
 <phpunit
-    cacheResultFile="../../var/ci/phpunit/php-8.2/.phpunit.result.cache"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd"
     colors="true"
+    requireCoverageMetadata="true"
+    failOnRisky="true"
+    failOnWarning="true"
+    cacheDirectory="../../var/ci/phpunit/php-8.2"
 >
     <testsuites>
         <testsuite name="default">

src/AbstractCollection.php

@@ -36,11 +36,9 @@ public function hasKey(string|int $key): bool
 
     public function remove(string|int $key): static
     {
-        $this->assertIsNotReadOnly();
-
-        if ($this->hasKey($key) === false) {
-            throw new KeyNotFoundException('Key "' . $key . '" not found.');
-        }
+        $this
+            ->assertIsNotReadOnly()
+            ->assertHasKey($key);
 
         unset($this->values[$key]);
 
@@ -155,12 +153,19 @@ protected function doReplace(iterable $values): static
     }
 
     protected function doGet(string|int $key): mixed
+    {
+        $this->assertHasKey($key);
+
+        return $this->values[$key];
+    }
+
+    protected function assertHasKey(string|int $key): static
     {
         if ($this->hasKey($key) === false) {
-            throw new KeyNotFoundException('Key "' . $key . '" not found.');
+            throw new KeyNotFoundException($key);
         }
 
-        return $this->values[$key];
+        return $this;
     }
 
     protected function doHas(mixed $value): bool

src/Exception/KeyNotFoundException.php

@@ -6,4 +6,8 @@
 
 class KeyNotFoundException extends PhpCollectionException
 {
+    public function __construct(string|int $key)
+    {
+        parent::__construct('Key "' . $key . '" not found.');
+    }
 }

tests/Unit/AbstractCollection/ChangeKeyCaseTest.php

@@ -7,11 +7,12 @@
 use PHPUnit\Framework\TestCase;
 use Steevanb\PhpCollection\KeyCaseEnum;
 
+/** @covers \Steevanb\PhpCollection\AbstractCollection::changeKeyCase */
 final class ChangeKeyCaseTest extends TestCase
 {
     public function testDefaultParameters(): void
     {
-        $collection = new Collection(['foo' => 1]);
+        $collection = new TestCollection(['foo' => 1]);
 
         $collection->changeKeyCase();
 
@@ -22,7 +23,7 @@ public function testDefaultParameters(): void
 
     public function testLowerCaseAssociativesKeys(): void
     {
-        $collection = new Collection(['foo' => 1, 'BaR' => 2, 'BAZ' => 3]);
+        $collection = new TestCollection(['foo' => 1, 'BaR' => 2, 'BAZ' => 3]);
 
         $collection->changeKeyCase(KeyCaseEnum::LOWER);
 
@@ -37,7 +38,7 @@ public function testLowerCaseAssociativesKeys(): void
 
     public function testUpperCaseAssociativesKeys(): void
     {
-        $collection = new Collection(['foo' => 1, 'BaR' => 2, 'BAZ' => 3]);
+        $collection = new TestCollection(['foo' => 1, 'BaR' => 2, 'BAZ' => 3]);
 
         $collection->changeKeyCase(KeyCaseEnum::UPPER);
 
@@ -52,7 +53,7 @@ public function testUpperCaseAssociativesKeys(): void
 
     public function testLowerCaseIndexedKeys(): void
     {
-        $collection = new Collection([0 => 1, 10 => 2, 20 => 3]);
+        $collection = new TestCollection([0 => 1, 10 => 2, 20 => 3]);
 
         $collection->changeKeyCase(KeyCaseEnum::LOWER);
 
@@ -67,7 +68,7 @@ public function testLowerCaseIndexedKeys(): void
 
     public function testUpperCaseIndexedKeys(): void
     {
-        $collection = new Collection([0 => 1, 10 => 2, 20 => 3]);
+        $collection = new TestCollection([0 => 1, 10 => 2, 20 => 3]);
 
         $collection->changeKeyCase(KeyCaseEnum::UPPER);
 
@@ -82,19 +83,12 @@ public function testUpperCaseIndexedKeys(): void
 
     public function testEmpty(): void
     {
-        $collection = new Collection();
+        $collection = new TestCollection();
 
         static::assertCount(0, $collection);
 
         $collection->changeKeyCase();
 
         static::assertCount(0, $collection);
     }
-
-    public function testReturnType(): void
-    {
-        $collection = new Collection();
-
-        static::assertSame($collection, $collection->changeKeyCase());
-    }
 }

tests/Unit/AbstractCollection/ClearTest.php

@@ -6,11 +6,12 @@
 
 use PHPUnit\Framework\TestCase;
 
+/** @covers \Steevanb\PhpCollection\AbstractCollection::clear */
 final class ClearTest extends TestCase
 {
     public function testEmpty(): void
     {
-        $collection = new Collection();
+        $collection = new TestCollection();
 
         static::assertCount(0, $collection);
 
@@ -25,7 +26,7 @@ public function testEmpty(): void
 
     public function testOneItem(): void
     {
-        $collection = new Collection([1]);
+        $collection = new TestCollection([1]);
 
         static::assertCount(1, $collection);
 
@@ -40,7 +41,7 @@ public function testOneItem(): void
 
     public function testThreeItem(): void
     {
-        $collection = new Collection([1, 2, 3]);
+        $collection = new TestCollection([1, 2, 3]);
 
         static::assertCount(3, $collection);
 

tests/Unit/AbstractCollection/CountableTest.php

@@ -6,10 +6,11 @@
 
 use PHPUnit\Framework\TestCase;
 
+/** @coversNothing */
 final class CountableTest extends TestCase
 {
     public function testCount(): void
     {
-        static::assertCount(3, new Collection([1, '2', null]));
+        static::assertCount(3, new TestCollection([1, '2', null]));
     }
 }

tests/Unit/AbstractCollection/DoAddTest.php

@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Steevanb\PhpCollection\Tests\Unit\AbstractCollection;
+
+use PHPUnit\Framework\TestCase;
+use Steevanb\PhpCollection\{
+    Exception\ReadOnlyException,
+    Exception\ValueAlreadyExistsException,
+    ValueAlreadyExistsModeEnum
+};
+
+/** @covers \Steevanb\PhpCollection\AbstractCollection::doAdd */
+final class DoAddTest extends TestCase
+{
+    public function testOneValue(): void
+    {
+        $collection = (new TestCollection())
+            ->callDoAdd('foo');
+
+        static::assertSame('foo', $collection->callDoGet(0));
+    }
+
+    public function testTreeValue(): void
+    {
+        $collection = (new TestCollection())
+            ->callDoAdd('foo')
+            ->callDoAdd('bar')
+            ->callDoAdd('baz');
+
+        static::assertSame('foo', $collection->callDoGet(0));
+        static::assertSame('bar', $collection->callDoGet(1));
+        static::assertSame('baz', $collection->callDoGet(2));
+    }
+
+    public function testReadOnly(): void
+    {
+        $collection = (new TestCollection([1, 2]))->setReadOnly();
+
+        $this->expectException(ReadOnlyException::class);
+        $this->expectExceptionMessage('This collection is read only, you cannot edit it\'s values.');
+        $this->expectExceptionCode(0);
+        $collection->callDoAdd(3);
+    }
+
+    public function testValueAlreadyExistsDoNotAdd(): void
+    {
+        $collection = new TestCollection([], ValueAlreadyExistsModeEnum::DO_NOT_ADD);
+        $collection
+            ->callDoAdd(10)
+            ->callDoAdd(11)
+            ->callDoAdd(11)
+            ->callDoAdd(13);
+
+        static::assertCount(3, $collection);
+        static::assertSame(10, $collection->callDoGet(0));
+        static::assertSame(11, $collection->callDoGet(1));
+        static::assertSame(13, $collection->callDoGet(2));
+    }
+
+    public function testException(): void
+    {
+        $collection = new TestCollection([], ValueAlreadyExistsModeEnum::EXCEPTION);
+        $collection
+            ->callDoAdd(10)
+            ->callDoAdd(11);
+
+        $this->expectException(ValueAlreadyExistsException::class);
+        $this->expectExceptionMessage('Value "11" already exists.');
+        $this->expectExceptionCode(0);
+        $collection->callDoAdd(11);
+    }
+}

tests/Unit/AbstractCollection/DoGetTest.php

@@ -7,11 +7,12 @@
 use PHPUnit\Framework\TestCase;
 use Steevanb\PhpCollection\Exception\KeyNotFoundException;
 
+/** @covers \Steevanb\PhpCollection\AbstractCollection::doGet */
 final class DoGetTest extends TestCase
 {
     public function testGet(): void
     {
-        $collection = new Collection([1, '2', null]);
+        $collection = new TestCollection([1, '2', null]);
 
         static::assertSame(1, $collection->callDoGet(0));
         static::assertSame('2', $collection->callDoGet(1));
@@ -20,9 +21,11 @@ public function testGet(): void
 
     public function testKeyNotFound(): void
     {
-        $collection = new Collection([1, '2', null]);
+        $collection = new TestCollection([1, '2', null]);
 
-        static::expectException(KeyNotFoundException::class);
-        static::assertFalse($collection->callDoGet(3));
+        $this->expectException(KeyNotFoundException::class);
+        $this->expectExceptionMessage('Key "3" not found.');
+        $this->expectExceptionCode(0);
+        $collection->callDoGet(3);
     }
 }

tests/Unit/AbstractCollection/DoReplaceTest.php

@@ -5,12 +5,19 @@
 namespace Steevanb\PhpCollection\Tests\Unit\AbstractCollection;
 
 use PHPUnit\Framework\TestCase;
+use Steevanb\PhpCollection\{
+    Exception\ReadOnlyException,
+    Exception\ValueAlreadyExistsException,
+    ValueAlreadyExistsModeEnum
+};
 
+/** @covers \Steevanb\PhpCollection\AbstractCollection::doReplace */
 final class DoReplaceTest extends TestCase
 {
-    public function testConstructorValues(): void
+    public function testDoReplace(): void
     {
-        $collection = new Collection([10, 11, 12, 13]);
+        $collection = (new TestCollection())
+            ->callDoReplace([10, 11, 12, 13]);
 
         static::assertCount(4, $collection);
         static::assertSame(10, $collection->callDoGet(0));
@@ -19,15 +26,45 @@ public function testConstructorValues(): void
         static::assertSame(13, $collection->callDoGet(3));
     }
 
-    public function testReplace(): void
+    public function testCalledFromConstructor(): void
     {
-        $collection = (new Collection())
-            ->callDoReplace([10, 11, 12, 13]);
+        $collection = new TestCollection([10, 11, 12, 13]);
 
         static::assertCount(4, $collection);
         static::assertSame(10, $collection->callDoGet(0));
         static::assertSame(11, $collection->callDoGet(1));
         static::assertSame(12, $collection->callDoGet(2));
         static::assertSame(13, $collection->callDoGet(3));
     }
+
+    public function testReadOnly(): void
+    {
+        $collection = (new TestCollection([1, 2]))->setReadOnly();
+
+        $this->expectException(ReadOnlyException::class);
+        $this->expectExceptionMessage('This collection is read only, you cannot edit it\'s values.');
+        $this->expectExceptionCode(0);
+        $collection->callDoReplace([3, 4]);
+    }
+
+    public function testValueAlreadyExistsDoNotAdd(): void
+    {
+        $collection = new TestCollection([], ValueAlreadyExistsModeEnum::DO_NOT_ADD);
+        $collection->callDoReplace([10, 11, 11, 13]);
+
+        static::assertCount(3, $collection);
+        static::assertSame(10, $collection->callDoGet(0));
+        static::assertSame(11, $collection->callDoGet(1));
+        static::assertSame(13, $collection->callDoGet(3));
+    }
+
+    public function testException(): void
+    {
+        $collection = new TestCollection([], ValueAlreadyExistsModeEnum::EXCEPTION);
+
+        $this->expectException(ValueAlreadyExistsException::class);
+        $this->expectExceptionMessage('Value "11" already exists.');
+        $this->expectExceptionCode(0);
+        $collection->callDoReplace([10, 11, 11]);
+    }
 }