Merge pull request #255 from jeremykendall/develop

5.6.0 release

Author: nyamsprod

.php_cs

@@ -12,6 +12,7 @@ file that was distributed with this source code.
 EOF;
 
 $finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__.'/bin')
     ->in(__DIR__.'/src')
     ->in(__DIR__.'/tests')
 ;
@@ -55,4 +56,4 @@ return PhpCsFixer\Config::create()
         'whitespace_after_comma_in_array' => true,
     ])
     ->setFinder($finder)
-;
+;

.travis.yml

@@ -32,7 +32,7 @@ matrix:
         - VALIDATE_CODING_STYLE=false
         - RUN_PHPSTAN=false
         - IGNORE_PLATFORMS=true
-    - php: 7.4snapshot
+    - php: 7.4
       env:
         - COLLECT_COVERAGE=false
         - VALIDATE_CODING_STYLE=false
@@ -42,17 +42,12 @@ matrix:
       env:
         - COLLECT_COVERAGE=false
         - IGNORE_PLATFORMS=true
-        - RUN_PHPSTAN=true
+        - RUN_PHPSTAN=false
         - VALIDATE_CODING_STYLE=false
   allow_failures:
-    - php: 7.4snapshot
     - php: nightly
   fast_finish: true
 
-cache:
-  directories:
-    - $HOME/.composer/cache
-
 before_install:
   - travis_retry composer self-update
 
@@ -66,4 +61,4 @@ script:
   - composer phpunit
 
 after_script:
-  - if [ "$COLLECT_COVERAGE" == "true" ]; then wget https://scrutinizer-ci.com/ocular.phar && php ocular.phar code-coverage:upload --format=php-clover build/clover.xml; fi
+  - if [ "$COLLECT_COVERAGE" == "true" ]; then wget https://scrutinizer-ci.com/ocular.phar && php ocular.phar code-coverage:upload --format=php-clover build/clover.xml; fi

CHANGELOG.md

@@ -2,7 +2,26 @@
 
 All Notable changes to `PHP Domain Parser` **5.x** series will be documented in this file
 
