Improve added features

Author: nyamsprod

CHANGELOG.md

@@ -9,6 +9,7 @@ All Notable changes to `PHP Domain Parser` **5.x** series will be documented in
 - `Pdp\DomainInterface` interface implemented by `Pdp\Domain` and `Pdp\PublicSuffix`
 - `Pdp\Domain::getContent` returns the Domain name value replaces `Pdp\Domain::getDomain`
 - `Pdp\Domain` implements the `Countable` interface.
+- `Pdp\Domain::withPublicSuffix` returns a new Domain object with a different Public Suffix
 
 ### Fixed
 

README.md

@@ -90,7 +90,7 @@ The `Pdp\Domain` implements the `Pdp\DomainInterface`
 interface DomainInterface extends Countable, IteratorAggregate
 {
     public function getContent(): ?string
-    public function getLabel(int $offset): ?string
+    public function getLabel(int $key): ?string
     public function keys(string $label): int[]
     public function toUnicode(): static;
     public function toAscii(): static;
@@ -110,6 +110,7 @@ final class Domain implements DomainInterface, JsonSerializable
     public function isKnown(): bool;
     public function isICANN(): bool;
     public function isPrivate(): bool;
+    public function withPublicSuffix(PublicSuffix $publicSuffix): self;
 }
 ~~~
 

src/Domain.php

@@ -220,13 +220,13 @@ public function getDomain()
     /**
      * {@inheritdoc}
      */
-    public function getLabel(int $offset)
+    public function getLabel(int $key)
     {
-        if ($offset < 0) {
-            $offset += count($this->labels);
+        if ($key < 0) {
+            $key += count($this->labels);
         }
 
-        return $this->labels[$offset] ?? null;
+        return $this->labels[$key] ?? null;
     }
 
     /**
@@ -309,7 +309,7 @@ public function isPrivate(): bool
     /**
      * {@inheritdoc}
      */
-    public function toAscii(): self
+    public function toAscii()
     {
         static $pattern = '/[^\x20-\x7f]/';
         if (null === $this->domain || !preg_match($pattern, $this->domain)) {
@@ -329,7 +329,7 @@ public function toAscii(): self
     /**
      * {@inheritdoc}
      */
-    public function toUnicode(): self
+    public function toUnicode()
     {
         if (null === $this->domain || false === strpos($this->domain, 'xn--')) {
             return $this;
@@ -345,6 +345,16 @@ public function toUnicode(): self
         return $clone;
     }
 
+    /**
+     * Returns a new domain name with a different public suffix.
+     *
+     * @param PublicSuffix $publicSuffix
+     *
+     * @throws Exception if the domain can not contain a public suffix
+     * @throws Exception if the public suffix can not be assign to the domain name
+     *
+     * @return self
+     */
     public function withPublicSuffix(PublicSuffix $publicSuffix): self
     {
         if ($this->publicSuffix == $publicSuffix) {
@@ -360,21 +370,18 @@ public function withPublicSuffix(PublicSuffix $publicSuffix): self
             return $clone;
         }
 
+        if (null === $this->domain || false === strpos($this->domain, '.')) {
+            throw new Exception(sprintf('The domain `%s` can not contain a public suffix', $this->domain));
+        }
+
         static $pattern = '/[^\x20-\x7f]/';
         if (preg_match($pattern, $this->domain)) {
             $publicSuffix = $publicSuffix->toUnicode();
         }
 
-        if (null === $this->domain || false === strpos($this->domain, '.') || $this->domain === $publicSuffix->getContent()) {
-            throw new Exception(sprintf('The domain `%s` can not contain a public suffix', $this->domain));
-        }
-
-        if ($publicSuffix->getContent() !== substr($this->domain, - strlen($publicSuffix->getContent()))) {
-            throw new Exception(sprintf(
-                'the public suffix `%s` can not be assign to the domain name `%s`',
-                $publicSuffix->getContent(),
-                $this->domain
-            ));
+        $publicSuffixContent = $publicSuffix->getContent();
+        if ($this->domain === $publicSuffixContent || $publicSuffixContent !== substr($this->domain, - strlen($publicSuffixContent))) {
+            throw new Exception(sprintf('the public suffix `%s` can not be assign to the domain name `%s`', $publicSuffixContent, $this->domain));
         }
 
         $clone = clone $this;

src/PublicSuffix.php

@@ -131,13 +131,13 @@ public function getContent()
     /**
      * {@inheritdoc}
      */
-    public function getLabel(int $offset)
+    public function getLabel(int $key)
     {
-        if ($offset < 0) {
-            $offset += count($this->labels);
+        if ($key < 0) {
+            $key += count($this->labels);
         }
 
-        return $this->labels[$offset] ?? null;
+        return $this->labels[$key] ?? null;
     }
 
     /**

tests/DomainTest.php

@@ -366,6 +366,16 @@ public function withPublicSuffixWorksProvider()
                 'public suffix' => new PublicSuffix('be', Rules::ICANN_DOMAINS),
                 'expected' => 'be',
             ],
+            'idn domain name' => [
+                'domain' =>  new Domain('Яндекс.РФ', new PublicSuffix('рф', Rules::ICANN_DOMAINS)),
+                'public suffix' => new PublicSuffix('рф', Rules::ICANN_DOMAINS),
+                'expected' => 'рф',
+            ],
+            'idn domain name with ascii public suffix' => [
+                'domain' =>  new Domain('Яндекс.РФ', new PublicSuffix('рф', Rules::ICANN_DOMAINS)),
+                'public suffix' => new PublicSuffix('xn--p1ai', Rules::ICANN_DOMAINS),
+                'expected' => 'рф',
+            ],
         ];
     }
 
@@ -402,4 +412,15 @@ public function withPublicSuffixFailsProvider()
             ],
         ];
     }
+
+    /**
+     * @covers ::withPublicSuffix
+     */
+    public function testWithPublicSuffixReturnsInstance()
+    {
+        $publicSuffix = new PublicSuffix('ac.be', Rules::ICANN_DOMAINS);
+        $domain = new Domain('ulb.ac.be', $publicSuffix);
+        $this->assertSame($domain, $domain->withPublicSuffix($publicSuffix));
+        $this->assertNotSame($domain, $domain->withPublicSuffix(new PublicSuffix('ac.be', Rules::PRIVATE_DOMAINS)));
+    }
 }