Exceptions rework

src/Exception/DomainException.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Arokettu\Torrent\Exception;
+
+class DomainException extends \DomainException implements TorrentFileException
+{
+}

src/Exception/UnexpectedValueException.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Arokettu\Torrent\Exception;
+
+class UnexpectedValueException extends \UnexpectedValueException implements TorrentFileException
+{
+}

src/FileSystem/FileData.php

@@ -5,7 +5,7 @@
 namespace Arokettu\Torrent\FileSystem;
 
 use Arokettu\Bencode\Bencode;
-use Arokettu\Torrent\Exception\InvalidArgumentException;
+use Arokettu\Torrent\Exception\DomainException;
 use Arokettu\Torrent\Exception\PathNotFoundException;
 use Arokettu\Torrent\Helpers\MathHelper;
 use Arokettu\Torrent\MetaVersion;
@@ -60,7 +60,7 @@ public static function forPath(
             [MetaVersion::V2, MetaVersion::V1],
                 => new HybridV1V2\FileData(...$params, ...array_values($version)),
             default
-                => throw new InvalidArgumentException('Invalid metadata version'),
+                => throw new DomainException('Invalid metadata version'),
         };
     }
 
@@ -73,7 +73,7 @@ protected function __construct(
         protected bool $detectSymlinks,
     ) {
         if ($pieceLength < self::PIECE_LENGTH_MIN || !MathHelper::isPow2($pieceLength)) {
-            throw new InvalidArgumentException(
+            throw new DomainException(
                 'pieceLength must be a power of 2 and at least ' . self::PIECE_LENGTH_MIN
             );
         }

src/Helpers/CertHelper.php

@@ -4,7 +4,6 @@
 
 namespace Arokettu\Torrent\Helpers;
 
-use Arokettu\Torrent\Exception\RuntimeException;
 use OpenSSLCertificate;
 
 /**
@@ -17,7 +16,7 @@ private static function assertOpenSSL(): void
         if (\extension_loaded('openssl') === false) {
             // @codeCoverageIgnoreStart
             // coverage is generated with openssl
-            throw new RuntimeException('OpenSSL extension is not installed');
+            throw new \LogicException('OpenSSL extension is not installed');
             // @codeCoverageIgnoreEnd
         }
     }

src/TorrentFile/Common/Attributes.php

@@ -4,7 +4,7 @@
 
 namespace Arokettu\Torrent\TorrentFile\Common;
 
-use Arokettu\Torrent\Exception\InvalidArgumentException;
+use Arokettu\Torrent\Exception\UnexpectedValueException;
 
 /**
  * @property-read bool $x
@@ -45,7 +45,7 @@ public function __construct(string $attr)
     public function has(string $attr): bool
     {
         if (\strlen($attr) !== 1) {
-            throw new InvalidArgumentException('Attribute name must be 1 character long');
+            throw new UnexpectedValueException('Attribute name must be 1 character long');
         }
         return str_contains($this->attr, $attr);
     }

src/TorrentFile/DataMethods.php

@@ -5,7 +5,7 @@
 namespace Arokettu\Torrent\TorrentFile;
 
 use Arokettu\Torrent\DataTypes\Internal\DictObject;
-use Arokettu\Torrent\Exception\RuntimeException;
+use Arokettu\Torrent\Exception\BadMethodCallException;
 
 /**
  * @internal
@@ -41,7 +41,7 @@ private function getInfoField(string $key): mixed
     private function setInfoField(string $key, mixed $value): void
     {
         if ($this->isSigned()) {
-            throw new RuntimeException(
+            throw new BadMethodCallException(
                 'Unable to modify infohash fields of a signed torrent. ' .
                 'Please remove the signatures first'
             );

src/TorrentFile/InfoMethods.php

@@ -6,7 +6,8 @@
 
 use Arokettu\Bencode\Types\DictType;
 use Arokettu\Torrent\DataTypes\Internal\InfoDict;
-use Arokettu\Torrent\Exception\InvalidArgumentException;
+use Arokettu\Torrent\Exception\BadMethodCallException;
+use Arokettu\Torrent\Exception\UnexpectedValueException;
 use Arokettu\Torrent\MetaVersion;
 
 /**
@@ -36,10 +37,10 @@ public function isPrivate(): bool
     public function setName(string $name): self
     {
         if ($name === '') {
-            throw new InvalidArgumentException('$name must not be empty');
+            throw new UnexpectedValueException('$name must not be empty');
         }
         if (str_contains($name, '/') || str_contains($name, "\0")) {
-            throw new InvalidArgumentException('$name must not contain slashes and zero bytes');
+            throw new UnexpectedValueException('$name must not contain slashes and zero bytes');
         }
 
         $this->setInfoField('name', $name);
@@ -102,7 +103,7 @@ private function resetInfoDict(): void
     public function removeMetadata(MetaVersion $version): void
     {
         if (array_filter($this->getMetadataVersions(), fn ($v) => $v !== $version) === []) {
-            throw new InvalidArgumentException('Unable to remove the only remaining metadata');
+            throw new BadMethodCallException('Unable to remove the only remaining metadata');
         }
 
         match ($version) {
@@ -114,7 +115,7 @@ public function removeMetadata(MetaVersion $version): void
     public function keepOnlyMetadata(MetaVersion $version): void
     {
         if (!$this->hasMetadata($version)) {
-            throw new InvalidArgumentException('Unable to keep metadata that is not present');
+            throw new BadMethodCallException('Unable to keep metadata that is not present');
         }
 
         match ($version) {

src/TorrentFile/SignatureMethods.php

@@ -10,6 +10,7 @@
 use Arokettu\Torrent\DataTypes\Signature;
 use Arokettu\Torrent\DataTypes\SignatureValidatorResult;
 use Arokettu\Torrent\Exception\RuntimeException;
+use Arokettu\Torrent\Exception\UnexpectedValueException;
 use Arokettu\Torrent\Helpers\CertHelper;
 use OpenSSLAsymmetricKey;
 use OpenSSLCertificate;
@@ -56,12 +57,12 @@ public function sign(
         iterable $info = [],
     ): void {
         if (!openssl_x509_check_private_key($certificate, $key)) {
-            throw new RuntimeException('The key does not correspond to the certificate');
+            throw new UnexpectedValueException('The key does not correspond to the certificate');
         }
 
         $certData = openssl_x509_parse($certificate);
         $commonName = $certData['subject']['CN'] ??
-            throw new RuntimeException('The certificate must contain a common name');
+            throw new UnexpectedValueException('The certificate must contain a common name');
 
         $signInfo = new DictObject($info);
 
@@ -92,7 +93,7 @@ public function verifySignature(OpenSSLCertificate $certificate): SignatureValid
     {
         $certData = openssl_x509_parse($certificate);
         $commonName = $certData['subject']['CN'] ??
-            throw new RuntimeException('The certificate must contain a common name');
+            throw new UnexpectedValueException('The certificate must contain a common name');
 
         $signatures = $this->getSignatures();
         /** @var Signature $signature */

tests/files/AttributesTest.php

@@ -4,7 +4,7 @@
 
 namespace Arokettu\Torrent\Tests\Files;
 
-use Arokettu\Torrent\Exception\InvalidArgumentException;
+use Arokettu\Torrent\Exception\UnexpectedValueException;
 use Arokettu\Torrent\TorrentFile\Common\Attributes;
 use PHPUnit\Framework\TestCase;
 
@@ -62,15 +62,15 @@ public function testPad(): void
 
     public function testHasOneCharOnly(): void
     {
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(UnexpectedValueException::class);
         $this->expectExceptionMessage('Attribute name must be 1 character long');
 
         (new Attributes('xx'))->has('xx');
     }
 
     public function testAttrOneCharOnly(): void
     {
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(UnexpectedValueException::class);
         $this->expectExceptionMessage('Attribute name must be 1 character long');
 
         (new Attributes('xx'))->xx;

tests/files/CreateFileV1FeaturesTest.php

@@ -4,7 +4,7 @@
 
 namespace Arokettu\Torrent\Tests\Files;
 
-use Arokettu\Torrent\Exception\InvalidArgumentException;
+use Arokettu\Torrent\Exception\BadMethodCallException;
 use Arokettu\Torrent\MetaVersion;
 use Arokettu\Torrent\TorrentFile;
 use PHPUnit\Framework\TestCase;
@@ -435,7 +435,7 @@ public function testUnableToDeleteV1(): void
     {
         $torrent = TorrentFile::fromPath(TEST_ROOT . '/data/files2', version: MetaVersion::V1);
 
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(BadMethodCallException::class);
         $this->expectExceptionMessage('Unable to remove the only remaining metadata');
         $torrent->removeMetadata(MetaVersion::V1);
     }
@@ -444,7 +444,7 @@ public function testUnableKeepV2(): void
     {
         $torrent = TorrentFile::fromPath(TEST_ROOT . '/data/files2', version: MetaVersion::V1);
 
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(BadMethodCallException::class);
         $this->expectExceptionMessage('Unable to keep metadata that is not present');
         $torrent->keepOnlyMetadata(MetaVersion::V2);
     }

tests/files/CreateFileV1Test.php

@@ -4,7 +4,7 @@
 
 namespace Arokettu\Torrent\Tests\Files;
 
-use Arokettu\Torrent\Exception\InvalidArgumentException;
+use Arokettu\Torrent\Exception\DomainException;
 use Arokettu\Torrent\Exception\PathNotFoundException;
 use Arokettu\Torrent\MetaVersion;
 use Arokettu\Torrent\TorrentFile;
@@ -238,7 +238,7 @@ public function testNotFoundException(): void
 
     public function testChunkTooSmall(): void
     {
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(DomainException::class);
         $this->expectExceptionMessage('pieceLength must be a power of 2 and at least 16384');
 
         TorrentFile::fromPath(
@@ -250,7 +250,7 @@ public function testChunkTooSmall(): void
 
     public function testChunkNotPow2(): void
     {
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(DomainException::class);
         $this->expectExceptionMessage('pieceLength must be a power of 2 and at least 16384');
 
         TorrentFile::fromPath(

tests/files/CreateFileV2FeaturesTest.php

@@ -4,7 +4,7 @@
 
 namespace Arokettu\Torrent\Tests\Files;
 
-use Arokettu\Torrent\Exception\InvalidArgumentException;
+use Arokettu\Torrent\Exception\BadMethodCallException;
 use Arokettu\Torrent\MetaVersion;
 use Arokettu\Torrent\TorrentFile;
 use PHPUnit\Framework\TestCase;
@@ -211,7 +211,7 @@ public function testUnableToDeleteV2(): void
     {
         $torrent = TorrentFile::fromPath(TEST_ROOT . '/data/files2', version: MetaVersion::V2);
 
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(BadMethodCallException::class);
         $this->expectExceptionMessage('Unable to remove the only remaining metadata');
         $torrent->removeMetadata(MetaVersion::V2);
     }
@@ -220,7 +220,7 @@ public function testUnableKeepV1(): void
     {
         $torrent = TorrentFile::fromPath(TEST_ROOT . '/data/files2', version: MetaVersion::V2);
 
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(BadMethodCallException::class);
         $this->expectExceptionMessage('Unable to keep metadata that is not present');
         $torrent->keepOnlyMetadata(MetaVersion::V1);
     }

tests/info/ImmutableWhenSignedTest.php

@@ -4,7 +4,7 @@
 
 namespace Arokettu\Torrent\Tests\Info;
 
-use Arokettu\Torrent\Exception\RuntimeException;
+use Arokettu\Torrent\Exception\BadMethodCallException;
 use Arokettu\Torrent\TorrentFile;
 use PHPUnit\Framework\TestCase;
 
@@ -14,7 +14,7 @@ class ImmutableWhenSignedTest extends TestCase
 {
     public function testImmutableWhenSigned(): void
     {
-        $this->expectException(RuntimeException::class);
+        $this->expectException(BadMethodCallException::class);
         $this->expectExceptionMessage(
             'Unable to modify infohash fields of a signed torrent. Please remove the signatures first'
         );

tests/info/NameTest.php

@@ -5,7 +5,7 @@
 namespace Arokettu\Torrent\Tests\Info;
 
 use Arokettu\Bencode\Bencode;
-use Arokettu\Torrent\Exception\InvalidArgumentException;
+use Arokettu\Torrent\Exception\UnexpectedValueException;
 use Arokettu\Torrent\TorrentFile;
 use PHPUnit\Framework\TestCase;
 
@@ -37,21 +37,21 @@ public function testNameSet(): void
 
     public function testNotEmpty(): void
     {
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(UnexpectedValueException::class);
         $torrent = TorrentFile::loadFromString('de');
         $torrent->setName('');
     }
 
     public function testNoZeros(): void
     {
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(UnexpectedValueException::class);
         $torrent = TorrentFile::loadFromString('de');
         $torrent->setName("Test\0");
     }
 
     public function testNoSlashes(): void
     {
-        $this->expectException(InvalidArgumentException::class);
+        $this->expectException(UnexpectedValueException::class);
         $torrent = TorrentFile::loadFromString('de');
         $torrent->setName('te/st');
     }

tests/sign/SignatureTest.php

@@ -6,7 +6,7 @@
 
 use Arokettu\Torrent\DataTypes\Signature;
 use Arokettu\Torrent\DataTypes\SignatureValidatorResult;
-use Arokettu\Torrent\Exception\RuntimeException;
+use Arokettu\Torrent\Exception\UnexpectedValueException;
 use Arokettu\Torrent\TorrentFile;
 use OpenSSLCertificate;
 use PHPUnit\Framework\TestCase;
@@ -78,11 +78,11 @@ public function testVerifySignaturesNoSignature(): void
 
     public function testVerifySignaturesMustBeCN(): void
     {
-        $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('The certificate must contain a common name');
-
         $file = TorrentFile::load(TEST_ROOT . '/data/CentOS-7-x86_64-NetInstall-1611-signed.torrent');
 
+        $this->expectException(UnexpectedValueException::class);
+        $this->expectExceptionMessage('The certificate must contain a common name');
+
         $cert1 = openssl_x509_read('file://' . TEST_ROOT . '/data/keys/test1-nocn.crt');
         self::assertEquals(SignatureValidatorResult::NotPresent, $file->verifySignature($cert1));
     }
@@ -124,27 +124,27 @@ public function testSignNoCert(): void
 
     public function testSignMustHaveCN(): void
     {
-        $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('The certificate must contain a common name');
-
         $file = TorrentFile::load(TEST_ROOT . '/data/CentOS-7-x86_64-NetInstall-1611.torrent');
 
         $cert = openssl_x509_read('file://' . TEST_ROOT . '/data/keys/test1-nocn.crt');
         $key = openssl_pkey_get_private('file://' . TEST_ROOT . '/data/keys/test1.key');
 
+        $this->expectException(UnexpectedValueException::class);
+        $this->expectExceptionMessage('The certificate must contain a common name');
+
         $file->sign($key, $cert);
     }
 
     public function testSignCertKeyMatch(): void
     {
-        $this->expectException(RuntimeException::class);
-        $this->expectExceptionMessage('The key does not correspond to the certificate');
-
         $file = TorrentFile::load(TEST_ROOT . '/data/CentOS-7-x86_64-NetInstall-1611.torrent');
 
         $cert = openssl_x509_read('file://' . TEST_ROOT . '/data/keys/test2.crt');
         $key = openssl_pkey_get_private('file://' . TEST_ROOT . '/data/keys/test1.key');
 
+        $this->expectException(UnexpectedValueException::class);
+        $this->expectExceptionMessage('The key does not correspond to the certificate');
+
         $file->sign($key, $cert);
     }