Improve Domain Value Object

Author: nyamsprod

CHANGELOG.md

@@ -2,6 +2,25 @@
 
 All Notable changes to `PHP Domain Parser` **5.x** series will be documented in this file
 
+## Next - TBD
+
+### Added
+
+- `Pdp\Domain::getContent` returns the Domain name value replaces `Pdp\Domain::getDomain`
+- `Pdp\Domain` implements the `Countable` interface.
+
+### Fixed
+
+- `Pdp\Domain` domain part computation (public suffix, registrable domain and sub domain)
+
+### Deprecated
+
+- `Pdp\Domain::getDomain` use instead `Pdp\Domain::getContent`
+
+### Removed
+
+- None
+
 ## 5.2.0 - 2018-02-23
 
 ### Added

data/pdp-PSL_FULL_5a3cc7f81795bb2e48e848af42d287b4.cache

@@ -11,6 +11,7 @@
 
 namespace Pdp;
 
+use Countable;
 use JsonSerializable;
 
 /**
@@ -27,7 +28,7 @@
  * @author Jeremy Kendall <[email protected]>
  * @author Ignace Nyamagana Butera <[email protected]>
  */
-final class Domain implements JsonSerializable
+final class Domain implements Countable, JsonSerializable
 {
     use IDNAConverterTrait;
 
@@ -67,56 +68,72 @@ public static function __set_state(array $properties): self
      */
     public function __construct($domain = null, PublicSuffix $publicSuffix = null)
     {
-        if (false !== strpos((string) $domain, '%')) {
-            $domain = rawurldecode($domain);
+        $this->domain = $this->setDomain($domain);
+        $this->publicSuffix = $this->setPublicSuffix($publicSuffix);
+        $this->registrableDomain = $this->setRegistrableDomain();
+        $this->subDomain = $this->setSubDomain();
+    }
+
+    /**
+     * Normalize the given domain.
+     *
+     * @param string|null $domain
+     *
+     * @return string|null
+     */
+    private function setDomain(string $domain = null)
+    {
+        if (null === $domain) {
+            return null;
         }
 
-        if (null !== $domain) {
-            $domain = strtolower($domain);
+        if (false !== strpos($domain, '%')) {
+            $domain = rawurldecode($domain);
         }
 
-        $this->domain = $domain;
-        $this->publicSuffix = $this->setPublicSuffix($publicSuffix);
-        $this->registrableDomain = $this->setRegistrableDomain();
-        $this->subDomain = $this->setSubDomain();
+        return strtolower($domain);
     }
 
     /**
-     * Filter the PublicSuffix
+     * Sets the public suffix domain part.
      *
      * @param PublicSuffix|null $publicSuffix
      *
      * @return PublicSuffix
      */
     private function setPublicSuffix(PublicSuffix $publicSuffix = null): PublicSuffix
     {
-        if (null === $publicSuffix || null === $this->domain) {
+        $publicSuffix = $publicSuffix ?? new PublicSuffix();
+        if (null === $publicSuffix->getContent()) {
+            return $publicSuffix;
+        }
+
+        if (null === $this->domain || false === strpos($this->domain, '.')) {
             return new PublicSuffix();
         }
 
         return $publicSuffix;
     }
 
     /**
-     * Compute the registrable domain part.
+     * Computes the registrable domain part.
      *
      * @return string|null
      */
     private function setRegistrableDomain()
     {
-        if (false === strpos((string) $this->domain, '.')) {
+        if (null === $this->publicSuffix->getContent()) {
             return null;
         }
 
-        if (in_array($this->publicSuffix->getContent(), [null, $this->domain], true)) {
+        $labels = explode('.', $this->domain);
+        $countLabels = count($labels);
+        $countPublicSuffixLabels = count($this->publicSuffix);
+        if ($countLabels === $countPublicSuffixLabels) {
             return null;
         }
 
-        $nbLabelsToRemove = count($this->publicSuffix) + 1;
-        $domainLabels = explode('.', $this->domain);
-        $registrableDomain = implode('.', array_slice($domainLabels, count($domainLabels) - $nbLabelsToRemove));
-
-        return $registrableDomain;
+        return implode('.', array_slice($labels, $countLabels - $countPublicSuffixLabels - 1));
     }
 
     /**
@@ -130,16 +147,14 @@ private function setSubDomain()
             return null;
         }
 
-        $nbLabelsToRemove = count($this->publicSuffix) + 1;
-        $domainLabels = explode('.', $this->domain);
-        $countLabels = count($domainLabels);
-        if ($countLabels === $nbLabelsToRemove) {
+        $labels = explode('.', $this->domain);
+        $countLabels = count($labels);
+        $countLabelsToRemove = count(explode('.', $this->registrableDomain));
+        if ($countLabels === $countLabelsToRemove) {
             return null;
         }
 
-        $subDomain = implode('.', array_slice($domainLabels, 0, $countLabels - $nbLabelsToRemove));
-
-        return $subDomain;
+        return implode('.', array_slice($labels, 0, $countLabels - $countLabelsToRemove));
     }
 
     /**
@@ -162,16 +177,45 @@ public function __debugInfo()
         return $this->jsonSerialize();
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function count()
+    {
+        if (null === $this->domain) {
+            return 0;
+        }
+
+        return count(explode('.', $this->domain));
+    }
+
+    /**
+     * Returns the domain content.
+     *
+     * This method should return null on seriously malformed domain name
+     *
+     * @return string|null
+     */
+    public function getContent()
+    {
+        return $this->domain;
+    }
+
     /**
      * Returns the full domain name.
      *
+     * DEPRECATION WARNING! This method will be removed in the next major point release
+     *
+     * @deprecated deprecated since version 5.3
+     * @see Domain::getContent
+     *
      * This method should return null on seriously malformed domain name
      *
      * @return string|null
      */
     public function getDomain()
     {
-        return $this->domain;
+        return $this->getContent();
     }
 
     /**

src/Domain.php

@@ -90,16 +90,6 @@ public function __debugInfo()
         return $this->jsonSerialize();
     }
 
-    /**
-     * Returns the public suffix content.
-     *
-     * @return string|null
-     */
-    public function getContent()
-    {
-        return $this->publicSuffix;
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -112,6 +102,16 @@ public function count()
         return count(explode('.', $this->publicSuffix));
     }
 
+    /**
+     * Returns the public suffix content.
+     *
+     * @return string|null
+     */
+    public function getContent()
+    {
+        return $this->publicSuffix;
+    }
+
     /**
      * Tells whether the public suffix has a matching rule in a Public Suffix List.
      *

src/PublicSuffix.php

@@ -52,6 +52,12 @@ public function testDomainInternalPhpMethod()
         $generateDomain = eval('return '.var_export($domain, true).';');
         $this->assertInternalType('array', $domain->__debugInfo());
         $this->assertEquals($domain, $generateDomain);
+        $this->assertCount(4, $domain);
+    }
+
+    public function testDomainWithNullLabels()
+    {
+        $this->assertCount(0, new Domain());
     }
 
     public function testPublicSuffixnternalPhpMethod()