Merge pull request #324 from jeremykendall/develop

Prepare 6.1.1 release
jeremykendall · Feb 18, 2022 · e195ab7 · e195ab7
2 parents d8b196b + 1df0801
commit e195ab7
Show file tree

Hide file tree

Showing 15 changed files with 2,569 additions and 954 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -10,7 +10,7 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                php: [ '7.4', '8.0' ]
+                php: [ '7.4', '8.0', '8.1' ]
                 composer-flags: [ '' ]
                 phpunit-flags: [ '--coverage-text' ]
         steps:
@@ -23,8 +23,8 @@ jobs:
             - run: composer update --no-progress ${{ matrix.composer-flags }}
             - run: composer phpunit
             - run: composer phpstan
-              if: ${{ matrix.php == '8.0' }}
+              if: ${{ matrix.php == '8.1' }}
             - run: composer psalm
-              if: ${{ matrix.php == '8.0' }}
+              if: ${{ matrix.php == '8.1' }}
             - run: composer phpcs
-              if: ${{ matrix.php == '8.0' }}
+              if: ${{ matrix.php == '8.1' }}
diff --git a/.gitignore b/.gitignore
@@ -4,5 +4,6 @@ docs
 build
 .idea
 .php_cs.cache
+.php-cs-fixer.cache
 .phpunit.result.cache
 composer.lock
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
@@ -11,21 +11,31 @@
         '@PSR2' => true,
         'array_syntax' => ['syntax' => 'short'],
         'concat_space' => ['spacing' => 'none'],
+        'global_namespace_import' => [
+            'import_classes' => true,
+            'import_constants' => true,
+            'import_functions' => true,
+        ],
+        'list_syntax' => ['syntax' => 'short'],
         'new_with_braces' => true,
         'no_blank_lines_after_phpdoc' => true,
         'no_empty_phpdoc' => true,
         'no_empty_comment' => true,
         'no_leading_import_slash' => true,
-        'no_superfluous_phpdoc_tags' => true,
+        'no_superfluous_phpdoc_tags' => [
+            'allow_mixed' => true,
+            'remove_inheritdoc' => true,
+            'allow_unused_params' => false,
+        ],
         'no_trailing_comma_in_singleline_array' => true,
         'no_unused_imports' => true,
         'ordered_imports' => ['imports_order' => ['class', 'function', 'const'], 'sort_algorithm' => 'alpha'],
-        'phpdoc_add_missing_param_annotation' => ['only_untyped' => false],
+        'phpdoc_add_missing_param_annotation' => ['only_untyped' => true],
         'phpdoc_align' => true,
         'phpdoc_no_empty_return' => true,
         'phpdoc_order' => true,
         'phpdoc_scalar' => true,
-        'phpdoc_to_comment' => false,
+        'phpdoc_to_comment' => true,
         'phpdoc_summary' => true,
         'psr_autoloading' => true,
         'return_type_declaration' => ['space_before' => 'none'],
@@ -36,7 +46,5 @@
         'trailing_comma_in_multiline' => true,
         'trim_array_spaces' => true,
         'whitespace_after_comma_in_array' => true,
-        'yoda_style' => true,
     ])
-    ->setFinder($finder)
-;
+    ->setFinder($finder);
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,24 @@
 
 All Notable changes to `PHP Domain Parser` starting from the **5.x** series will be documented in this file
 
