Merge pull request #23 from jeremykendall/fix/22

Adds the ability to properly parse single label domains (e.g., localhost, foo, etc.)

Author: jeremykendall

.gitignore

@@ -1,8 +1,8 @@
 tags
-tests/log
 data/*.txt
 composer.lock
 vendor
 *.swp
 docs
 *~
+build

README.md

@@ -190,6 +190,7 @@ Array
     [query] =>
     [fragment] =>
 )
+Host: http://www.waxaudio.com.au/
 ```
 
 ### Example Script ###

bin/parse

@@ -24,6 +24,7 @@ try {
     $parser = new Pdp\Parser($manager->getList());
     $url = $parser->parseUrl($domain);
     print_r($url->toArray());
+    echo sprintf('Host: %s', $url) . PHP_EOL;
 } catch (\Exception $e) {
     die($e->getMessage() . PHP_EOL);
 }

composer.json

@@ -10,7 +10,7 @@
         }
     ],
     "bin": [
-        "bin/parser",
+        "bin/parse",
         "bin/pdp-psl"
     ],
     "keywords": [

library/Pdp/Parser.php

@@ -91,10 +91,23 @@ public function parseUrl($url)
      */
     public function parseHost($host)
     {
+        $subdomain = null;
+        $registerableDomain = null;
+        $publicSuffix = null;
+
+        // Fixes #22: Single label domains are set as Host::$host and all other 
+        // properties are null.
+        if (strpos($host, '.') !== false) {
+            $subdomain = $this->getSubdomain($host);
+            $registerableDomain = $this->getRegisterableDomain($host);
+            $publicSuffix = $this->getPublicSuffix($host);
+        }
+
         return new Host(
-            $this->getSubdomain($host),
-            $this->getRegisterableDomain($host),
-            $this->getPublicSuffix($host)
+            $subdomain,
+            $registerableDomain,
+            $publicSuffix,
+            $host
         );
     }
 
@@ -110,6 +123,13 @@ public function getPublicSuffix($host)
             return null;
         }
 
+        // Fixes #22: If a single label domain makes it this far (e.g., 
+        // localhost, foo, etc.), this stops it from incorrectly being set as 
+        // the  public suffix.
+        if (strpos($host, '.') === false) {
+            return null;
+        }
+
         $host = strtolower($host);
         $parts = array_reverse(explode('.', $host));
         $publicSuffix = array();

library/Pdp/Uri/Url/Host.php

@@ -30,18 +30,25 @@ class Host
      */
     private $publicSuffix;
 
+    /**
+     * @var string host Entire host part
+     */
+    private $host;
+
     /**
      * Public constructor
      *
      * @param string|null $subdomain          Subdomain portion of host
-     * @param string      $registerableDomain Registerable domain portion of host
-     * @param string      $publicSuffix       Public suffix portion of host
+     * @param string|null $registerableDomain Registerable domain portion of host
+     * @param string|null $publicSuffix       Public suffix portion of host
+     * @param string      $host               OPTIONAL Entire host part
      */
