Merge branch 'cleanup'

Author: lkrms

.vscode/php.code-snippets

@@ -0,0 +1,16 @@
+{
+	"Class file": {
+		"scope": "php",
+		"prefix": "<?php",
+		"body": [
+			"<?php declare(strict_types=1);",
+			"",
+			"namespace ${TM_DIRECTORY/^.*\\\\/src\\\\/(?:(Toolkit)|(Util))|^.*\\\\/(tests\\\\/(?:unit|fixtures|3rdparty)\\\\/(?:(Toolkit)|(Util)))|\\\\/([a-zA-Z0-9]+)/${1:+Salient}${4:+Salient}${2:+Lkrms}${5:+Lkrms}${3:+\\\\Tests}${6:+\\\\}$6/g};",
+			"",
+			"class ${TM_FILENAME_BASE/[^a-zA-Z0-9]+//g} {",
+			"    $0",
+			"}",
+			""
+		]
+	}
+}

composer.json

@@ -30,6 +30,7 @@
         "phpstan/extension-installer": "^1",
         "phpstan/phpstan": "^1",
         "phpstan/phpstan-deprecation-rules": "^1",
+        "phpstan/phpstan-phpunit": "^1",
         "phpunit/phpunit": "^9",
         "sebastian/diff": "^4 || ^5"
     },

lk-util/Command/Generate/GenerateSyncEntity.php

@@ -13,6 +13,8 @@
 use Lkrms\Support\Catalog\RelationshipType;
 use Lkrms\Sync\Concept\HttpSyncProvider;
 use Lkrms\Sync\Concept\SyncEntity;
+use Lkrms\Sync\Support\DeferredEntity;
+use Lkrms\Sync\Support\DeferredRelationship;
 use Lkrms\Utility\Arr;
 use Lkrms\Utility\Convert;
 use Lkrms\Utility\Inflect;
@@ -399,16 +401,38 @@ protected static function getRemovablePrefixes(): ?array
         }
 
         foreach ($parent as $key => $value) {
-            $properties[$key] = 'static|null';
+            $deferredEntity ??= $this->getFqcnAlias(DeferredEntity::class);
+            $properties[$key] = sprintf('static|%s<static>|null', $deferredEntity);
         }
         foreach ($children as $key => $value) {
-            $properties[$key] = 'static[]|null';
+            $deferredEntity ??= $this->getFqcnAlias(DeferredEntity::class);
+            $deferredRelationship ??= $this->getFqcnAlias(DeferredRelationship::class);
+            $properties[$key] = sprintf(
+                'array<static|%s<static>>|%s<static>|null',
+                $deferredEntity,
+                $deferredRelationship,
+            );
         }
         foreach ($oneToOne as $key => $value) {
-            $properties[$key] = "{$value}|null";
+            $deferredEntity ??= $this->getFqcnAlias(DeferredEntity::class);
+            $properties[$key] = sprintf(
+                '%s|%s<%s>|null',
+                $value,
+                $deferredEntity,
+                $value,
+            );
         }
         foreach ($oneToMany as $key => $value) {
-            $properties[$key] = "{$value}[]|null";
+            $deferredEntity ??= $this->getFqcnAlias(DeferredEntity::class);
+            $deferredRelationship ??= $this->getFqcnAlias(DeferredRelationship::class);
+            $properties[$key] = sprintf(
+                'array<%s|%s<%s>>|%s<%s>|null',
+                $value,
+                $deferredEntity,
+                $value,
+                $deferredRelationship,
+                $value,
+            );
         }
 
         $oneToOne += array_diff_key($tentativeOneToOne, $oneToMany, $parent, $children);

src/Util/Cli/CliApplication.php

