Improve Domain modification methods

Domain::withLabel now accepts a domain
Domain::withoutLabels now accept an optional variadic argument to ease usage

Author: nyamsprod

CHANGELOG.md

@@ -12,7 +12,7 @@ All Notable changes to `PHP Domain Parser` **5.x** series will be documented in
 - `Pdp\Domain::withPublicSuffix` updates the `Pdp\Domain` public suffix part.
 - `Pdp\Domain::withSubDomain` updates the `Pdp\Domain` sub domain part.
 - `Pdp\Domain::withLabel` adds a new label to the `Pdp\Domain`.
-- `Pdp\Domain::withoutLabel` removes a label from the `Pdp\Domain`.
+- `Pdp\Domain::withoutLabels` removes labels from the `Pdp\Domain`.
 - `Pdp\Domain::resolve` attach a public suffix to the `Pdp\Domain`.
 - `Pdp\Domain::isResolvable` tells whether the current `Pdp\Domain` can have a public suffix attached to it or not.
 - `Pdp\PublicSuffix::createFromDomain` returns a new `Pdp\PublicSuffix` object from a `Pdp\Domain`object

README.md

@@ -113,7 +113,7 @@ public function Domain::toUnicode(): self
 public function Domain::withPublicSuffix($publicSuffix): self
 public function Domain::withSubDomain($subDomain): self
 public function Domain::withLabel(int $key, $label): self
-public function Domain::withoutLabel(int $key): self
+public function Domain::withoutLabels(int $key, int ...$keys): self
 public function Domain::resolve($publicSuffix): self
 ~~~
 

src/Domain.php

@@ -16,6 +16,7 @@
 namespace Pdp;
 
 use JsonSerializable;