-# 5.5.0 - 2019-04-14
+## 5.6.0 - 2019-12-29
+
+### Added
+
+- A simple `Psr3` compatible logger class which output the logs to you cli console.
+
+### Fixed
+
+- `composer.json` updated to be composer 2.0 ready
+- package bundle installer is rewritten to improve its usage see [#249](https://github.com/jeremykendall/php-domain-parser/issues/249) and [#250](https://github.com/jeremykendall/php-domain-parser/issues/250)
+
+### Deprecated
+
+- None
+
+### Removed
+
+- None
+
+## 5.5.0 - 2019-04-14
 
 ### Added
 
@@ -25,7 +44,7 @@ All Notable changes to `PHP Domain Parser` **5.x** series will be documented in
 
 - None
 
-# 5.4.0 - 2018-11-22
+## 5.4.0 - 2018-11-22
 
 ### Added
 
@@ -161,4 +180,4 @@ All Notable changes to `PHP Domain Parser` **5.x** series will be documented in
 - `Pdp\PublicSuffixList` class replaced by the `Pdp\Rules` class
 - `Pdp\PublicSuffixManager` class replaced by the `Pdp\Manager` class
 - `Pdp\HttpAdapter\HttpAdapterInterface` interface replaced by the `Pdp\HttpClient` interface
-- `Pdp\HttpAdapter\CurlHttpAdapter` class replaced by the `Pdp\CurlHttpClient` class
+- `Pdp\HttpAdapter\CurlHttpAdapter` class replaced by the `Pdp\CurlHttpClient` class

LICENSE

@@ -1,4 +1,6 @@
-Copyright (C) 2013-2014 Jeremy Kendall, http://about.me/jeremykendall
+The MIT License (MIT)
+
+Copyright (C) 2013-2019 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

README.md

@@ -34,6 +34,7 @@ Dependencies
 -------
 
 - [PSR-16](http://www.php-fig.org/psr/psr-16/)
+- [PSR-3](http://www.php-fig.org/psr/psr-3/) *since version 5.6*
 
 Installation
 --------
@@ -555,8 +556,9 @@ This script requires:
 - The PHP `curl` extension
 - The `Pdp\Installer` class which organizes how to update the cache.
 - The `Pdp\Cache` and `Pdp\CurlHttpClient` classes to retrieve and cache the PSL
+- A `Psr3` implementation.
 
-You can also add a composer script in your `composer.json` file to update the PSL cache everytime after the `install` or the `update` command are executed.
+You can add a composer script in your `composer.json` file to update the PSL cache every time after the `install` or the `update` command are executed.
 
 ~~~bash
 {
@@ -567,12 +569,36 @@ You can also add a composer script in your `composer.json` file to update the PS
 }
 ~~~
 
-If you prefer using your own implementations you should:
+#### Advanced usage of the update-psl script
 
-1. Copy the `Pdp\Installer` class
-2. Adapt its code to reflect your requirements.
+**since version 5.6.0**
 
-In any case, your are required to update regularly your PSL information with your chosen script to keep your data up to date.
+The following command is accessible to the end user:
+
+```bash
+$ php bin/update-psl --rzd --rzd-url=http://localhost/rzd-mirror/list.txt --ttl="8 HOURS" --cache-dir="/tmp"
+````
+
+This lines means:
+
+- the only cache that will be updated will be the one for the Root Zone Domains;
+- it will be updated using the submitted URL;
+- the data will be cached for 8 hours;
+- the cache directory will be the `/tmp` directory.;
+
+##### Options and arguments
+
+- `--cache-dir` : specify the root directory used to save the cached data;
+- `h`, `--h`, `--help` : display the helper message;
+- `--psl`: specify that the PSL cache must be updated;
+- `--psl-url`: specify that PSL source URL;
+- `--rzd`: specify that the RZD  cache must be updated;
+- `--rzd-url`: specify that RZD source URL;
+- `--ttl`: specify the cache TTL;
+
+#### Alternatives to the update-psl script
+
+**Using the `update-psl` script is not a requirement but your MUST update regularly your PSL information to keep your cache data up to date.**
 
 For example, below I'm using the `Manager` with
 
@@ -717,4 +743,4 @@ the Apache Software Foundation License 2.0 in this project.
 [link-release]: https://github.com/jeremykendall/php-domain-parser/releases
 [link-license]: https://github.com/jeremykendall/php-domain-parser/blob/master/LICENSE
 
-[link-parse-library]: https://packagist.org/explore/?query=rfc3986
+[link-parse-library]: https://packagist.org/explore/?query=rfc3986

bin/update-psl

@@ -1,6 +1,135 @@
 #!/usr/bin/env php
 <?php
 
-require dirname(__DIR__).'/src/Installer.php';
+/**
+ * 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.
+ */
 
-Pdp\Installer::updateLocalCache();
+declare(strict_types=1);
+
+use Pdp\Logger;
+use Pdp\Installer;
+use Pdp\Manager;
+
+require dirname(__DIR__).'/vendor/autoload.php';
+
+function writeln(array $messages, $output): int
+{
+    $message = implode(PHP_EOL, $messages). PHP_EOL;
+
+    return fwrite($output, $message);
+}
+
+function success(string $message, $output = STDOUT): int
+{
+    $messages = (array) $message;
+
+    return writeln($messages, $output);
+}
+
+function fail(string $message, $output = STDERR): int
+{
+    $messages = (array) $message;
+
+    return writeln($messages, $output);
+}
+
+/**
+ * CLI colors
+ */
+$cyan = chr(27)."[36m";
+$green = chr(27)."[32m";
+$reset = chr(27)."[0m";
+$redbg = chr(27)."[41m";
+$yellow = chr(27)."[33m";
+
+$arguments = array_replace([
+    Installer::CACHE_DIR_KEY => '',
+    Installer::REFRESH_PSL_KEY => false,
+    Installer::REFRESH_RZD_KEY => false,
+    Installer::TTL_KEY => '1 DAY',
+], getopt('h::', [
+    'h',
+    'help',
+    Installer::CACHE_DIR_KEY.':',
+    Installer::REFRESH_PSL_KEY,
+    Installer::REFRESH_PSL_URL_KEY.':',
+    Installer::REFRESH_RZD_KEY,
+    Installer::REFRESH_RZD_URL_KEY.':',
+    Installer::TTL_KEY.':',
+]));
+
+if (isset($arguments['help']) || isset($arguments['h'])) {
+    $default_cache_dir = dirname(__DIR__).'/data';
+    $script = basename(__FILE__);
+    $helpText = <<<HELP
+{$yellow}Usage:$reset
+    $script [options]
+    
+{$yellow}Options:$reset
+    $green    --%s$reset                 refreshes the Public Suffix List cache
+    $green    --%s=URL$reset         set the URL to use to refresh the PSL cache ({$yellow}default:$reset %s)
+    $green    --%s$reset                 refreshes the IANA Root Zone Database cache
+    $green    --%s=URL$reset         set the URL to use to refresh the RZD cache ({$yellow}default:$reset %s)
+    $green    --%s=TTL$reset             set the TTL for the cache ({$yellow}default:$reset '1 DAY')
+    $green    --%s=CACHE-DIR$reset set the cache root directory ({$yellow}default:$reset $default_cache_dir')
+    $green-h, --help$reset                show the following help message
+
+{$yellow}Help:$reset
+    The {$green}update-psl$reset command updates your PDP local cache.
+    
+{$yellow}Examples:$reset
+
+     Refresh all caches using the default settings
+     $green$script$reset
+     
+     Refresh only the PSL cache for a TTL of 3 DAY 
+     $green$script --psl --ttl="3 DAYS"$reset
+     
+     Refresh all caches using another cache directory
+     $green$script --cache-dir=/temp$reset
+
+     Read more at https://github.com/jeremykendall/php-domain-parser/
+
+HELP;
+
+    $helpText = sprintf($helpText,
+        Installer::REFRESH_PSL_KEY,
+        Installer::REFRESH_PSL_URL_KEY,
+        Manager::PSL_URL,
+        Installer::REFRESH_RZD_KEY,
+        Installer::REFRESH_RZD_URL_KEY,
+        Manager::RZD_URL,
+        Installer::TTL_KEY,
+        Installer::CACHE_DIR_KEY
+    );
+
+    success($helpText);
+
+    die(0);
+}
+
+if (!extension_loaded('curl')) {
+    fail("$redbg The required PHP cURL extension is missing. $reset");
+
+    die(1);
+}
+
+$installer = Installer::createFromCacheDir(new Logger( STDOUT, STDERR), $arguments[Installer::CACHE_DIR_KEY]);
+success("$yellow Updating your Pdp local cache.$reset");
+if ($installer->refresh($arguments)) {
+    success("$green Pdp local cache successfully updated. $reset");
+
+    die(0);
+}
+
+fail("$redbg The command failed to update Pdp local cache successfully. $reset");
+
+die(1);

composer.json

@@ -36,12 +36,13 @@
     "require": {
         "php": ">=7.0",
         "ext-intl": "*",
+        "psr/log": "^1.1",
         "psr/simple-cache": "^1.0.1"
     },
     "require-dev": {
         "composer/composer": "^1.6",
         "friendsofphp/php-cs-fixer": "^2.7",
-        "mikey179/vfsStream": "^1.6",
+        "mikey179/vfsstream": "^1.6",
         "phpstan/phpstan": "^0.9.2",
         "phpstan/phpstan-phpunit": "^0.9.4",
         "phpstan/phpstan-strict-rules": "^0.9.0",
@@ -63,9 +64,9 @@
         }
     },
     "scripts": {
-        "phpcs": "php-cs-fixer fix -vv --diff --dry-run --allow-risky=yes",
-        "phpstan-src": "phpstan analyse -l max -c phpstan.src.neon src",
-        "phpstan-tests": "phpstan analyse -l max -c phpstan.tests.neon tests",
+        "phpcs": "php-cs-fixer fix -vvv --diff --dry-run --allow-risky=yes --ansi",
+        "phpstan-src": "phpstan analyse -l max -c phpstan.src.neon src --ansi",
+        "phpstan-tests": "phpstan analyse -l max -c phpstan.tests.neon tests --ansi",
         "phpstan": [
             "@phpstan-src",
             "@phpstan-tests"
@@ -79,6 +80,14 @@
             "@phpunit"
         ]
     },
+    "scripts-descriptions": {
+        "phpcs": "Runs coding style test suite",
+        "phpstan": "Runs complete codebase static analysis",
+        "phpstan-src": "Runs PHP stan on the source code",
+        "phpstan-test": "Runs PHP stan on the test suite",
+        "phpunit": "Runs unit and functional testing",
+        "test": "Runs the complete test suite"
+    },
     "extra": {
         "branch-alias": {
             "dev-master": "5.x-dev"