Rearrange Sli classes, review AbstractCommand

Author: lkrms

bin/sli

@@ -19,8 +19,6 @@ $loader = require $_composer_autoload_path
 $loader->addPsr4('Salient\\Sli\\', dirname(__DIR__) . '/src/Sli/');
 
 (new CliApplication())
-    ->resumeCache()
-    ->logOutput()
     ->command(['generate', 'builder'], GenerateBuilder::class)
     ->command(['generate', 'facade'], GenerateFacade::class)
     ->command(['generate', 'tests'], GenerateTests::class)
@@ -34,4 +32,6 @@ $loader->addPsr4('Salient\\Sli\\', dirname(__DIR__) . '/src/Sli/');
     ->command(['http', 'put'], SendHttpRequest::class)
     ->command(['http', 'delete'], SendHttpRequest::class)
     ->command(['http', 'patch'], SendHttpRequest::class)
+    ->resumeCache()
+    ->logOutput()
     ->runAndExit();

phpstan-baseline-7.4.neon

@@ -30,12 +30,12 @@
 use Salient\Core\MetricCollector;
 use Salient\Curler\Curler;
 use Salient\Curler\CurlerBuilder;
-use Salient\Sli\Catalog\EnvVar;
-use Salient\Sli\Command\Generate\Concept\GenerateCommand;
+use Salient\Sli\Command\Generate\AbstractGenerateCommand;
 use Salient\Sli\Command\Generate\GenerateBuilder;
 use Salient\Sli\Command\Generate\GenerateFacade;
 use Salient\Sli\Command\Generate\GenerateSyncEntity;
 use Salient\Sli\Command\Generate\GenerateSyncProvider;
+use Salient\Sli\EnvVar;
 use Salient\Sync\DbSyncDefinition;
 use Salient\Sync\DbSyncDefinitionBuilder;
 use Salient\Sync\HttpSyncDefinition;
