New static parse method, bugfix and code quality

New feature:
- Add static method to create PSR-7 Uri object: Url::parsePsr7().

Bugfix:
- Fix error when resolving something to a url with an empty path.

Code quality:
- Update php cs fixer to ^v3.4.
- Add phpstan at level 6.
- Add `composer cs-fix` command that automatically fixes code style.
- Improve pre-commit hook and add running phpstan.

.gitattributes

@@ -1,7 +1,7 @@
 .editorconfig export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
-.php_cs.dist export-ignore
+.php-cs-fixer.php export-ignore
 phpunit.xml export-ignore
 tests export-ignore
 git-hooks export-ignore

.github/workflows/ci.yml

@@ -49,3 +49,25 @@ jobs:
 
       - name: Run tests
         run: composer test
+
+  stan:
+    name: PHPStan
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.2'
+
+      - name: Check PHP Version
+        run: php -v
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress --no-suggest
+
+      - name: Run PHPStan
+        run: composer stan

.gitignore

@@ -1,6 +1,7 @@
 composer.lock
 vendor
 .php_cs.cache
+.php-cs-fixer.cache
 .phpunit.result.cache
 data/public_suffix_list.dat
 data/uri-schemes.csv

.php_cs.dist → .php-cs-fixer.php

@@ -1,13 +1,17 @@
 <?php
 
-$finder = PhpCsFixer\Finder::create()
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+
+$finder = Finder::create()
     ->in([__DIR__ . '/src', __DIR__ . '/tests', __DIR__ . '/bin']);
+$config = new Config();
 
-return PhpCsFixer\Config::create()
+return $config->setFinder($finder)
     ->setRules([
         '@PSR2' => true,
         'strict_param' => true,
-        'array_syntax' => ['syntax' => 'short'],
         'single_class_element_per_statement' => false,
     ])
-    ->setFinder($finder);
+    ->setRiskyAllowed(true)
+    ->setUsingCache(true);

CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.0] - 2021-01-10
+### Added
+- Static method to create PSR-7 Uri object
+  (`Url::parsePsr7('https://...')`).
+
+### Fixed
+- Error when resolving something to a url with an empty path.
+
 ## [1.0.2] - 2022-01-05
 ### Changed
 - Run tests also on PHP 8.1 in CI.

README.md