+use TypeError;
 
 /**
  * Domain Value Object.
@@ -428,14 +429,14 @@ public function resolve($publicSuffix): self
      */
     public function withSubDomain($subDomain): self
     {
-        if (!$subDomain instanceof PublicSuffix) {
-            $subDomain = new PublicSuffix($subDomain);
-        }
-
         if (null === $this->publicSuffix->getContent()) {
             throw new Exception('A subdomain can not be added to a domain without a public suffix part.');
         }
 
+        if (!$subDomain instanceof PublicSuffix) {
+            $subDomain = new PublicSuffix($subDomain);
+        }
+
         $subDomain = $this->normalize($subDomain);
         if ($this->subDomain === $subDomain->getContent()) {
             return $this;
@@ -497,12 +498,12 @@ public function withPublicSuffix($publicSuffix): self
      */
     public function withLabel(int $key, $label): self
     {
-        if (!$label instanceof Domain) {
-            $label = new Domain($label);
+        if (null === $label) {
+            throw new TypeError('The label must be a scalar or a stringable object `NULL` given');
         }
 
-        if (1 != count($label)) {
-            throw new Exception(sprintf('The label `%s` is invalid', (string) $label));
+        if (!$label instanceof Domain) {
+            $label = new Domain($label);
         }
 
         $nb_labels = count($this->labels);
@@ -544,29 +545,49 @@ public function withLabel(int $key, $label): self
      * If $key is negative, the removed label will be the label at $key position from the end.
      *
      * @param int $key
+     * @param int ...$keys remaining keys to remove
      *
      * @throws Exception If the key is out of bounds
      *
      * @return self
      */
-    public function withoutLabel(int $key): self
+    public function withoutLabels(int $key, int ...$keys): self
     {
+        array_unshift($keys, $key);
         $nb_labels = count($this->labels);
-        $offset = filter_var($key, FILTER_VALIDATE_INT, ['options' => ['min_range' => - $nb_labels, 'max_range' => $nb_labels - 1]]);
-        if (false === $offset) {
-            throw new Exception(sprintf('the given key `%s` is invalid', $key));
-        }
+        $options = ['options' => ['min_range' => - $nb_labels, 'max_range' => $nb_labels - 1]];
+        $mapper = function (int $key) use ($options, $nb_labels): int {
+            if (false === ($offset = filter_var($key, FILTER_VALIDATE_INT, $options))) {
+                throw new Exception(sprintf('the key `%s` is invalid', $key));
+            }
 
-        if (0 > $offset) {
-            $offset = $nb_labels + $offset;
+            if (0 > $offset) {
+                return $nb_labels + $offset;
+            }
+
+            return $offset;
+        };
+
+        $deleted_keys = array_keys(array_count_values(array_map($mapper, $keys)));
+
+        $filter = function ($key) use ($deleted_keys): bool {
+            return !in_array($key, $deleted_keys, true);
+        };
+
+        $labels = array_filter($this->labels, $filter, ARRAY_FILTER_USE_KEY);
+        if (empty($labels)) {
+            return new self();
         }
 
-        $labels = $this->labels;
-        unset($labels[$offset]);
+        $domain = implode('.', array_reverse(array_values($labels)));
+        $publicSuffixContent = $this->publicSuffix->getContent();
 
-        return new self(
-            implode('.', array_reverse(array_values($labels))),
-            null === $this->publicSuffix->getLabel($offset) ? $this->publicSuffix : null
-        );
+        if (null === $publicSuffixContent ||
+            '.'.$publicSuffixContent !== substr($domain, - strlen($publicSuffixContent) - 1)
+        ) {
+            return new self($domain);
+        }
+
+        return new self($domain, $this->publicSuffix);
     }
 }

tests/DomainTest.php

@@ -20,6 +20,7 @@
 use Pdp\PublicSuffix;
 use Pdp\Rules;
 use PHPUnit\Framework\TestCase;
+use TypeError;
 
 /**
  * @coversDefaultClass Pdp\Domain
@@ -760,25 +761,34 @@ public function withLabelWorksProvider()
                 'isICANN' => true,
                 'isPrivate' => false,
             ],
+            'replace a domain with multiple label' => [
+                'domain' => $base_domain,
+                'key' => -1,
+                'label' => 'www.shop',
+                'expected' => 'www.shop.example.com',
+                'isKnown' => true,
+                'isICANN' => true,
+                'isPrivate' => false,
+            ],
         ];
     }
 
     /**
      * @covers ::withLabel
      */
-    public function testWithLabelFailsWithInvalidKey()
+    public function testWithLabelFailsWithTypeError()
     {
-        $this->expectException(Exception::class);
-        (new Domain('example.com'))->withLabel(-4, 'www');
+        $this->expectException(TypeError::class);
+        (new Domain('example.com'))->withLabel(-4, null);
     }
 
     /**
      * @covers ::withLabel
      */
-    public function testWithLabelFailsWithInvalidLabel1()
+    public function testWithLabelFailsWithInvalidKey()
     {
         $this->expectException(Exception::class);
-        (new Domain('example.com'))->withLabel(-1, 'www.shop');
+        (new Domain('example.com'))->withLabel(-4, 'www');
     }
 
     /**
@@ -791,8 +801,8 @@ public function testWithLabelFailsWithInvalidLabel2()
     }
 
     /**
-     * @covers ::withoutLabel
-     * @dataProvider withoutLabelWorksProvider
+     * @covers ::withoutLabels
+     * @dataProvider withoutLabelsWorksProvider
      *
      * @param Domain      $domain
      * @param int         $key
@@ -801,22 +811,22 @@ public function testWithLabelFailsWithInvalidLabel2()
      * @param bool        $isICANN
      * @param bool        $isPrivate
      */
-    public function testWithoutLabelWorks(
+    public function testWithoutLabelsWorks(
         Domain $domain,
         int $key,
         $expected,
         bool $isKnown,
         bool $isICANN,
         bool $isPrivate
     ) {
-        $result = $domain->withoutLabel($key);
+        $result = $domain->withoutLabels($key);
         $this->assertSame($expected, $result->getContent());
         $this->assertSame($isKnown, $result->isKnown());
         $this->assertSame($isICANN, $result->isICANN());
         $this->assertSame($isPrivate, $result->isPrivate());
     }
 
-    public function withoutLabelWorksProvider()
+    public function withoutLabelsWorksProvider()
     {
         $base_domain = new Domain('www.example.com', new PublicSuffix('com', Rules::ICANN_DOMAINS));
 
@@ -857,11 +867,19 @@ public function withoutLabelWorksProvider()
     }
 
     /**
-     * @covers ::withoutLabel
+     * @covers ::withoutLabels
      */
-    public function testWithoutLabelFailsWithInvalidKey()
+    public function testWithoutLabelsFailsWithInvalidKey()
     {
         $this->expectException(Exception::class);
-        (new Domain('example.com'))->withoutLabel(-3);
+        (new Domain('example.com'))->withoutLabels(-3);
+    }
+
+    /**
+     * @covers ::withoutLabels
+     */
+    public function testWithoutLabelsWorksWithMultipleKeys()
+    {
+        $this->assertNull((new Domain('www.example.com'))->withoutLabels(0, 1, 2)->getContent());
     }
 }