Improve internal codebase

Author: nyamsprod

CHANGELOG.md

@@ -6,11 +6,12 @@ All Notable changes to `PHP Domain Parser` starting from the **5.x** series will
 
 ### Added
 
-- `RegisteredName` class to allow subdomain with IP-like labels [#347](https://github.com/jeremykendall/php-domain-parser/issues/347)
+- `RegisteredName` class to allow subdomain with IP-like labels
 
 ### Fixed
 
 - Using PHPUnit 10
+- `Domain` decorates the new `RegisteredName` class [#347](https://github.com/jeremykendall/php-domain-parser/issues/347)
 
 ### Deprecated
 

composer.json

@@ -49,10 +49,10 @@
         "friendsofphp/php-cs-fixer": "^v3.13.2",
         "guzzlehttp/guzzle": "^7.5",
         "guzzlehttp/psr7": "^1.6 || ^2.4.3",
-        "phpstan/phpstan": "^1.9.17",
+        "phpstan/phpstan": "^1.9.18",
         "phpstan/phpstan-phpunit": "^1.3.4",
         "phpstan/phpstan-strict-rules": "^1.4.5",
-        "phpunit/phpunit": "^10.0.7",
+        "phpunit/phpunit": "^10.0.11",
         "psr/http-factory": "^1.0.1",
         "psr/simple-cache": "^1.0.1",
         "symfony/cache": "^v5.0.0 || ^v6.0.0"

src/Domain.php

@@ -6,12 +6,14 @@
 
 use Iterator;
 use Stringable;
+use const FILTER_FLAG_IPV4;
+use const FILTER_VALIDATE_IP;
 
 final class Domain implements DomainName
 {
     private function __construct(private RegisteredName $registeredName)
     {
-        if ($this->registeredName->isIpv4()) {
+        if (false !== filter_var($this->registeredName->value(), FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) {
             throw SyntaxError::dueToUnsupportedType($this->registeredName->toString());
         }
     }
@@ -88,11 +90,6 @@ public function labels(): array
         return $this->registeredName->labels();
     }
 
-    public function isIpv4(): bool
-    {
-        return $this->registeredName->isIpv4();
-    }
-
     private function newInstance(RegisteredName $registeredName): self
     {
         if ($registeredName->value() === $this->registeredName->value()) {
@@ -133,9 +130,9 @@ public function withLabel(int $key, DomainNameProvider|Host|string|Stringable|nu
         return $this->newInstance($this->registeredName->withLabel($key, $label));
     }
 
-    public function withoutLabel(int $key, int ...$keys): self
+    public function withoutLabel(int ...$keys): self
     {
-        return $this->newInstance($this->registeredName->withoutLabel($key, ...$keys));
+        return $this->newInstance($this->registeredName->withoutLabel(...$keys));
     }
 
     public function clear(): self

src/DomainName.php

@@ -101,7 +101,7 @@ public function withLabel(int $key, DomainNameProvider|Host|string|Stringable|nu
      *
      * @throws CannotProcessHost If the key is out of bounds
      */
-    public function withoutLabel(int $key, int ...$keys): self;
+    public function withoutLabel(int ...$keys): self;
 
     /**
      * Returns an instance with all labels removed.

src/Host.php

@@ -11,8 +11,6 @@
  * @see https://tools.ietf.org/html/rfc1034#section-3.5
  * @see https://tools.ietf.org/html/rfc1123#section-2.1
  * @see https://tools.ietf.org/html/rfc5890
- *
- * @method bool isIpv4()
  */
 interface Host extends Countable, JsonSerializable
 {

src/RegisteredName.php

@@ -10,7 +10,6 @@
 use function array_keys;
 use function array_reverse;
 use function array_slice;
-use function array_unshift;
 use function count;
 use function explode;
 use function filter_var;
@@ -42,30 +41,44 @@ final class RegisteredName implements DomainName
     private readonly array $labels;
     private readonly ?string $domain;
 
-    private function __construct(private string $type, DomainNameProvider|Host|Stringable|string|int|null $domain)
+    /**
+     * @throws CannotProcessHost
+     */
+    private function __construct(private readonly string $type, DomainNameProvider|Host|Stringable|string|int|null $domain)
     {
         $this->domain = $this->parseDomain($domain);
         $this->labels = null === $this->domain ? [] : array_reverse(explode('.', $this->domain));
     }
 
     /**
      * @param array{domain:string|null, type:string} $properties
+     *
+     * @throws CannotProcessHost
      */
     public static function __set_state(array $properties): self
     {
         return new self($properties['type'], $properties['domain']);
     }
 
+    /**
+     * @throws CannotProcessHost
+     */
     public static function fromIDNA2003(DomainNameProvider|Host|Stringable|string|int|null $domain): self
     {
         return new self(self::IDNA_2003, $domain);
     }
 
+    /**
+     * @throws CannotProcessHost
+     */
     public static function fromIDNA2008(DomainNameProvider|Host|Stringable|string|int|null $domain): self
     {
         return new self(self::IDNA_2008, $domain);
     }
 
+    /**
+     * @throws CannotProcessHost
+     */
     private function parseDomain(DomainNameProvider|Host|Stringable|string|int|null $domain): ?string
     {
         if ($domain instanceof DomainNameProvider) {
@@ -136,11 +149,6 @@ private function domainToUnicode(string $domain): string
         )->result();
     }
 
-    public function isIpv4(): bool
-    {
-        return false !== filter_var($this->domain, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4);
-    }
-
     /**
      * @return Iterator<string>
      */
@@ -245,7 +253,7 @@ private function normalize(DomainNameProvider|Host|Stringable|string|null $domai
         }
 
         if (null === $domain) {
-            return $domain;
+            return null;
         }
 
         $domain = (string) $domain;
@@ -297,13 +305,12 @@ public function withLabel(int $key, DomainNameProvider|Host|string|Stringable|nu
         return new self($this->type, implode('.', array_reverse($labels)));
     }
 
-    public function withoutLabel(int $key, int ...$keys): self
+    public function withoutLabel(int ...$keys): self
     {
-        array_unshift($keys, $key);
         $nbLabels = count($this->labels);
         foreach ($keys as &$offset) {
             if (- $nbLabels > $offset || $nbLabels - 1 < $offset) {
-                throw SyntaxError::dueToInvalidLabelKey($this, $key);
+                throw SyntaxError::dueToInvalidLabelKey($this, $offset);
             }
 
             if (0 > $offset) {
@@ -327,6 +334,9 @@ public function withoutLabel(int $key, int ...$keys): self
         return new self($this->type, [] === $labels ? null : implode('.', array_reverse($labels)));
     }
 
+    /**
+     * @throws CannotProcessHost
+     */
     public function clear(): self
     {
         if (null === $this->domain) {
@@ -336,6 +346,9 @@ public function clear(): self
         return new self($this->type, null);
     }
 
+    /**
+     * @throws CannotProcessHost
+     */
     public function slice(int $offset, int $length = null): self
     {
         $nbLabels = count($this->labels);