Merge branch 'depth-first-imports'

Author: lkrms

.git-blame-ignore-revs

@@ -9,3 +9,5 @@ c81cea1c82fb2b4c049939d0b4344ebbc29387f1
 2c5640274a5e1f161dbe504c7d26989251400d26
 # Update formatting
 66d9a27e1c57650dc0166e42611b648c8af5e09d
+# Adopt depth-first sort order for imports
+331128cdc554df67264373f63c04611c563e53be

.github/workflows/ci.yml

@@ -27,7 +27,7 @@ jobs:
           coverage: none
 
       - name: Install PrettyPHP
-        run: composer create-project --no-interaction --no-progress --no-dev lkrms/pretty-php=0.4.18 build/pretty-php
+        run: composer create-project --no-interaction --no-progress --no-dev lkrms/pretty-php=0.4.22 build/pretty-php
 
       - name: Run PrettyPHP
         run: build/pretty-php/bin/pretty-php --diff

lib/lk-util/Command/Concept/Command.php

@@ -2,8 +2,8 @@
 
 namespace Lkrms\LkUtil\Command\Concept;
 
-use Lkrms\Cli\CliCommand;
 use Lkrms\Cli\Exception\CliInvalidArgumentsException;
+use Lkrms\Cli\CliCommand;
 use Lkrms\Contract\IProvider;
 use Lkrms\Facade\File;
 use Lkrms\LkUtil\Catalog\EnvVar;

lib/lk-util/Command/Generate/Concept/GenerateCommand.php

@@ -3,20 +3,20 @@
 namespace Lkrms\LkUtil\Command\Generate\Concept;
 
 use Lkrms\Cli\Catalog\CliOptionType;
+use Lkrms\Cli\Exception\CliInvalidArgumentsException;
 use Lkrms\Cli\CliOption;
 use Lkrms\Cli\CliOptionBuilder;
-use Lkrms\Cli\Exception\CliInvalidArgumentsException;
 use Lkrms\Facade\Composer;
 use Lkrms\Facade\Console;
 use Lkrms\Facade\File;
 use Lkrms\Facade\Reflect;
 use Lkrms\LkUtil\Command\Concept\Command;
 use Lkrms\Support\Catalog\RegularExpression as Regex;
-use Lkrms\Support\IntrospectionClass;
-use Lkrms\Support\Introspector;
 use Lkrms\Support\PhpDoc\PhpDoc;
 use Lkrms\Support\PhpDoc\PhpDocTag;
 use Lkrms\Support\PhpDoc\PhpDocTemplateTag;
+use Lkrms\Support\IntrospectionClass;
+use Lkrms\Support\Introspector;
 use Lkrms\Support\TokenExtractor;
 use Lkrms\Utility\Convert;
 use Lkrms\Utility\Test;
@@ -445,16 +445,26 @@ protected function generate(
      */
     protected function generateImports(): array
     {
-        $imports = [];
+        $map = [];
         foreach ($this->ImportMap as $alias) {
             $import = $this->AliasMap[strtolower($alias)];
             if (!strcasecmp($alias, Convert::classToBasename($import))) {
-                $imports[] = sprintf('use %s;', $import);
+                $map[$import] = null;
                 continue;
             }
-            $imports[] = sprintf('use %s as %s;', $import, $alias);
+            $map[$import] = $alias;
+        }
+
+        // Sort by FQCN, depth-first
+        uksort($map, fn($a, $b) => $this->getSortableFqcn($a) <=> $this->getSortableFqcn($b));
+
+        $imports = [];
+        foreach ($map as $import => $alias) {
+            $imports[] =
+                $alias === null
+                    ? sprintf('use %s;', $import)
+                    : sprintf('use %s as %s;', $import, $alias);
         }
-        sort($imports);
 
         return $imports;
     }
@@ -596,4 +606,39 @@ private function generatePhpDocBlock($phpDoc): array
             ' */'
         ];
     }
