Improve Url implementation

Author: nyamsprod

src/WhatWg/Url.php

@@ -88,6 +88,11 @@ public function getScheme(): string
 
         public function withScheme(string $scheme): self
         {
+            $scheme = strtolower($scheme);
+            if ($scheme === $this->getScheme() || $scheme === $this->url->protocol) {
+                return $this;
+            }
+
             $copy = $this->copy();
             $copy->url->protocol = $scheme;
 
@@ -101,6 +106,10 @@ public function getUsername(): ?string
 
         public function withUsername(?string $user): self
         {
+            if ($user === $this->getUsername() || $user === $this->url->username) {
+                return $this;
+            }
+
             $copy = $this->copy();
             $copy->url->username = (string) $user;
 
@@ -114,6 +123,10 @@ public function getPassword(): ?string
 
         public function withPassword(#[SensitiveParameter] ?string $password): self
         {
+            if ($password === $this->getPassword() || $password === $this->url->password) {
+                return $this;
+            }
+
             $copy = $this->copy();
             $copy->url->password = (string) $password;
 
@@ -142,6 +155,10 @@ public function getUnicodeHost(): ?string
 
         public function withHost(string $host): self
         {
+            if ($host === $this->getAsciiHost() || $host === $this->getUnicodeHost()) {
+                return $this;
+            }
+
             $copy = $this->copy();
             $copy->url->hostname = $host;
 
@@ -155,6 +172,10 @@ public function getPort(): ?int
 
         public function withPort(?int $port): self
         {
+            if ($port === $this->getPort()) {
+                return $this;
+            }
+
             $copy = $this->copy();
             $copy->url->port = (string) $port;
 
@@ -168,6 +189,10 @@ public function getPath(): string
 
         public function withPath(string $path): self
         {
+            if ($path === $this->url->pathname) {
+                return $this;
+            }
+
             $copy = $this->copy();
             $copy->url->pathname = $path;
 
@@ -186,6 +211,10 @@ public function getQuery(): ?string
 
         public function withQuery(?string $query): self
         {
+            if ($query === $this->url->search || $query === $this->getQuery()) {
+                return $this;
+            }
+
             $copy = $this->copy();
             $copy->url->search = (string) $query;
 
@@ -204,6 +233,10 @@ public function getFragment(): ?string
 
         public function withFragment(?string $fragment): self
         {
+            if ($fragment === $this->url->hash || $fragment === $this->getFragment()) {
+                return $this;
+            }
+
             $copy = $this->copy();
             $copy->url->hash = (string) $fragment;
 

src/WhatWg/UrlValidationErrorCollector.php

@@ -81,14 +81,16 @@ public function log(mixed $level, string|Stringable $message, array $context = [
 
         $this->errors[] = new UrlValidationError(
             $errorContext,
+            // \Rowbot\URL\URL makes no usage of string interpolation
+            // the message is a string representing one of
+            // the defined \Uri\WhatWg\UrlValidationErrorType case
+            // mapping is done using https://url.spec.whatwg.org/#writing
             match ((string) $message) {
-                'missing-scheme-non-relative-URL' => UrlValidationErrorType::MissingSchemeNonRelativeUrl,
-                'special-scheme-missing-following-solidus' => UrlValidationErrorType::SpecialSchemeMissingFollowingSolidus,
-                'invalid-credentials' => UrlValidationErrorType::InvalidCredentials,
-                'invalid-reverse-solidus' => UrlValidationErrorType::InvalidReverseSoldius,
+                // IDNA Error Tyoe
                 'domain-to-ASCII' => UrlValidationErrorType::DomainToAscii,
                 'domain-to-unicode' => UrlValidationErrorType::DomainToUnicode,
                 'domain-invalid-code-point' => UrlValidationErrorType::DomainInvalidCodePoint,
+                // Host parsing
                 'host-invalid-code-point' => UrlValidationErrorType::HostInvalidCodePoint,
                 'IPv4-part-empty' => UrlValidationErrorType::Ipv4EmptyPart,
                 'IPv4-non-decimal-part' => UrlValidationErrorType::Ipv4NonDecimalPart,
@@ -105,14 +107,21 @@ public function log(mixed $level, string|Stringable $message, array $context = [
                 'IPv4-in-IPv6-too-few-parts' => UrlValidationErrorType::Ipv4InIpv6TooFewParts,
                 'IPv4-in-IPv6-invalid-code-point' => UrlValidationErrorType::Ipv4InIpv6InvalidCodePoint,
                 'IPv4-in-IPv6-too-many-pieces' => UrlValidationErrorType::Ipv4InIpv6TooManyPieces,
+                // URL parsing
+                'invalid-URL-unit' => UrlValidationErrorType::InvalidUrlUnit,
+                'special-scheme-missing-following-solidus' => UrlValidationErrorType::SpecialSchemeMissingFollowingSolidus,
+                'missing-scheme-non-relative-URL' => UrlValidationErrorType::MissingSchemeNonRelativeUrl,
+                'invalid-credentials' => UrlValidationErrorType::InvalidCredentials,
+                'invalid-reverse-solidus' => UrlValidationErrorType::InvalidReverseSoldius,
                 'host-missing' => UrlValidationErrorType::HostMissing,
                 'port-out-of-range' => UrlValidationErrorType::PortOutOfRange,
                 'port-invalid' => UrlValidationErrorType::PortInvalid,
-                'invalid-URL-unit' => UrlValidationErrorType::InvalidUrlUnit,
                 'file-invalid-Windows-drive-letter-host' => UrlValidationErrorType::FileInvalidWindowsDriveLetterHost,
                 'file-invalid-Windows-drive-letter' => UrlValidationErrorType::FileInvalidWindowsDriveLetter,
                 default  => throw new OutOfBoundsException('unknown error type:'.$message),
             },
+            // \Rowbot\URL\URL emits LogLevel::WARNING when the error is a failure
+            // otherwise LogLevel::NOTICE is used
             LogLevel::WARNING === $level,
         );
     }

tests/WhatWg/UrlTest.php

@@ -50,7 +50,7 @@ public function it_will_resolve_an_uri(): void
     }
 
     #[Test]
-    public function it_can_retrive_url_components(): void
+    public function it_can_retrieve_url_components(): void
     {
         $url = new Url("HTTPS://%61pple:p%61ss@ex%61mple.com:433/foob%61r?%61bc=%61bc#%61bc");
 
@@ -191,9 +191,7 @@ public function it_will_not_update_on_invalid_with_input(): void
         $url = new Url("https://user:pass@example.com/foo/bar");
         $urlBis = $url
             ->withScheme('gopher')
-            ->withUsername('user')
             ->withPort(12345678)
-            ->withPassword('pass')
             ->withHost('::1');
 
         self::assertTrue($urlBis->equals($url));
@@ -213,4 +211,22 @@ public function it_will_handle_window_uri(): void
         self::assertSame("file:///c:/Users/JohnDoe/Documents/report.txt", $url->toUnicodeString());
         self::assertSame($url->toUnicodeString(), $url->toAsciiString());
     }
+
+    #[Test]
+    public function it_return_the_same_instance_if_nothing_is_changed(): void
+    {
+        $url = new Url("https://apple:pass@example.com:433/foobar?abc=abc#abc");
+        $urlBis = $url
+            ->withScheme('https:')
+            ->withUsername('apple')
+            ->withPassword('pass')
+            ->withHost('example.com')
+            ->withPort(433)
+            ->withPath('/foobar')
+            ->withQuery('?abc=abc')
+            ->withFragment('#abc');
+
+        self::assertTrue($urlBis->equals($url));
+        self::assertSame($urlBis, $url);
+    }
 }