+## 6.1.1 - 2022-02-18
+
+### Added
+
+- None
+
+### Fixed
+
+- [#321](https://github.com/jeremykendall/php-domain-parser/issues/321) improve resolving private domain suffix. `Rules::getPrivateDomain` will now throw if the domain name does not contain a "private" TLD.
+
+### Deprecated
+
+- None
+
+### Removed
+
+- None
+
 ## 6.1.0 - 2021-06-19
 
 ### Added

diff --git a/composer.json b/composer.json
@@ -46,18 +46,18 @@
         "ext-json": "*"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "^2.16",
+        "friendsofphp/php-cs-fixer": "^v3.5.0",
         "guzzlehttp/guzzle": "^7.0",
-        "guzzlehttp/psr7": "^1.6",
-        "phpstan/phpstan": "^0.12",
-        "phpstan/phpstan-phpunit": "^0.12",
-        "phpstan/phpstan-strict-rules": "^0.12",
-        "phpunit/phpunit": "^9.3",
-        "psalm/plugin-phpunit": "^0.15.0",
+        "guzzlehttp/psr7": "^1.6||^2.0",
+        "phpstan/phpstan": "^1.4.6.",
+        "phpstan/phpstan-phpunit": "^1.0.0",
+        "phpstan/phpstan-strict-rules": "^1.1.0",
+        "phpunit/phpunit": "^9.5.13",
+        "psalm/plugin-phpunit": "^0.15.2",
         "psr/http-factory": "^1.0",
         "psr/simple-cache": "^1.0",
         "symfony/cache": "^v5.0",
-        "vimeo/psalm": "^4.3"
+        "vimeo/psalm": "^4.20"
     },
     "suggest": {
         "psr/http-client-implementation": "To use the storage functionnality which depends on PSR-18",

diff --git a/phpstan.neon b/phpstan.neon
@@ -4,4 +4,12 @@ includes:
   - vendor/phpstan/phpstan-phpunit/rules.neon
 parameters:
   ignoreErrors:
+    - message: '#has no value type specified in iterable type array.#'
+      path: src/Rules.php
+    - message: '#has parameter \$(properties|rules|list|tmpList) with no value type specified in iterable type array.#'
+      path: src/Rules.php
+    - message: "#Cannot access offset '!' on mixed.#"
+      path: src/Rules.php
+    - message: '#Variable \$line on left side of \?\? always exists and is not nullable.#'
+      path: src/Rules.php
   reportUnmatchedIgnoredErrors: true
diff --git a/src/DomainName.php b/src/DomainName.php
@@ -101,7 +101,6 @@ public function withLabel(int $key, $label): self;
      * If $key is non-negative, the removed label will be the label at $key position from the start.
      * If $key is negative, the removed label will be the label at $key position from the end.
      *
-     * @param int ...$keys
      *
      * @throws CannotProcessHost If the key is out of bounds
      */

diff --git a/src/DomainTest.php b/src/DomainTest.php
@@ -5,6 +5,7 @@
 namespace Pdp;
 
 use PHPUnit\Framework\TestCase;
+use stdClass;
 use TypeError;
 
 /**
@@ -314,7 +315,7 @@ public function withLabelWorksProvider(): iterable
     public function testWithLabelFailsWithTypeError(): void
     {
         $this->expectException(TypeError::class);
-        Domain::fromIDNA2008('example.com')->withLabel(1, new \stdClass());
+        Domain::fromIDNA2008('example.com')->withLabel(1, new stdClass());
     }
 
     public function testWithLabelFailsWithInvalidKey(): void

diff --git a/src/Idna.php b/src/Idna.php
@@ -99,7 +99,7 @@ public static function toAscii(string $domain, int $options): IdnaInfo
 
         self::supportsIdna();
 
-        /** @param-out array{errors: int, isTransitionalDifferent: bool, result: string} $idnaInfo */
+        /* @param-out array{errors: int, isTransitionalDifferent: bool, result: string} $idnaInfo */
         idn_to_ascii($domain, $options, INTL_IDNA_VARIANT_UTS46, $idnaInfo);
 
         /** @var array{result:string, isTransitionalDifferent:bool, errors:int} $idnaInfo */
@@ -124,7 +124,7 @@ public static function toUnicode(string $domain, int $options): IdnaInfo
 
         self::supportsIdna();
 
-        /** @param-out array{errors: int, isTransitionalDifferent: bool, result: string} $idnaInfo */
+        /* @param-out array{errors: int, isTransitionalDifferent: bool, result: string} $idnaInfo */
         idn_to_utf8($domain, $options, INTL_IDNA_VARIANT_UTS46, $idnaInfo);
 
         /** @var array{result:string, isTransitionalDifferent:bool, errors:int} $idnaInfo */

diff --git a/src/Rules.php b/src/Rules.php
@@ -36,12 +36,12 @@ final class Rules implements PublicSuffixList
     /**
      * PSL rules as a multidimensional associative array.
      *
-     * @var array<string, array<array>>
+     * @var array{ICANN_DOMAINS: array<array>, PRIVATE_DOMAINS: array<array>}
      */
     private array $rules;
 
     /**
-     * @param array<string, array<array>> $rules
+     * @param array{ICANN_DOMAINS: array<array>, PRIVATE_DOMAINS: array<array>} $rules
      */
     private function __construct(array $rules)
     {
@@ -84,7 +84,7 @@ public static function fromString($content): self
     /**
      * Convert the Public Suffix List into an associative, multidimensional array.
      *
-     * @return array<string, array<array>>
+     * @return array{ICANN_DOMAINS: array<array>, PRIVATE_DOMAINS: array<array>}
      */
     private static function parse(string $content): array
     {
@@ -165,7 +165,7 @@ private static function addRule(array $list, array $ruleParts): array
     }
 
     /**
-     * @param array{rules:array<string, array<array>>} $properties
+     * @param array{rules:array{ICANN_DOMAINS: array<array>, PRIVATE_DOMAINS: array<array>}} $properties
      */
     public static function __set_state(array $properties): self
     {
@@ -290,18 +290,23 @@ private function getPublicSuffixLengthFromSection(DomainName $domain, string $se
         $labelCount = 0;
         foreach ($domain->toAscii() as $label) {
             //match exception rule
-            if (isset($rules[$label], $rules[$label]['!'])) {
+            if (isset($rules[$label]['!'])) {
                 break;
             }
 
             //match wildcard rule
-            if (isset($rules['*'])) {
+            if (array_key_exists('*', $rules)) {
                 ++$labelCount;
                 break;
             }
 
             //no match found
-            if (!isset($rules[$label])) {
+            if (!array_key_exists($label, $rules)) {
+                // for private domain suffix MUST be fully matched else no suffix is found
+                // https://github.com/jeremykendall/php-domain-parser/issues/321
+                if (self::PRIVATE_DOMAINS === $section && [] !== $rules) {
+                    $labelCount = 0;
+                }
                 break;
             }
 

diff --git a/src/RulesTest.php b/src/RulesTest.php
@@ -593,4 +593,22 @@ public function effectiveTLDProvider(): iterable
             ],
         ];
     }
+
+    public function testIssue321Success(): void
+    {
+        $result = self::$rules->resolve('node857-gelofesta.users.scale.virtualcloud.com.br');
+        self::assertSame('users.scale.virtualcloud.com.br', $result->suffix()->value());
+        self::assertTrue($result->suffix()->isPrivate());
+
+        $result = self::$rules->resolve('clientportal.virtualcloud.com.br');
+        self::assertSame('com.br', $result->suffix()->value());
+        self::assertTrue($result->suffix()->isICANN());
+    }
+
+    public function testIssue321Failure(): void
+    {
+        $this->expectException(UnableToResolveDomain::class);
+
+        self::$rules->getPrivateDomain('clientportal.virtualcloud.com.br');
+    }
 }
diff --git a/src/Storage/PublicSuffixListPsr16CacheTest.php b/src/Storage/PublicSuffixListPsr16CacheTest.php
@@ -4,6 +4,8 @@
 
 namespace Pdp\Storage;
 
+use DateInterval;
+use DateTimeImmutable;
 use InvalidArgumentException;
 use Pdp\Rules;
 use PHPUnit\Framework\TestCase;
@@ -54,7 +56,7 @@ public function testItReturnsNullIfTheCacheContentCannotBeConvertedToTheCorrectI
         $cache = $this->createStub(CacheInterface::class);
         $cache->method('get')->willReturn('{"foo":"bar"}');
 
-        $pslCache = new PublicSuffixListPsr16Cache($cache, 'pdp_', new \DateTimeImmutable('+1 DAY'));
+        $pslCache = new PublicSuffixListPsr16Cache($cache, 'pdp_', new DateTimeImmutable('+1 DAY'));
 
         self::assertNull($pslCache->fetch('http://www.example.com'));
     }
@@ -65,7 +67,7 @@ public function testItCanStoreAPublicSuffixListInstance(): void
         $cache->method('set')->willReturn(true);
 
         $psl = Rules::fromPath(dirname(__DIR__, 2).'/test_data/public_suffix_list.dat');
-        $pslCache = new PublicSuffixListPsr16Cache($cache, 'pdp_', new \DateInterval('P1D'));
+        $pslCache = new PublicSuffixListPsr16Cache($cache, 'pdp_', new DateInterval('P1D'));
 
         self::assertTrue($pslCache->remember('http://www.example.com', $psl));
     }
@@ -76,7 +78,7 @@ public function testItReturnsFalseIfItCantStoreAPublicSuffixListInstance(): void
         $cache->method('set')->willReturn(false);
 
         $psl = Rules::fromPath(dirname(__DIR__, 2).'/test_data/public_suffix_list.dat');
-        $pslCache = new PublicSuffixListPsr16Cache($cache, 'pdp_', new \DateInterval('P1D'));
+        $pslCache = new PublicSuffixListPsr16Cache($cache, 'pdp_', new DateInterval('P1D'));
 
         self::assertFalse($pslCache->remember('http://www.example.com', $psl));
     }
@@ -89,7 +91,7 @@ public function testItReturnsFalseIfItCantCacheAPublicSuffixListInstance(): void
         $cache->method('set')->will(self::throwException($exception));
 
         $psl = Rules::fromPath(dirname(__DIR__, 2).'/test_data/public_suffix_list.dat');
-        $pslCache = new PublicSuffixListPsr16Cache($cache, 'pdp_', new \DateInterval('P1D'));
+        $pslCache = new PublicSuffixListPsr16Cache($cache, 'pdp_', new DateInterval('P1D'));
 
         self::assertFalse($pslCache->remember('http://www.example.com', $psl));
     }
