Rename alias method for better UX

Author: nyamsprod

CHANGELOG.md

@@ -6,10 +6,10 @@ All Notable changes to `PHP Domain Parser` **5.x** series will be documented in
 
 ### Added
 
-- `Rules::icannResolve`
-- `Rules::cookieResolve`
-- `Rules::privateResolve`
-
+- `Rules::resolveCookieDomain`
+- `Rules::resolveICANNDomain`
+- `Rules::resolvePrivateDomain`
+- `CouldNotResolvePublicSuffix::dueToUnresolvableDomain`
 
 ### Fixed
 

src/Domain.php

@@ -156,7 +156,7 @@ private function setPublicSuffix(PublicSuffix $publicSuffix): PublicSuffix
         }
 
         if (null === $this->domain || !$this->isResolvable()) {
-            throw new CouldNotResolvePublicSuffix(sprintf('The domain `%s` can not contain a public suffix', $this->domain));
+            throw CouldNotResolvePublicSuffix::dueToUnresolvableDomain($this);
         }
 
         $publicSuffix = $this->normalize($publicSuffix);

src/Exception/CouldNotResolvePublicSuffix.php

@@ -15,8 +15,37 @@
 
 namespace Pdp\Exception;
 
+use Pdp\Domain;
 use Pdp\Exception as BaseException;
+use function sprintf;
 
 class CouldNotResolvePublicSuffix extends BaseException
 {
+    /**
+     * @var Domain|null
+     */
+    private $domain;
+
+    public static function dueToUnresolvableDomain(?Domain $domain): self
+    {
+        $content = $domain;
+        if (null !== $domain) {
+            $content = $domain->getContent();
+        }
+
+        $exception = new self(sprintf('The domain `%s` can not contain a public suffix.', $content));
+        $exception->domain = $domain;
+
+        return $exception;
+    }
+
+    public function hasDomain(): bool
+    {
+        return null !== $this->domain;
+    }
+
+    public function getDomain(): ?Domain
+    {
+        return $this->domain;
+    }
 }

src/Rules.php

@@ -213,13 +213,20 @@ public function resolve($domain, string $section = self::ALL_DOMAINS): Domain
         $section = $this->validateSection($section);
         try {
             if ('' === $section) {
-                return $this->cookieResolve($domain);
+                return $this->resolveCookieDomain($domain);
             } elseif (self::ICANN_DOMAINS === $section) {
-                return $this->icannResolve($domain);
+                return $this->resolveICANNDomain($domain);
             }
 
-            return $this->privateResolve($domain);
+            return $this->resolvePrivateDomain($domain);
         } catch (CouldNotResolvePublicSuffix $exception) {
+            if ($exception->hasDomain()) {
+                /** @var Domain */
+                $domain = $exception->getDomain();
+
+                return $domain;
+            }
+
             return new Domain($domain, null, $this->asciiIDNAOption, $this->unicodeIDNAOption);
         } catch (Exception $exception) {
             return new Domain(null, null, $this->asciiIDNAOption, $this->unicodeIDNAOption);
@@ -231,7 +238,7 @@ public function resolve($domain, string $section = self::ALL_DOMAINS): Domain
      *
      * @param mixed $domain the domain value
      */
-    public function cookieResolve($domain): Domain
+    public function resolveCookieDomain($domain): Domain
     {
         $domain = $this->validateDomain($domain);
 
@@ -243,7 +250,7 @@ public function cookieResolve($domain): Domain
      *
      * @param mixed $domain
      */
-    public function icannResolve($domain): Domain
+    public function resolveICANNDomain($domain): Domain
     {
         $domain = $this->validateDomain($domain);
 
@@ -255,7 +262,7 @@ public function icannResolve($domain): Domain
      *
      * @param mixed $domain
      */
-    public function privateResolve($domain): Domain
+    public function resolvePrivateDomain($domain): Domain
     {
         $domain = $this->validateDomain($domain);
 
@@ -277,7 +284,7 @@ private function validateDomain($domain): Domain
         }
 
         if (!$domain->isResolvable()) {
-            throw new CouldNotResolvePublicSuffix(sprintf('The domain `%s` can not contain a public suffix.', $domain->getContent()));
+            throw CouldNotResolvePublicSuffix::dueToUnresolvableDomain($domain);
         }
 
         return $domain;

tests/RulesTest.php

@@ -114,9 +114,9 @@ public function testwithIDNAOptions(): void
 
     /**
      * @covers ::resolve
-     * @covers ::cookieResolve
-     * @covers ::icannResolve
-     * @covers ::privateResolve
+     * @covers ::resolveCookieDomain
+     * @covers ::resolveICANNDomain
+     * @covers ::resolvePrivateDomain
      * @covers ::validateDomain
      * @covers ::validateSection
      * @covers \Pdp\Domain::isResolvable
@@ -195,7 +195,7 @@ public function testIsSuffixValidTrue(): void
 
     /**
      * @covers ::resolve
-     * @covers ::cookieResolve
+     * @covers ::resolveCookieDomain
      * @covers ::validateDomain
      * @covers ::validateSection
      * @covers \Pdp\Domain::isResolvable
@@ -221,7 +221,7 @@ public function testIsSuffixValidFalseWithPunycoded(): void
 
     /**
      * @covers ::resolve
-     * @covers ::icannResolve
+     * @covers ::resolveICANNDomain
      * @covers ::validateDomain
      * @covers ::validateSection
      * @covers \Pdp\Domain::isResolvable
@@ -247,7 +247,7 @@ public function testSubDomainIsNull(): void
 
     /**
      * @covers ::resolve
-     * @covers ::cookieResolve
+     * @covers ::resolveCookieDomain
      * @covers ::validateDomain
      * @covers ::validateSection
      * @covers \Pdp\IDNAConverterTrait::parse
@@ -291,7 +291,7 @@ public function testWithAbsoluteHostInvalid(): void
 
     /**
      * @covers ::resolve
-     * @covers ::privateResolve
+     * @covers ::resolvePrivateDomain
      * @covers ::validateDomain
      * @covers ::validateSection
      * @covers ::findPublicSuffix
@@ -311,7 +311,7 @@ public function testWithPrivateDomainInvalid(): void
 
     /**
      * @covers ::resolve
-     * @covers ::privateResolve
+     * @covers ::resolvePrivateDomain
      * @covers ::validateDomain
      * @covers ::validateSection
      * @covers ::findPublicSuffix
@@ -381,7 +381,7 @@ public function testWithDomainInterfaceObject(): void
 
     /**
      * @covers ::resolve
-     * @covers ::icannResolve
+     * @covers ::resolveICANNDomain
      * @covers ::validateDomain
      * @covers \Pdp\Domain::setRegistrableDomain
      * @covers \Pdp\Domain::getRegistrableDomain
@@ -399,7 +399,7 @@ public function testGetRegistrableDomain($publicSuffix, $registrableDomain, $dom
 
     /**
      * @covers ::resolve
-     * @covers ::icannResolve
+     * @covers ::resolveICANNDomain
      * @covers ::validateDomain
      * @covers \Pdp\IDNAConverterTrait::parse
      * @covers \Pdp\Domain::setPublicSuffix