@@ -131,13 +131,13 @@
 ];
 
 /**
- * @param GenerateCommand|string $commandOrFile
+ * @param AbstractGenerateCommand|string $commandOrFile
  */
 function generated($commandOrFile): void
 {
     global $generated;
 
-    $file = $commandOrFile instanceof GenerateCommand
+    $file = $commandOrFile instanceof AbstractGenerateCommand
         ? $commandOrFile->OutputFile
         : $commandOrFile;
 

phpstan-baseline-8.3.neon

@@ -1,22 +1,22 @@
 <?php declare(strict_types=1);
 
-namespace Salient\Sli\Command\Concept;
+namespace Salient\Sli\Command;
 
 use Salient\Cli\Exception\CliInvalidArgumentsException;
 use Salient\Cli\CliCommand;
-use Salient\Contract\Core\ProviderInterface;
 use Salient\Core\Exception\FilesystemErrorException;
 use Salient\Core\Utility\Env;
 use Salient\Core\Utility\File;
 use Salient\Core\Utility\Get;
 use Salient\Core\Utility\Json;
-use Salient\Sli\Catalog\EnvVar;
+use Salient\Core\Utility\Test;
+use Salient\Sli\EnvVar;
 use JsonException;
 
 /**
  * Base class for sli commands
  */
-abstract class Command extends CliCommand
+abstract class AbstractCommand extends CliCommand
 {
     /**
      * Normalise a user-supplied class name, optionally assigning its base name
@@ -25,23 +25,36 @@ abstract class Command extends CliCommand
      * @return class-string|''
      */
     protected function getFqcnOptionValue(
+        string $valueName,
         string $value,
         ?string $namespaceEnvVar = null,
         ?string &$class = null,
         ?string &$namespace = null
     ): string {
+        if ($value === '') {
+            return '';
+        }
+
         $namespace = null;
         if ($namespaceEnvVar !== null) {
             $namespace = Env::get($namespaceEnvVar, null);
         }
-        if ($namespace === null) {
-            $namespace = Env::get(EnvVar::NS_DEFAULT, null);
-        }
-        if ($namespace !== null && trim($value) && strpos($value, '\\') === false) {
+        $namespace ??= Env::get(EnvVar::NS_DEFAULT, null);
+
+        if ($namespace !== null && strpos($value, '\\') === false) {
             $fqcn = trim($namespace, '\\') . "\\$value";
         } else {
             $fqcn = ltrim($value, '\\');
         }
+
+        if (!Test::isFqcn($fqcn)) {
+            throw new CliInvalidArgumentsException(sprintf(
+                'invalid %s: %s',
+                $valueName,
+                $value,
+            ));
+        }
+
         $class = Get::basename($fqcn);
         $namespace = Get::namespace($fqcn);
 
@@ -54,85 +67,88 @@ protected function getFqcnOptionValue(
      *
      * @return class-string
      */
-    protected function getRequiredFqcnOptionValue(
+    protected function requireFqcnOptionValue(
         string $valueName,
         string $value,
         ?string $namespaceEnvVar = null,
         ?string &$class = null,
         ?string &$namespace = null
     ): string {
-        $fqcn = $this->getFqcnOptionValue($value, $namespaceEnvVar, $class, $namespace);
-
+        $fqcn = $this->getFqcnOptionValue($valueName, $value, $namespaceEnvVar, $class, $namespace);
         if ($fqcn === '') {
             throw new CliInvalidArgumentsException(sprintf('invalid %s: %s', $valueName, $value));
         }
-
         return $fqcn;
     }
 
     /**
-     * Normalise mandatory user-supplied class names
+     * Normalise an array of user-supplied class names
      *
      * @param string[] $values
      * @return array<class-string>
      */
-    protected function requireMultipleFqcnValues(
+    protected function requireFqcnOptionValues(
         string $valueName,
         array $values,
         ?string $namespaceEnvVar = null
     ): array {
         $fqcn = [];
         foreach ($values as $value) {
-            $fqcn[] = $this->getRequiredFqcnOptionValue($valueName, $value, $namespaceEnvVar);
+            $fqcn[] = $this->requireFqcnOptionValue($valueName, $value, $namespaceEnvVar);
         }
         return $fqcn;
     }
 
     /**
-     * Resolve a user-supplied provider name to a concrete instance
+     * Normalise a user-supplied class name and resolve it to a concrete
+     * instance of a given class
      *
-     * @template TBaseProvider of ProviderInterface
-     * @template TProvider of TBaseProvider
+     * @template TClass of object
      *
-     * @param class-string<TProvider> $provider
-     * @param class-string<TBaseProvider> $class
-     * @return TProvider
+     * @param class-string<TClass> $class
+     * @return TClass
      */
-    protected function getProvider(string $provider, string $class = ProviderInterface::class): ProviderInterface
-    {
-        $provider = $this->getFqcnOptionValue($provider, EnvVar::NS_PROVIDER);
-        if (is_a($provider, $class, true)) {
-            return $this->App->get($provider);
+    protected function getFqcnOptionInstance(
+        string $valueName,
+        string $value,
+        string $class,
+        ?string $namespaceEnvVar = null
+    ) {
+        $value = $this->getFqcnOptionValue($valueName, $value, $namespaceEnvVar);
+        if (is_a($value, $class, true)) {
+            return $this->App->get($value);
         }
-
-        throw class_exists($provider)
-            ? new CliInvalidArgumentsException("not a subclass of $class: $provider")
-            : new CliInvalidArgumentsException("class does not exist: $provider");
+        throw new CliInvalidArgumentsException(
+            class_exists($value) ? sprintf(
+                'class does not inherit %s: %s',
+                $class,
+                $value,
+            ) : sprintf(
+                'class does not exist: %s',
+                $value,
+            )
+        );
     }
 
     /**
      * Get data from a user-supplied JSON file, optionally assigning the file's
-     * "friendly pathname" to a variable before returning
+     * "friendly pathname" to a variable passed by reference
      *
      * @return mixed
      */
     protected function getJson(string $file, ?string &$path = null, bool $associative = true)
     {
-        $_file = $file;
         if ($file === '-') {
             $file = 'php://stdin';
         } else {
             try {
-                $file = File::realpath($file);
+                $path = File::relativeToParent($file, $this->App->getBasePath(), $file);
             } catch (FilesystemErrorException $ex) {
                 throw new CliInvalidArgumentsException(sprintf(
                     'file not found: %s',
-                    $_file,
+                    $file,
                 ));
             }
-
-            $relative = File::relativeToParent($file, $this->App->getBasePath());
-            $path = $relative === null ? $file : "./{$relative}";
         }
 
         $json = File::getContents($file);
@@ -144,7 +160,7 @@ protected function getJson(string $file, ?string &$path = null, bool $associativ
         } catch (JsonException $ex) {
             throw new CliInvalidArgumentsException(sprintf(
                 "invalid JSON in '%s': %s",
-                $_file,
+                $file,
                 $ex->getMessage(),
             ));
         }