@@ -48,11 +48,13 @@ class CliApplication extends Application implements CliApplicationInterface
     public function __construct(
         ?string $basePath = null,
         ?string $appName = null,
-        int $envFlags = EnvFlag::ALL
+        int $envFlags = EnvFlag::ALL,
+        ?string $configDir = 'config'
     ) {
-        parent::__construct($basePath, $appName, $envFlags);
+        parent::__construct($basePath, $appName, $envFlags, $configDir);
 
         Assert::runningOnCli();
+
         Assert::argvIsDeclared();
 
         // Keep running, even if:
@@ -424,6 +426,8 @@ public function run()
 
     /**
      * @inheritDoc
+     *
+     * @codeCoverageIgnore
      */
     public function exit()
     {
@@ -432,6 +436,8 @@ public function exit()
 
     /**
      * @inheritDoc
+     *
+     * @codeCoverageIgnore
      */
     public function runAndExit()
     {

src/Util/Cli/Contract/CliApplicationInterface.php

@@ -21,6 +21,8 @@ public function getProgramName(): string;
      * Get the command invoked by run()
      *
      * This method should only return a command that is currently running.
+     *
+     * @phpstan-impure
      */
     public function getRunningCommand(): ?CliCommandInterface;
 
@@ -29,13 +31,17 @@ public function getRunningCommand(): ?CliCommandInterface;
      *
      * This method should only return a command that ran to completion or failed
      * with an exception.
+     *
+     * @phpstan-impure
      */
     public function getLastCommand(): ?CliCommandInterface;
 
     /**
      * Get the return value most recently recorded by run()
      *
      * This method should return `0` if a return value has not been recorded.
+     *
+     * @phpstan-impure
      */
     public function getLastExitStatus(): int;
 

src/Util/Store/CacheStore.php

@@ -116,6 +116,8 @@ public function set(string $key, $value, $expires = null): self
      *
      * - its age in seconds is less than or equal to `$maxAge`, or
      * - `$maxAge` is `0`
+     *
+     * @phpstan-impure
      */
     public function has(string $key, ?int $maxAge = null): bool
     {
@@ -148,6 +150,8 @@ public function has(string $key, ?int $maxAge = null): bool
      * - `$maxAge` is `0`
      *
      * @return mixed|null `null` if the item has expired or doesn't exist.
+     *
+     * @phpstan-impure
      */
     public function get(string $key, ?int $maxAge = null)
     {
@@ -182,6 +186,8 @@ public function get(string $key, ?int $maxAge = null)
      * @return T|null `null` if the item has expired or doesn't exist.
      * @throws AssertionFailedException if the item stored under `$key` is not
      * an instance of `$class`.
+     *
+     * @phpstan-impure
      */
     public function getInstanceOf(string $key, string $class, ?int $maxAge = null): ?object
     {
@@ -200,6 +206,8 @@ public function getInstanceOf(string $key, string $class, ?int $maxAge = null):
      * @return mixed[]|null `null` if the item has expired or doesn't exist.
      * @throws AssertionFailedException if the item stored under `$key` is not
      * an array.
+     *
+     * @phpstan-impure
      */
     public function getArray(string $key, ?int $maxAge = null): ?array
     {
@@ -218,6 +226,8 @@ public function getArray(string $key, ?int $maxAge = null): ?array
      * @return int|null `null` if the item has expired or doesn't exist.
      * @throws AssertionFailedException if the item stored under `$key` is not
      * an integer.
+     *
+     * @phpstan-impure
      */
     public function getInt(string $key, ?int $maxAge = null): ?int
     {
@@ -236,6 +246,8 @@ public function getInt(string $key, ?int $maxAge = null): ?int
      * @return string|null `null` if the item has expired or doesn't exist.
      * @throws AssertionFailedException if the item stored under `$key` is not a
      * string.
+     *
+     * @phpstan-impure
      */
     public function getString(string $key, ?int $maxAge = null): ?string
     {
@@ -319,6 +331,8 @@ public function flush(): self
      * Unix timestamp representing its expiration time, or an integer
      * representing its lifetime in seconds.
      * @return T
+     *
+     * @phpstan-impure
      */
     public function maybeGet(string $key, callable $callback, $expires = null)
     {
@@ -341,6 +355,8 @@ public function maybeGet(string $key, callable $callback, $expires = null)
      *
      * - their age in seconds is less than or equal to `$maxAge`, or
      * - `$maxAge` is `0`
+     *
+     * @phpstan-impure
      */
     public function getItemCount(?int $maxAge = null): int
     {
@@ -373,6 +389,8 @@ public function getItemCount(?int $maxAge = null): int
      * - `$maxAge` is `0`
      *
      * @return string[]
+     *
+     * @phpstan-impure
      */
     public function getAllKeys(?int $maxAge = null): array
     {

src/Util/Utility/Arr.php

@@ -828,9 +828,9 @@ public static function toIndex(array $array, $value = true): array
      *
      * @template TValue of ArrayAccess|array|object
      *
-     * @param array<TValue> $array
+     * @param TValue[] $array
      * @param array-key $key
-     * @return array<TValue>
+     * @return TValue[]
      */
     public static function toMap(array $array, $key): array
     {

tests/fixtures/Util/Cli/Command/.prettyphp renamed to tests/fixtures/Util/Cli/.prettyphp

@@ -16,6 +16,14 @@ class TestOptions extends CliCommand
 {
     private const ACTION_APPLY_VALUES = 'apply-values';
     private const ACTION_APPLY_SCHEMA_VALUES = 'apply-schema-values';
+    private const ACTION_GET_RUNNING_COMMAND = 'get-running-command';
+
+    /**
+     * @var mixed
+     */
+    public $Result;
+
+    // --
 
     private ?string $Action = null;
 
@@ -90,6 +98,7 @@ protected function getOptionList(): array
                 ->allowedValues([
                     self::ACTION_APPLY_VALUES,
                     self::ACTION_APPLY_SCHEMA_VALUES,
+                    self::ACTION_GET_RUNNING_COMMAND,
                 ])
                 ->hide()
                 ->bindTo($this->Action),
@@ -104,7 +113,6 @@ protected function getOptionList(): array
                 ->allowedValues(array_keys($this->getCallbacks()))
                 ->multipleAllowed()
                 ->unique()
-                ->defaultValue(['args', 'schemaOptions', 'hasArg'])
                 ->hide()
                 ->bindTo($this->Print),
             CliOption::build()
@@ -181,14 +189,22 @@ protected function run(string ...$args)
                 $data = Json::parseObjectAsArray($this->Data);
                 $this->applyOptionValues($data, true, true, true, true, true);
                 break;
+
+            case self::ACTION_GET_RUNNING_COMMAND:
+                $this->Result = $this->App->getRunningCommand();
+                break;
         }
 
         $callbacks = $this->getCallbacks();
         foreach ($this->Print as $print) {
             $output[$print] = $callbacks[$print]();
         }
 
-        echo Json::prettyPrint($output ?? []) . \PHP_EOL;
+        if (!isset($output)) {
+            return;
+        }
+
+        echo Json::prettyPrint($output) . \PHP_EOL;
     }
 
     /**