Improve package

- Improve PublicSuffix validation
- Improve Domain modification methods validation

Author: nyamsprod

.php_cs

@@ -1,5 +1,16 @@
 <?php
 
+$header = <<<EOF
+PHP Domain Parser: Public Suffix List based URL parsing.
+
+@see http://github.com/jeremykendall/php-domain-parser for the canonical source repository
+
+@copyright Copyright (c) 2017 Jeremy Kendall (http://jeremykendall.net)
+
+For the full copyright and license information, please view the LICENSE
+file that was distributed with this source code.
+EOF;
+
 $finder = PhpCsFixer\Finder::create()
     ->in(__DIR__.'/src')
     ->in(__DIR__.'/tests')
@@ -10,6 +21,12 @@ return PhpCsFixer\Config::create()
         '@PSR2' => true,
         'array_syntax' => ['syntax' => 'short'],
         'concat_space' => ['spacing' => 'none'],
+        'header_comment' => [
+            'commentType' => 'PHPDoc',
+            'header' => $header,
+            'location' => 'after_open',
+            'separate' => 'both',
+        ],
         'new_with_braces' => true,
         'no_blank_lines_after_phpdoc' => true,
         'no_empty_phpdoc' => true,

src/Cache.php

@@ -1,12 +1,16 @@
 <?php
+
 /**
  * PHP Domain Parser: Public Suffix List based URL parsing.
  *
  * @see http://github.com/jeremykendall/php-domain-parser for the canonical source repository
  *
  * @copyright Copyright (c) 2017 Jeremy Kendall (http://jeremykendall.net)
- * @license   http://github.com/jeremykendall/php-domain-parser/blob/master/LICENSE MIT License
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace Pdp;

src/CacheException.php

@@ -1,12 +1,16 @@
 <?php
+
 /**
  * PHP Domain Parser: Public Suffix List based URL parsing.
  *
  * @see http://github.com/jeremykendall/php-domain-parser for the canonical source repository
  *
  * @copyright Copyright (c) 2017 Jeremy Kendall (http://jeremykendall.net)
- * @license   http://github.com/jeremykendall/php-domain-parser/blob/master/LICENSE MIT License
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace Pdp;

src/Converter.php

@@ -1,12 +1,16 @@
 <?php
+
 /**
  * PHP Domain Parser: Public Suffix List based URL parsing.
  *
  * @see http://github.com/jeremykendall/php-domain-parser for the canonical source repository
  *
  * @copyright Copyright (c) 2017 Jeremy Kendall (http://jeremykendall.net)
- * @license   http://github.com/jeremykendall/php-domain-parser/blob/master/LICENSE MIT License
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace Pdp;

src/CurlHttpClient.php

@@ -1,33 +1,23 @@
 <?php
+
 /**
  * PHP Domain Parser: Public Suffix List based URL parsing.
  *
  * @see http://github.com/jeremykendall/php-domain-parser for the canonical source repository
  *
  * @copyright Copyright (c) 2017 Jeremy Kendall (http://jeremykendall.net)
- * @license   http://github.com/jeremykendall/php-domain-parser/blob/master/LICENSE MIT License
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace Pdp;
 
-/**
- * Simple cURL Http client.
- *
- * Lifted pretty much completely from William Durand's excellent Geocoder
- * project
- *
- * @see https://github.com/willdurand/Geocoder Geocoder on GitHub
- *
- * @author William Durand <[email protected]>
- * @author Jeremy Kendall <[email protected]>
- * @author Ignace Nyamagana Butera <[email protected]>
- */
 final class CurlHttpClient implements HttpClient
 {
     /**
-     * Additionnal cURL options.
-     *
      * @var array
      */
     private $options;

src/Domain.php

@@ -1,12 +1,16 @@
 <?php
+
 /**
  * PHP Domain Parser: Public Suffix List based URL parsing.
  *
  * @see http://github.com/jeremykendall/php-domain-parser for the canonical source repository
  *
  * @copyright Copyright (c) 2017 Jeremy Kendall (http://jeremykendall.net)
- * @license   http://github.com/jeremykendall/php-domain-parser/blob/master/LICENSE MIT License
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace Pdp;
@@ -23,9 +27,6 @@
  * valid. The DNS is the proper source for this innormalizeion. If you must use
  * it for this purpose, please do not bake static copies of the PSL into your
  * software with no update mechanism."
- *
- * @author Jeremy Kendall <[email protected]>
- * @author Ignace Nyamagana Butera <[email protected]>
  */
 final class Domain implements DomainInterface, JsonSerializable
 {
@@ -122,7 +123,7 @@ private function setPublicSuffix(PublicSuffix $publicSuffix): PublicSuffix
      *
      * @return PublicSuffix
      */
-    private function normalize(PublicSuffix $subject): PublicSuffix
+    private function normalize($subject)
     {
         if (null === $this->domain || null === $subject->getContent()) {
             return $subject;
@@ -370,14 +371,7 @@ public function toAscii()
             return $this;
         }
 
-        $clone = clone $this;
-        $clone->domain = $domain;
-        $clone->labels = array_reverse(explode('.', $clone->domain));
-        $clone->publicSuffix = $this->publicSuffix->toAscii();
-        $clone->registrableDomain = $clone->setRegistrableDomain();
-        $clone->subDomain = $clone->setSubDomain();
-
-        return $clone;
+        return new self($domain, $this->publicSuffix);
     }
 
     /**
@@ -389,14 +383,7 @@ public function toUnicode()
             return $this;
         }
 
-        $clone = clone $this;
-        $clone->domain = $this->idnToUnicode($this->domain);
-        $clone->labels = array_reverse(explode('.', $clone->domain));
-        $clone->publicSuffix = $this->publicSuffix->toUnicode();
-        $clone->registrableDomain = $clone->setRegistrableDomain();
-        $clone->subDomain = $clone->setSubDomain();
-
-        return $clone;
+        return new self($this->idnToUnicode($this->domain), $this->publicSuffix);
     }
 
     /**
@@ -425,12 +412,7 @@ public function resolve($publicSuffix): self
             return $this;
         }
 
-        $clone = clone $this;
-        $clone->publicSuffix = $clone->setPublicSuffix($publicSuffix);
-        $clone->registrableDomain = $clone->setRegistrableDomain();
-        $clone->subDomain = $clone->setSubDomain();
-
-        return $clone;
+        return new self($this->domain, $publicSuffix);
     }
 
     /**
@@ -460,12 +442,9 @@ public function withSubDomain($subDomain): self
             return $this;
         }
 
-        $clone = clone $this;
-        $clone->labels = array_merge(array_slice($this->labels, 0, count($this->publicSuffix) + 1), iterator_to_array($subDomain));
-        $clone->domain = implode('.', array_reverse($clone->labels));
-        $clone->subDomain = $subDomain->getContent();
+        $labels = array_merge(array_slice($this->labels, 0, count($this->publicSuffix) + 1), iterator_to_array($subDomain));
 
-        return $clone;
+        return new self(implode('.', array_reverse(array_values($labels))), $this->publicSuffix);
     }
 
     /**
@@ -495,13 +474,9 @@ public function withPublicSuffix($publicSuffix): self
             return $this;
         }
 
-        $clone = clone $this;
-        $clone->labels = array_merge(iterator_to_array($publicSuffix), array_slice($this->labels, count($this->publicSuffix)));
-        $clone->domain = implode('.', array_reverse($clone->labels));
-        $clone->publicSuffix = $publicSuffix;
-        $clone->registrableDomain = $this->labels[count($this->publicSuffix)].'.'.$publicSuffix->getContent();
+        $labels = array_merge(iterator_to_array($publicSuffix), array_slice($this->labels, count($this->publicSuffix)));
 
-        return $clone;
+        return new self(implode('.', array_reverse(array_values($labels))), $publicSuffix);
     }
 
     /**
@@ -523,15 +498,14 @@ public function withPublicSuffix($publicSuffix): self
      */
     public function withLabel(int $key, $label): self
     {
-        if (!$label instanceof PublicSuffix) {
-            $label = $this->normalize(new PublicSuffix($label));
+        if (!$label instanceof Domain) {
+            $label = new Domain($label);
         }
 
         if (1 != count($label)) {
             throw new Exception(sprintf('The label `%s` is invalid', (string) $label));
         }
 
-        $label = (string) $label;
         $nb_labels = count($this->labels);
         $offset = filter_var($key, FILTER_VALIDATE_INT, ['options' => ['min_range' => - $nb_labels - 1, 'max_range' => $nb_labels]]);
         if (false === $offset) {
@@ -542,29 +516,23 @@ public function withLabel(int $key, $label): self
             $offset = $nb_labels + $offset;
         }
 
-        if ($label === ($this->labels[$offset] ?? null)) {
+        if (($this->labels[$offset] ?? null) === (string) $label) {
             return $this;
         }
 
-        $labels = $this->labels;
-        $labels[$offset] = $label;
-        ksort($labels);
-
-        $clone = clone $this;
-        $clone->labels = array_values($labels);
-        $clone->domain = implode('.', array_reverse($clone->labels));
-        if (null !== $this->publicSuffix->getLabel($offset)) {
-            $clone->publicSuffix = new PublicSuffix();
-            $clone->registrableDomain = null;
-            $clone->subDomain = null;
-
-            return $clone;
+        if (null !== $this->domain) {
+            static $pattern = '/[^\x20-\x7f]/';
+            $label = !preg_match($pattern, $this->domain) ? $label->toAscii() : $label->toUnicode();
         }
 
-        $clone->registrableDomain = $clone->setRegistrableDomain();
-        $clone->subDomain = $clone->setSubDomain();
+        $labels = $this->labels;
+        $labels[$offset] = (string) $label;
+        ksort($labels);
 
-        return $clone;
+        return new self(
+            implode('.', array_reverse(array_values($labels))),
+            null === $this->publicSuffix->getLabel($offset) ? $this->publicSuffix : null
+        );
     }
 
     /**
@@ -594,20 +562,12 @@ public function withoutLabel(int $key): self
             $offset = $nb_labels + $offset;
         }
 
-        $clone = clone $this;
-        unset($clone->labels[$offset]);
-        $clone->domain = implode('.', array_reverse($clone->labels));
-        if (null !== $this->publicSuffix->getLabel($offset)) {
-            $clone->publicSuffix = new PublicSuffix();
-            $clone->registrableDomain = null;
-            $clone->subDomain = null;
-
-            return $clone;
-        }
-
-        $clone->registrableDomain = $clone->setRegistrableDomain();
-        $clone->subDomain = $clone->setSubDomain();
+        $labels = $this->labels;
+        unset($labels[$offset]);
 
-        return $clone;
+        return new self(
+            implode('.', array_reverse(array_values($labels))),
+            null === $this->publicSuffix->getLabel($offset) ? $this->publicSuffix : null
+        );
     }
 }

src/DomainInterface.php

@@ -1,12 +1,16 @@
 <?php
+
 /**
  * PHP Domain Parser: Public Suffix List based URL parsing.
  *
  * @see http://github.com/jeremykendall/php-domain-parser for the canonical source repository
  *
  * @copyright Copyright (c) 2017 Jeremy Kendall (http://jeremykendall.net)
- * @license   http://github.com/jeremykendall/php-domain-parser/blob/master/LICENSE MIT License
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace Pdp;
@@ -20,8 +24,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
- *
- * @author Ignace Nyamagana Butera <[email protected]>
  */
 interface DomainInterface extends Countable, IteratorAggregate
 {

src/Exception.php

@@ -1,12 +1,16 @@
 <?php
+
 /**
  * PHP Domain Parser: Public Suffix List based URL parsing.
  *
  * @see http://github.com/jeremykendall/php-domain-parser for the canonical source repository
  *
  * @copyright Copyright (c) 2017 Jeremy Kendall (http://jeremykendall.net)
- * @license   http://github.com/jeremykendall/php-domain-parser/blob/master/LICENSE MIT License
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
  */
+
 declare(strict_types=1);
 
 namespace Pdp;

src/HttpClient.php

@@ -1,13 +1,11 @@
 <?php
+
 /**
- * League.Uri (http://uri.thephpleague.com).
+ * PHP Domain Parser: Public Suffix List based URL parsing.
+ *
+ * @see http://github.com/jeremykendall/php-domain-parser for the canonical source repository
  *
- * @package    League\Uri
- * @subpackage Pdp
- * @author     Ignace Nyamagana Butera <[email protected]>
- * @license    https://github.com/thephpleague/uri-hostname-parser/blob/master/LICENSE (MIT License)
- * @version    1.0.4
- * @link       https://github.com/thephpleague/uri-hostname-parser
+ * @copyright Copyright (c) 2017 Jeremy Kendall (http://jeremykendall.net)
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.