Merge pull request #250 from jeremykendall/feature/poc-new-installer

#249 improving the update-psl script

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

@@ -42,7 +42,7 @@ matrix:
       env:
         - COLLECT_COVERAGE=false
         - IGNORE_PLATFORMS=true
-        - RUN_PHPSTAN=true
+        - RUN_PHPSTAN=false
         - VALIDATE_CODING_STYLE=false
   allow_failures:
     - php: 7.4snapshot
@@ -66,4 +66,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

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"

data/pdp-PSL_FULL_5a3cc7f81795bb2e48e848af42d287b4.cache

@@ -21,7 +21,6 @@
         <whitelist>
             <directory suffix=".php">src</directory>
             <exclude>
-                <directory suffix="Installer.php">src</directory>
                 <directory suffix="include.php">src</directory>
             </exclude>
             <exclude>src/Installer</exclude>