@@ -120,7 +122,7 @@ public function testItCanDeleteTheCachedDatabase(): void
         $cache = $this->createStub(CacheInterface::class);
         $cache->method('delete')->willReturn(true);
 
-        $instance = new PublicSuffixListPsr16Cache($cache, 'pdp_', new \DateInterval('P1D'));
+        $instance = new PublicSuffixListPsr16Cache($cache, 'pdp_', new DateInterval('P1D'));
         self::assertTrue($instance->forget($uri));
     }
 

diff --git a/src/TopLevelDomainList.php b/src/TopLevelDomainList.php
@@ -24,9 +24,7 @@ public function version(): string;
      */
     public function lastUpdated(): DateTimeImmutable;
 
-    /**
-     * {@inheritdoc}
-     */
+
     public function count(): int;
 
     /**

diff --git a/src/TopLevelDomainsTest.php b/src/TopLevelDomainsTest.php
@@ -193,7 +193,7 @@ public function testGetTopLevelDomain($tld): void
     }
 
     /**
-     * @return iterable<string,array>
+     * @return iterable<string,array<object|string>>
      */
     public function validDomainProvider(): iterable
     {
@@ -286,7 +286,7 @@ public function testGetTopLevelDomainWithUnregisteredTLD(): void
     }
 
     /**
-     * @return iterable<string,array>
+     * @return iterable<string,array<string|object>>
      */
     public function validTldProvider(): iterable
     {
@@ -312,7 +312,7 @@ public function __toString(): string
     }
 
     /**
-     * @return iterable<string,array>
+     * @return iterable<string,array<object|string|null>>
      */
     public function invalidTldProvider(): iterable
     {