Merge pull request #308 from jeremykendall/develop

Prepare 6.0.0 release

Author: nyamsprod

.editorconfig

@@ -10,3 +10,9 @@ trim_trailing_whitespace = true
 
 [*.md]
 trim_trailing_whitespace = false
+
+[*.neon]
+indent_size = 2
+
+[*.xml.dist]
+indent_size = 2

.gitattributes

@@ -5,9 +5,9 @@
 /.github             export-ignore
 /.gitignore          export-ignore
 /.php_cs             export-ignore
-/.phpstan.src.neon   export-ignore
-/.phpstan.tests.neon export-ignore
+/phpstan.neon       export-ignore
 /.travis.yml         export-ignore
 /README.md           export-ignore
 /phpunit.xml.dist    export-ignore
-/tests               export-ignore
+/CHANGELOG.md        export-ignore
+/**/*Test.php        export-ignore

.github/CONTRIBUTING.md

@@ -10,7 +10,7 @@ We accept bug reports via issues created on [Github](https://github.com/jeremyke
 
 - **Always search the issue or pull request list first** - The odds are good that if you've found a problem, someone else has found it, too.
 
-- **Always try the [developer branch](https://github.com/jeremykendall/php-domain-parser/tree/develop)** - to see if the reported bug has not already been fixed.
+- **Always try the [master branch](https://github.com/jeremykendall/php-domain-parser/tree/master)** - to see if the reported bug has not already been fixed.
 
 ### When submitting your report
 
@@ -24,7 +24,7 @@ We accept bug reports via issues created on [Github](https://github.com/jeremyke
 
 We accept contributions via Pull Requests on [Github](https://github.com/jeremykendall/php-domain-parser/pull).
 
-- **Always make your Pull Request against the [developer branch](https://github.com/jeremykendall/php-domain-parser/tree/develop)** 
+- **Always make your Pull Request against the [master branch](https://github.com/jeremykendall/php-domain-parser/tree/master)** 
 
 - **[PSR-2 Coding Standard](http://www.php-fig.org/psr/psr-2/)** - Your patch won't be accepted if it doesn't pass the package coding style test suite.
 

.github/workflows/build.yaml

@@ -0,0 +1,30 @@
+---
+name: Build
+on:
+    push: ~
+    pull_request: ~
+
+jobs:
+    phpunit:
+        name: PHPUnit tests on ${{ matrix.php }} ${{ matrix.composer-flags }}
+        runs-on: ubuntu-latest
+        strategy:
+            matrix:
+                php: [ '7.4', '8.0' ]
+                composer-flags: [ '' ]
+                phpunit-flags: [ '--coverage-text' ]
+        steps:
+            - uses: actions/checkout@v2
+            - uses: shivammathur/setup-php@v2
+              with:
+                  php-version: ${{ matrix.php }}
+                  coverage: pcov
+                  tools: composer:v2
+            - run: composer update --no-progress ${{ matrix.composer-flags }}
+            - run: composer phpunit
+            - run: composer phpstan
+              if: ${{ matrix.php == '7.4' }}
+            - run: composer psalm
+              if: ${{ matrix.php == '7.4' }}
+            - run: composer phpcs
+              if: ${{ matrix.php == '7.4' }}

.gitignore

@@ -1,10 +1,8 @@
-tags
-composer.lock
+data
 vendor
-*.swp
 docs
-*~
 build
 .idea
 .php_cs.cache
 .phpunit.result.cache
+composer.lock

.php_cs

@@ -1,41 +1,22 @@
 <?php
 
-$header = <<<EOF
-PHP Domain Parser: Public Suffix List based URL parsing.
-
-@see http://github.com/jeremykendall/php-domain-parser for the canonical source repository
-
-@copyright Copyright (c) 2017 Jeremy Kendall (http://jeremykendall.net)
-
-For the full copyright and license information, please view the LICENSE
-file that was distributed with this source code.
-EOF;
-
 $finder = PhpCsFixer\Finder::create()
-    ->in(__DIR__.'/bin')
     ->in(__DIR__.'/src')
-    ->in(__DIR__.'/tests')
 ;
 
 return PhpCsFixer\Config::create()
     ->setRules([
         '@PSR2' => true,
         'array_syntax' => ['syntax' => 'short'],
         'concat_space' => ['spacing' => 'none'],
-        'header_comment' => [
-            'commentType' => 'PHPDoc',
-            'header' => $header,
-            'location' => 'after_open',
-            'separate' => 'both',
-        ],
         '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_trailing_comma_in_singleline_array' => true,
-        'no_trailing_whitespace' => true,
-        'no_whitespace_in_blank_line' => true,
+        'no_superfluous_phpdoc_tags' => true,
         'no_unused_imports' => true,
         'ordered_imports' => ['imports_order' => ['class', 'function', 'const'], 'sort_algorithm' => 'alpha'],
         'phpdoc_add_missing_param_annotation' => ['only_untyped' => false],
@@ -45,6 +26,7 @@ return PhpCsFixer\Config::create()
         'phpdoc_scalar' => true,
         'phpdoc_to_comment' => true,
         'phpdoc_summary' => true,
+        'psr0' => true,
         'psr4' => true,
         'return_type_declaration' => ['space_before' => 'none'],
         'single_blank_line_before_namespace' => true,
@@ -54,6 +36,7 @@ return PhpCsFixer\Config::create()
         'trailing_comma_in_multiline_array' => true,
         'trim_array_spaces' => true,
         'whitespace_after_comma_in_array' => true,
+        'yoda_style' => true,
     ])
     ->setFinder($finder)
 ;

.travis.yml

@@ -1,6 +1,57 @@
 # Changelog
 
-All Notable changes to `PHP Domain Parser` **5.x** series will be documented in this file
+All Notable changes to `PHP Domain Parser` starting from the **5.x** series will be documented in this file
+
+## 6.0.0 - 2020-12-13
+
+### Added
+
+- Adding proper Interfaces
+- Added `Domain::clear` to easily initialize an empty domain object
+- Added `Domain::slice` to easily slice a domain object
+- Added `ResolvedDomain` object to normalize Resolver results.
+- Added `Suffix` object to replace the `PublicSuffix` object from v5.
+- Public Suffix List and IANA Top Level Domain List are fully decoupled
+- Added `Idna`, IDN support has been completely revamped
+- Added internal `Stream` class, to improve path/stream resolution
+- Resolver uses by default UTS#46 IDNA2008 algorithm to convert domain names
+- Storage capability is now optional and can be based on PHP-FIG related interfaces to improve interoperability
+- `Pdp\TopLevelDomains::getIANADomain` which throws on syntax error and if no effective TLD is found (behave like `Pdp\TopLevelDomains::resolve` in v5).
+
+### Fixed
+
+- The `Pdp\Domain` class not longer directly exposes Effective TLD status.
+- Effective TLD resolver (`Pdp\Rules::resolve` and `Pdp\TopLevelDomains::resolve`) no longer accept IDNA options.
+- `Rules::getICANNDomain`, `Rules::getPrivateDomain` will throw even if a `PublicSuffix` is found but does not belong to the correct PSL section.
+- `Pdp\TopLevelDomains::resolve` acts like `Pdp\Rules::resolve` and only throw on `TypeError`
+
+### Deprecated
+
+- None
+
+### Removed
+
+- `__toString` and `__debugInfo` usage
+- Support for PHP7.4-
+- Composer script for automatic updates of the remote databases
+- CLI command `bin/update-psl`
+- `Pdp\Cache`, `Pdp\CacheException`: The package PSR-16 Cache implementation using the underlying filesystem.
+- `Pdp\HttpClient`, `Pdp\CurlHttpClient` and `Pdp\HttpClientException`: The package Http Client.
+- `Pdp\Installer`, `Pdp\Manager`: The package source manager and installer
+- `Pdp\Logger`, The package logger implementation
+- `Pdp\Rules::ALL_DOMAINS` constant deprecated in version 5.3
+- `Pdp\Domain::getDomain` deprecated in version 5.3
+- `Pdp\Domain::resolve`
+- `Pdp\Domain::getPublicSuffix` replaced by `Pdp\ResolvedDomain::suffix`
+- `Pdp\Domain::getRegistrableDomain` replaced by `Pdp\ResolvedDomain::registrableDomain`
+- `Pdp\Domain::getSubDomain` replaced by `Pdp\ResolvedDomain::subDomain`
+- `Pdp\Domain::withPublicSuffix` replaced by `Pdp\ResolvedDomain::withSuffix`
+- `Pdp\Domain::getLabel` replaced by `Pdp\Domain::label`
+- `Pdp\Domain::isTransitionalDifferent` replaced by `Pdp\IdnaInfo::isTransitionalDifferent`
+- `Pdp\PublicSuffix` replaced by `Pdp\Suffix`
+- Accessing suffix information from the `Pdp\Domain` object is no longer possible you need to do it from `Pdp\Suffix`
+- `Pdp\TopLevelDomains::contains` without replacement
+- Internal Converter classes (implementation details are no longer exposed).
 
 ## 5.7.2 - 2020-10-25
 
@@ -16,7 +67,7 @@ All Notable changes to `PHP Domain Parser` **5.x** series will be documented in
 
 - None
 
-### Removed
+### Remove
 
 - None
 

CHANGELOG.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (C) 2013-2019 Jeremy Kendall, http://about.me/jeremykendall
+Copyright (C) 2013 Jeremy Kendall, http://about.me/jeremykendall
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in