-    public function __construct($subdomain, $registerableDomain, $publicSuffix)
+    public function __construct($subdomain, $registerableDomain, $publicSuffix, $host = null)
     {
         $this->subdomain = $subdomain;
         $this->registerableDomain = $registerableDomain;
         $this->publicSuffix = $publicSuffix;
+        $this->host = $host;
     }
 
     /**
@@ -51,13 +58,17 @@ public function __construct($subdomain, $registerableDomain, $publicSuffix)
      */
     public function __toString()
     {
-        $host = $this->registerableDomain;
-
-        if ($this->subdomain) {
-            $host = $this->subdomain . '.' . $host;
+        if ($this->host !== null) {
+            return $this->host;
         }
 
-        return $host;
+        // retain only the elements that are not empty
+        $str = array_filter(
+            array($this->subdomain, $this->registerableDomain),
+            'strlen'
+        );
+
+        return implode('.', $str);
     }
 
     /**
@@ -71,6 +82,7 @@ public function toArray()
             'subdomain' => $this->subdomain,
             'registerableDomain' => $this->registerableDomain,
             'publicSuffix' => $this->publicSuffix,
+            'host' => $this->host,
         );
     }
 

phpunit.xml.dist

@@ -20,13 +20,13 @@
 
     <logging>
         <log type="coverage-html" 
-            target="tests/log/report" 
+            target="build/coverage" 
             charset="UTF-8" 
             yui="true" 
             highlight="true" 
             lowUpperBound="40"
             highLowerBound="70" />
-        <log type="testdox-html" target="tests/log/testdox.html" />
+        <log type="testdox-html" target="build/coverage/log/testdox.html" />
     </logging>
 
 </phpunit>

tests/library/Pdp/ParserTest.php

@@ -135,6 +135,7 @@ public function parseDataProvider()
             // Test ftp support - https://github.com/jeremykendall/php-domain-parser/issues/18
             array('ftp://www.waxaudio.com.au/audio/albums/the_mashening', 'com.au', 'waxaudio.com.au', 'www', 'www.waxaudio.com.au'),
             array('ftps://test.k12.ak.us', 'k12.ak.us', 'test.k12.ak.us', null, 'test.k12.ak.us'),
+            array('http://localhost', null, null, null, 'localhost'),
         );
     }
 }

tests/library/Pdp/Uri/Url/HostTest.php

@@ -12,12 +12,24 @@ public function test__toString($publicSuffix, $registerableDomain, $subdomain, $
         $host = new Host(
             $subdomain,
             $registerableDomain,
-            $publicSuffix
+            $publicSuffix,
+            $hostPart
         );
 
         $this->assertEquals($hostPart, $host->__toString());
     }
 
+    public function test__toStringWhenHostPartIsNull()
+    {
+        $host = new Host(
+            'www',
+            'example.com',
+            'com'
+        );
+
+        $this->assertEquals('www.example.com', $host->__toString());
+    }
+
     /**
      * @dataProvider hostDataProvider
      */
@@ -26,15 +38,18 @@ public function test__get($publicSuffix, $registerableDomain, $subdomain, $hostP
         $parts = array(
             'subdomain' => $subdomain,
             'registerableDomain' => $registerableDomain,
-            'publicSuffix' => $publicSuffix
+            'publicSuffix' => $publicSuffix,
+            'host' => $hostPart,
         );
 
         $host = new Host(
             $parts['subdomain'],
             $parts['registerableDomain'],
-            $parts['publicSuffix']
+            $parts['publicSuffix'],
+            $parts['host']
         );
 
+        $this->assertSame($hostPart, $host->host);
         $this->assertSame($parts['subdomain'], $host->subdomain);
         $this->assertEquals($parts['registerableDomain'], $host->registerableDomain);
         $this->assertEquals($parts['publicSuffix'], $host->publicSuffix);
@@ -48,13 +63,15 @@ public function testToArray($publicSuffix, $registerableDomain, $subdomain, $hos
         $parts = array(
             'subdomain' => $subdomain,
             'registerableDomain' => $registerableDomain,
-            'publicSuffix' => $publicSuffix
+            'publicSuffix' => $publicSuffix,
+            'host' => $hostPart,
         );
 
         $host = new Host(
             $parts['subdomain'],
             $parts['registerableDomain'],
-            $parts['publicSuffix']
+            $parts['publicSuffix'],
+            $parts['host']
         );
 
         $this->assertEquals($parts, $host->toArray());
@@ -67,7 +84,8 @@ public function hostDataProvider()
             array('com', 'example.com', null, 'example.com'),
             array('com', 'cnn.com', 'edition', 'edition.cnn.com'),
             array('org', 'wikipedia.org', 'en', 'en.wikipedia.org'),
-            array('uk.com', 'example.uk.com', 'a.b', 'a.b.example.uk.com')
+            array('uk.com', 'example.uk.com', 'a.b', 'a.b.example.uk.com'),
+            array(null, null, null, 'localhost'),
         );
     }
 }