@@ -384,10 +384,8 @@ instance of the `Url` class in a private property and thus assures immutability.
 #### Usage Example
 
 ```php
-use Crwlr\Url\Psr\Uri;
-
 $url = 'https://user:password@www.example.com:1234/foo/bar?some=query#fragment';
-$uri = new Uri($url);
+$uri = Url::parsePsr7($url); // Or instead: new Crwlr\Url\Psr\Uri($url);
 
 var_dump($uri->getScheme());        // => 'https'
 var_dump($uri->getAuthority());     // => 'user:password@www.example.com:1234'

composer.json

@@ -37,7 +37,8 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^8.0",
-        "friendsofphp/php-cs-fixer": "^2.15"
+        "friendsofphp/php-cs-fixer": "^3.4",
+        "phpstan/phpstan": "^1.3"
     },
     "autoload": {
         "psr-4": {
@@ -46,7 +47,9 @@
     },
     "scripts": {
         "test": "@php vendor/bin/phpunit",
-        "cs": "PHP_CS_FIXER_IGNORE_ENV=1 php vendor/bin/php-cs-fixer fix -v --diff --dry-run --allow-risky=yes",
+        "cs": "@php vendor/bin/php-cs-fixer fix -v --dry-run",
+        "cs-fix": "@php vendor/bin/php-cs-fixer fix -v",
+        "stan": "@php vendor/bin/phpstan analyse -c phpstan.neon",
         "update-suffixes": "@php bin/update-suffixes",
         "update-schemes": "@php bin/update-schemes",
         "update-default-ports": "@php bin/update-default-ports",

git-hooks/pre-commit

@@ -1,24 +1,80 @@
 #!/usr/bin/env php
 <?php
 
-function handleFail($output, $returnCode) {
+run('composer test', 'Unit tests');
+run('composer cs', 'PHP Coding Standards Fixer');
+run('composer stan', 'PHPStan');
+exit(0);
+
+function run(string $command, ?string $descriptiveName = null)
+{
+    printLine(blue('RUN ' . ($descriptiveName ?? $command) . '...'));
+    exec($command, $output, $returnCode);
+    handleFail($output, $returnCode);
+    showSummary($output);
+}
+
+function handleFail($output, $returnCode)
+{
     if ($returnCode !== 0) {
-        // Show full output
-        echo PHP_EOL . implode($output, PHP_EOL) . PHP_EOL;
-        echo "Aborting commit.." . PHP_EOL;
+        printLine(red('Failed:'));
+        printLines($output);
+        printLine(red('Aborting commit...'));
         exit(1);
     }
 }
 
-echo "Running tests.. ";
-exec('composer test', $output, $returnCode);
-handleFail($output, $returnCode);
+function showSummary(array $output)
+{
+    printBlankLine();
+    printLine(green('Summary:'));
+    outputLastNotEmptyLine($output);
+    printBlankLine();
+}
 
-echo "Running php-cs-fixer.. ";
-exec('composer cs', $output, $returnCode);
-handleFail($output, $returnCode);
+function outputLastNotEmptyLine(array $output)
+{
+    while (count($output) > 0) {
+        $lastLine = array_pop($output);
 
-// Show summary (last line)
-echo array_pop($output) . PHP_EOL;
+        if (trim($lastLine) !== '') {
+            printLine($lastLine);
+            return;
+        }
+    }
+}
 
-exit(0);
+function printLine(string $string)
+{
+    echo $string . PHP_EOL;
+}
+
+function printLines(array $lines)
+{
+    echo implode(PHP_EOL, $lines) . PHP_EOL;
+}
+
+function printBlankLine()
+{
+    printLine('');
+}
+
+function red(string $string): string
+{
+    return color('0;31', $string);
+}
+
+function green(string $string): string
+{
+    return color('0;32', $string);
+}
+
+function blue(string $string): string
+{
+    return color('0;34', $string);
+}
+
+function color(string $colorCode, string $string): string
+{
+    return "\e[" . $colorCode . "m" . $string . "\e[0m";
+}

phpstan.neon

@@ -0,0 +1,6 @@
+parameters:
+    level: 6
+    paths:
+        - src
+        - tests
+    treatPhpDocTypesAsCertain: false

src/DefaultPorts.php

@@ -14,6 +14,9 @@ class DefaultPorts extends Store
 {
     protected $storeFilename = 'default-ports.php';
 
+    /**
+     * @var int[]
+     */
     protected $fallbackList = [
         'ftp' => 21,
         'git' => 9418,

src/DefaultPorts/Updater.php

@@ -18,13 +18,17 @@ class Updater extends \Crwlr\Url\Lists\Updater
     protected $storeValuesAsKeys = false;
 
     /**
-     * @return mixed
+     * @return int[]
      */
-    protected function getOriginalContent()
+    protected function getOriginalContent(): array
     {
         return include(dirname(__DIR__) . '/../data/schemes.php');
     }
 
+    /**
+     * @param int[] $content
+     * @return int[]
+     */
     protected function parseContent($content = []): array
     {
         $defaultPorts = [];

src/Exceptions/ListStoreException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace Crwlr\Url\Exceptions;
+
+use Exception;
+
+class ListStoreException extends Exception
+{
+}

src/Helpers.php

@@ -76,7 +76,7 @@ public static function defaultPorts(): DefaultPorts
      *
      * It doesn't do any validation and assumes the provided component values are valid!
      *
-     * @param array $components
+     * @param array|(int|string)[] $components
      * @return string
      */
     public static function buildUrlFromComponents(array $components): string
@@ -108,7 +108,7 @@ public static function buildUrlFromComponents(array $components): string
      *
      * It doesn't do any validation and assumes the provided component values are valid!
      *
-     * @param array $components
+     * @param array|(int|string)[] $components
      * @return string
      */
     public static function buildAuthorityFromComponents(array $components): string
@@ -137,7 +137,7 @@ public static function buildAuthorityFromComponents(array $components): string
      *
      * It doesn't do any validation and assumes the provided component values are valid!
      *
-     * @param array $components
+     * @param array|(int|string)[] $components
      * @return string
      */
     public static function buildUserInfoFromComponents(array $components): string
@@ -161,7 +161,7 @@ public static function buildUserInfoFromComponents(array $components): string
      * Converts a url query string to array.
      *
      * @param string $query
-     * @return array
+     * @return string[]
      */
     public static function queryStringToArray(string $query = ''): array
     {
@@ -200,13 +200,13 @@ public static function getStandardPortByScheme(string $scheme): ?int
         $standardPortTcp = getservbyname($scheme, 'tcp');
 
         if ($standardPortTcp) {
-            return (int) $standardPortTcp;
+            return $standardPortTcp;
         }
 
         $standardPortUdp = getservbyname($scheme, 'udp');
 
         if ($standardPortUdp) {
-            return (int) $standardPortUdp;
+            return $standardPortUdp;
         }
 
         return null;
@@ -304,6 +304,10 @@ public static function startsWith(string $string, string $startsWith, ?int $leng
      */
     public static function containsXBeforeFirstY(string $string, string $x, string $y): bool
     {
+        if ($y === '') {
+            return strpos($string, $x) !== false;
+        }
+
         $untilFirstY = explode($y, $string)[0];
 
         return strpos($untilFirstY, $x) !== false;
@@ -320,7 +324,9 @@ public static function containsXBeforeFirstY(string $string, string $x, string $
      */
     public static function idn_to_ascii(string $string): string
     {
-        return idn_to_ascii($string, IDNA_NONTRANSITIONAL_TO_ASCII, INTL_IDNA_VARIANT_UTS46);
+        $converted = idn_to_ascii($string, IDNA_NONTRANSITIONAL_TO_ASCII, INTL_IDNA_VARIANT_UTS46);
+
+        return $converted !== false ? $converted : $string;
     }
 
     /**
@@ -334,7 +340,9 @@ public static function idn_to_ascii(string $string): string
      */
     public static function idn_to_utf8(string $string): string
     {
-        return idn_to_utf8($string, IDNA_NONTRANSITIONAL_TO_ASCII, INTL_IDNA_VARIANT_UTS46);
+        $converted = idn_to_utf8($string, IDNA_NONTRANSITIONAL_TO_ASCII, INTL_IDNA_VARIANT_UTS46);
+
+        return $converted !== false ? $converted : $string;
     }
 
     /**
@@ -344,8 +352,8 @@ public static function idn_to_utf8(string $string): string
      * method works around this issue so the requested query array returns the proper keys with dots.
      *
      * @param string $query
-     * @param array $array
-     * @return array
+     * @param string[] $array
+     * @return string[]
      */
     private static function replaceKeysContainingDots(string $query, array $array): array
     {
@@ -354,7 +362,7 @@ private static function replaceKeysContainingDots(string $query, array $array):
         $brokenKeys = $fixedArray = [];
 
         // Create mapping of broken keys to original proper keys.
-        foreach ($matches[1] as $key => $value) {
+        foreach ($matches[1] as $value) {
             if (strpos($value, '.') !== false) {
                 $brokenKeys[str_replace('.', '_', $value)] = $value;
             }

src/Host.php

@@ -22,7 +22,7 @@ class Host
     private $subdomain;
 
     /**
-     * @var Domain
+     * @var Domain|null
      */
     private $domain;
 
@@ -121,7 +121,7 @@ public function domainSuffix(?string $domainSuffix = null): ?string
      */
     public function hasIdn(): bool
     {
-        return $this->domain instanceof Domain ? $this->domain->isIdn() : false;
+        return $this->domain instanceof Domain && $this->domain->isIdn();
     }
 
     /**