Adding v5 docblock (#197)

* Improve Test Suite

- adding tests to cover all new Object and methods
- improve docblocks
- normalize class file headers
- improve classes typehint and return type

* typo fix between repo

* bugfix files credits

* Improve PublicSuffixList

* Improve PublicSuffixList

* Improve test suite

- better covers for UnmatchedDomain and Matched
- improve PublicSuffixList::query method
- improve hasRegistrableDomain to look like isMatchable method
- removed deprecated feature (parse_url and associated files and classes)

Author: nyamsprod

composer.json

@@ -38,10 +38,7 @@
     "autoload": {
         "psr-0": {
             "Pdp\\": "src/"
-        },
-        "files": [
-            "src/pdp-parse-url.php"
-        ]
+        }
     },
     "scripts": {
         "post-install-cmd": "php bin/update-psl"

example.php

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit 
+<phpunit
     backupGlobals="false"
     backupStaticAttributes="false"
-    bootstrap="tests/bootstrap.php" 
+    bootstrap="tests/bootstrap.php"
     colors="true">
 
     <testsuite name="php-domain-parser">
@@ -16,14 +16,18 @@
     </filter>
 
     <logging>
-        <log type="coverage-html" 
-            target="build/coverage" 
-            charset="UTF-8" 
-            yui="true" 
-            highlight="true" 
+        <log type="coverage-html"
+            target="build/coverage"
+            charset="UTF-8"
+            yui="true"
+            highlight="true"
             lowUpperBound="40"
             highLowerBound="70" />
         <log type="testdox-html" target="build/coverage/log/testdox.html" />
+        <log type="junit" target="build/report.junit.xml"/>
+        <log type="coverage-text" target="build/coverage.txt"/>
+        <log type="coverage-clover" target="build/clover.xml"/>
     </logging>
-
+    <logging>
+</logging>
 </phpunit>

phpunit.xml.dist

@@ -1,14 +1,13 @@
 <?php
-declare(strict_types=1);
-
 /**
- * Public Suffix List PHP: Public Suffix List based URL parsing.
+ * PHP Domain Parser: Public Suffix List based URL parsing.
  *
- * @see http://github.com/jeremykendall/publicsuffixlist-php for the canonical source repository
+ * @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/publicsuffixlist-php/blob/master/LICENSE MIT License
+ * @license   http://github.com/jeremykendall/php-domain-parser/blob/master/LICENSE MIT License
  */
+declare(strict_types=1);
 
 namespace Pdp;
 

src/Pdp/Domain.php

@@ -1,13 +1,14 @@
 <?php
-
 /**
  * PHP Domain Parser: Public Suffix List based URL parsing.
  *
- * @link      http://github.com/jeremykendall/php-domain-parser for the canonical source repository
+ * @see http://github.com/jeremykendall/php-domain-parser for the canonical source repository
  *
- * @copyright Copyright (c) 2014 Jeremy Kendall (http://about.me/jeremykendall)
+ * @copyright Copyright (c) 2017 Jeremy Kendall (http://jeremykendall.net)
  * @license   http://github.com/jeremykendall/php-domain-parser/blob/master/LICENSE MIT License
  */
+declare(strict_types=1);
+
 namespace Pdp\HttpAdapter;
 
 /**
@@ -26,7 +27,7 @@ class CurlHttpAdapter implements HttpAdapterInterface
     /**
      * {@inheritdoc}
      */
-    public function getContent($url)
+    public function getContent(string $url)
     {
         $ch = curl_init();
         curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

src/Pdp/Exception/PdpException.php

@@ -1,13 +1,14 @@
 <?php
-
 /**
  * PHP Domain Parser: Public Suffix List based URL parsing.
  *
- * @link      http://github.com/jeremykendall/php-domain-parser for the canonical source repository
+ * @see http://github.com/jeremykendall/php-domain-parser for the canonical source repository
  *
- * @copyright Copyright (c) 2014 Jeremy Kendall (http://about.me/jeremykendall)
+ * @copyright Copyright (c) 2017 Jeremy Kendall (http://jeremykendall.net)
  * @license   http://github.com/jeremykendall/php-domain-parser/blob/master/LICENSE MIT License
  */
+declare(strict_types=1);
+
 namespace Pdp\HttpAdapter;
 
 /**
@@ -30,5 +31,5 @@ interface HttpAdapterInterface
      *
      * @return string Retrieved content
      */
-    public function getContent($url);
+    public function getContent(string $url);
 }

src/Pdp/Exception/SeriouslyMalformedUrlException.php

@@ -1,34 +1,61 @@
 <?php
-
-declare(strict_types=1);
-
 /**
- * Public Suffix List PHP: Public Suffix List based URL parsing.
+ * PHP Domain Parser: Public Suffix List based URL parsing.
  *
- * @see http://github.com/jeremykendall/publicsuffixlist-php for the canonical source repository
+ * @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/publicsuffixlist-php/blob/master/LICENSE MIT License
+ * @license   http://github.com/jeremykendall/php-domain-parser/blob/master/LICENSE MIT License
  */
+declare(strict_types=1);
+
 namespace Pdp;
 
 trait LabelsTrait
 {
+    /**
+     * Returns labels from input
+     *
+     * @param string $input
+     *
+     * @return string[]
+     */
     private function getLabels(string $input): array
     {
         return explode('.', $input);
     }
 
+    /**
+     * Returns labels from input in reverse
+     *
+     * @param string $input
+     *
+     * @return string[]
+     */
     private function getLabelsReverse(string $input): array
     {
         return array_reverse($this->getLabels($input));
     }
 
-    private function hasLabels(string $input): bool
+    /**
+     * Tells whether the domain contains multiple labels
+     *
+     * @param string $domain
+     *
+     * @return bool
+     */
+    private function hasLabels(string $domain): bool
     {
-        return strpos($input, '.') !== false;
+        return strpos($domain, '.') !== false;
     }
 
+    /**
+     * Tells whether the domain contains one single label
+     *
+     * @param string $domain
+     *
+     * @return bool
+     */
     private function isSingleLabelDomain(string $domain): bool
     {
         return !$this->hasLabels($domain);