+
+    /**
+     * Normalise a FQCN for depth-first sorting
+     *
+     * Before:
+     *
+     * ```
+     * A
+     * A\B\C
+     * A\B
+     * ```
+     *
+     * After:
+     *
+     * ```
+     * 1A
+     * 0A \ 0B \ 1C
+     * 0A \ 1B
+     * ```
+     */
+    private function getSortableFqcn(string $import): string
+    {
+        $names = explode('\\', $import);
+        $import = '';
+        $prefix = 0;
+        do {
+            $name = array_shift($names);
+            if (!$names) {
+                $prefix = 1;
+            }
+            $import .= ($import === '' ? '' : ' \ ') . "$prefix$name";
+        } while (!$prefix);
+
+        return $import;
+    }
 }

lib/lk-util/Command/Generate/GenerateBuilder.php

@@ -2,19 +2,19 @@
 
 namespace Lkrms\LkUtil\Command\Generate;
 
-use Closure;
 use Lkrms\Cli\Catalog\CliOptionType;
 use Lkrms\Cli\CliOption;
 use Lkrms\Concept\Builder;
 use Lkrms\Contract\IContainer;
 use Lkrms\Facade\Reflect;
 use Lkrms\LkUtil\Catalog\EnvVar;
 use Lkrms\LkUtil\Command\Generate\Concept\GenerateCommand;
-use Lkrms\Support\Introspector;
 use Lkrms\Support\PhpDoc\PhpDoc;
 use Lkrms\Support\PhpDoc\PhpDocTemplateTag;
+use Lkrms\Support\Introspector;
 use Lkrms\Utility\Convert;
 use Lkrms\Utility\Test;
+use Closure;
 use ReflectionParameter;
 use ReflectionProperty;
 

lib/lk-util/Command/Generate/GenerateFacade.php

@@ -30,7 +30,6 @@ final class GenerateFacade extends GenerateCommand
         'getReadable',
         'getWritable',
         'setFacade',
-
         // These are displaced by Facade
         'isLoaded',
         'load',

lib/lk-util/Command/Generate/GenerateSyncEntity.php

@@ -2,16 +2,16 @@
 
 namespace Lkrms\LkUtil\Command\Generate;
 
-use DateTimeImmutable;
 use Lkrms\Cli\Catalog\CliOptionType;
-use Lkrms\Cli\CliOption;
 use Lkrms\Cli\Exception\CliInvalidArgumentsException;
+use Lkrms\Cli\CliOption;
 use Lkrms\LkUtil\Command\Generate\Concept\GenerateCommand;
 use Lkrms\Support\Catalog\HttpRequestMethod;
 use Lkrms\Sync\Concept\HttpSyncProvider;
 use Lkrms\Sync\Concept\SyncEntity;
 use Lkrms\Utility\Convert;
 use Lkrms\Utility\Test;
+use DateTimeImmutable;
 use RuntimeException;
 
 /**

lib/lk-util/Command/Generate/GenerateSyncProvider.php

@@ -3,8 +3,8 @@
 namespace Lkrms\LkUtil\Command\Generate;
 
 use Lkrms\Cli\Catalog\CliOptionType;
-use Lkrms\Cli\CliOption;
 use Lkrms\Cli\Exception\CliInvalidArgumentsException;
+use Lkrms\Cli\CliOption;
 use Lkrms\Facade\Sync;
 use Lkrms\LkUtil\Catalog\EnvVar;
 use Lkrms\LkUtil\Command\Generate\Concept\GenerateCommand;

src/Auth/AccessToken.php

@@ -2,11 +2,11 @@
 
 namespace Lkrms\Auth;
 
-use DateTimeImmutable;
-use DateTimeInterface;
 use Lkrms\Concern\TFullyReadable;
 use Lkrms\Contract\IReadable;
 use Lkrms\Utility\Convert;
+use DateTimeImmutable;
+use DateTimeInterface;
 
 /**
  * An immutable access token

src/Cli/CliApplication.php

@@ -3,9 +3,9 @@
 namespace Lkrms\Cli;
 
 use Lkrms\Cli\Catalog\CliHelpSectionName;
-use Lkrms\Cli\CliCommand;
 use Lkrms\Cli\Contract\ICliApplication;
 use Lkrms\Cli\Exception\CliInvalidArgumentsException;
+use Lkrms\Cli\CliCommand;
 use Lkrms\Console\ConsoleFormatter as Formatter;
 use Lkrms\Container\Application;
 use Lkrms\Facade\Assert;