Merge pull request #335 from jolicode/code-grooming

code grooming
jolicode · Mar 20, 2024 · 811d46f · 811d46f
2 parents 3ce7c3f + b3ff0a3
commit 811d46f
Show file tree

Hide file tree

Showing 27 changed files with 73 additions and 46 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,8 @@
 * Add a way to merge an application `box.json` config file used by `castor:repack`command
 * Deprecate `Context::withPath()` in favor of `Context::withWorkingDirectory()`
 * Deprecate `path` argument in `capture()`, `exit_code()`, `run()`, `with()` in favor of `workingDirectory`
+* Deprecate `Castor\TaskDescriptorCollection` in favor of
+  `Castor\Descriptor\TaskDescriptorCollection`
 
 ## 0.14.0 (2024-03-08)
 

diff --git a/bin/generate-tests.php b/bin/generate-tests.php
@@ -4,7 +4,7 @@
 require __DIR__ . '/../vendor/autoload.php';
 
 use Castor\Console\ApplicationFactory;
-use Castor\PlatformUtil;
+use Castor\PlatformHelper;
 use Castor\Tests\Helper\OutputCleaner;
 use Castor\Tests\Helper\WebServerHelper;
 use Symfony\Component\Console\Input\ArrayInput;
@@ -19,7 +19,7 @@
 WebServerHelper::start();
 
 $fs = new Filesystem();
-$fs->remove(PlatformUtil::getCacheDirectory());
+$fs->remove(PlatformHelper::getCacheDirectory());
 $fs->remove(__DIR__ . '/../tests/Examples/Generated');
 $fs->mkdir(__DIR__ . '/../tests/Examples/Generated');
 

diff --git a/src/Console/Application.php b/src/Console/Application.php
@@ -4,23 +4,23 @@
 
 use Castor\Console\Command\SymfonyTaskCommand;
 use Castor\Console\Command\TaskCommand;
+use Castor\Console\Output\SectionOutput;
+use Castor\Console\Output\VerbosityLevel;
 use Castor\Context;
-use Castor\ContextDescriptor;
-use Castor\ContextGeneratorDescriptor;
 use Castor\ContextRegistry;
+use Castor\Descriptor\ContextDescriptor;
+use Castor\Descriptor\ContextGeneratorDescriptor;
+use Castor\Descriptor\ListenerDescriptor;
+use Castor\Descriptor\SymfonyTaskDescriptor;
+use Castor\Descriptor\TaskDescriptor;
+use Castor\Descriptor\TaskDescriptorCollection;
 use Castor\Event\AfterApplicationInitializationEvent;
 use Castor\EventDispatcher;
 use Castor\ExpressionLanguage;
 use Castor\Fingerprint\FingerprintHelper;
 use Castor\FunctionFinder;
 use Castor\GlobalHelper;
-use Castor\ListenerDescriptor;
-use Castor\PlatformUtil;
-use Castor\SectionOutput;
-use Castor\SymfonyTaskDescriptor;
-use Castor\TaskDescriptor;
-use Castor\TaskDescriptorCollection;
-use Castor\VerbosityLevel;
+use Castor\PlatformHelper;
 use Castor\WaitForHelper;
 use Monolog\Logger;
 use Psr\Cache\CacheItemPoolInterface;
@@ -203,7 +203,7 @@ private function initializeApplication(InputInterface $input): TaskDescriptorCol
         $contextNames = $this->contextRegistry->getNames();
 
         if ($contextNames) {
-            $defaultContext = PlatformUtil::getEnv('CASTOR_CONTEXT') ?: $this->contextRegistry->getDefaultName();
+            $defaultContext = PlatformHelper::getEnv('CASTOR_CONTEXT') ?: $this->contextRegistry->getDefaultName();
 
             $this->getDefinition()->addOption(new InputOption(
                 'context',

diff --git a/src/Console/ApplicationFactory.php b/src/Console/ApplicationFactory.php
@@ -14,7 +14,7 @@
 use Castor\Listener\UpdateCastorListener;
 use Castor\Monolog\Processor\ProcessProcessor;
 use Castor\PathHelper;
-use Castor\PlatformUtil;
+use Castor\PlatformHelper;
 use Castor\Stub\StubsGenerator;
 use Castor\WaitForHelper;
 use Monolog\Logger;
@@ -45,7 +45,7 @@ public static function create(): SymfonyApplication
                 'User-Agent' => 'Castor/' . Application::VERSION,
             ],
         ]);
-        $cacheDir = PlatformUtil::getCacheDirectory();
+        $cacheDir = PlatformHelper::getCacheDirectory();
         $cache = new FilesystemAdapter(directory: $cacheDir);
         $logger = new Logger('castor', [], [new ProcessProcessor()]);
         $fs = new Filesystem();

diff --git a/src/Console/Command/CompileCommand.php b/src/Console/Command/CompileCommand.php
@@ -3,7 +3,7 @@
 namespace Castor\Console\Command;
 
 use Castor\PathHelper;
-use Castor\PlatformUtil;
+use Castor\PlatformHelper;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -55,7 +55,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $phpBuildCacheKey = $this->generatePHPBuildCacheKey($input);
 
-        $spcBinaryPath = PlatformUtil::getCacheDirectory() . '/castor-php-static-compiler/' . $phpBuildCacheKey . '/spc';
+        $spcBinaryPath = PlatformHelper::getCacheDirectory() . '/castor-php-static-compiler/' . $phpBuildCacheKey . '/spc';
         $spcBinaryDir = \dirname($spcBinaryPath);
 
         $this->setupSPC(

diff --git a/src/SectionOutput.php → src/Console/Output/SectionOutput.php b/src/SectionOutput.php → src/Console/Output/SectionOutput.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Castor;
+namespace Castor\Console\Output;
 
 use Symfony\Component\Console\Output\ConsoleOutput;
 use Symfony\Component\Console\Output\ConsoleSectionOutput;

diff --git a/src/VerbosityLevel.php → src/Console/Output/VerbosityLevel.php b/src/VerbosityLevel.php → src/Console/Output/VerbosityLevel.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Castor;
+namespace Castor\Console\Output;
 
 use Symfony\Component\Console\Output\OutputInterface;
 

diff --git a/src/Context.php b/src/Context.php
@@ -2,6 +2,8 @@
 
 namespace Castor;
 
+use Castor\Console\Output\VerbosityLevel;
+
 class Context implements \ArrayAccess
 {
     public readonly string $workingDirectory;

diff --git a/src/ContextRegistry.php b/src/ContextRegistry.php
@@ -2,6 +2,7 @@
 
 namespace Castor;
 
+use Castor\Descriptor\ContextDescriptor;
 use Castor\Exception\FunctionConfigurationException;
 
 /** @internal */

diff --git a/src/ContextDescriptor.php → src/Descriptor/ContextDescriptor.php b/src/ContextDescriptor.php → src/Descriptor/ContextDescriptor.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Castor;
+namespace Castor\Descriptor;
 
 use Castor\Attribute\AsContext;
 

diff --git a/src/ContextGeneratorDescriptor.php → ...Descriptor/ContextGeneratorDescriptor.php b/src/ContextGeneratorDescriptor.php → ...Descriptor/ContextGeneratorDescriptor.php
@@ -1,8 +1,9 @@
 <?php
 
-namespace Castor;
+namespace Castor\Descriptor;
 
 use Castor\Attribute\AsContextGenerator;
+use Castor\Context;
 
 /** @internal */
 class ContextGeneratorDescriptor

diff --git a/src/ListenerDescriptor.php → src/Descriptor/ListenerDescriptor.php b/src/ListenerDescriptor.php → src/Descriptor/ListenerDescriptor.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Castor;
+namespace Castor\Descriptor;
 
 use Castor\Attribute\AsListener;
 

diff --git a/src/SymfonyTaskDescriptor.php → src/Descriptor/SymfonyTaskDescriptor.php b/src/SymfonyTaskDescriptor.php → src/Descriptor/SymfonyTaskDescriptor.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Castor;
+namespace Castor\Descriptor;
 
 use Castor\Attribute\AsSymfonyTask;
 

diff --git a/src/TaskDescriptor.php → src/Descriptor/TaskDescriptor.php b/src/TaskDescriptor.php → src/Descriptor/TaskDescriptor.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Castor;
+namespace Castor\Descriptor;
 
 use Castor\Attribute\AsTask;
 

diff --git a/src/Descriptor/TaskDescriptorCollection.php b/src/Descriptor/TaskDescriptorCollection.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Castor\Descriptor;
+
+class TaskDescriptorCollection
+{
+    /**
+     * @param TaskDescriptor[]        $taskDescriptors
+     * @param SymfonyTaskDescriptor[] $symfonyTaskDescriptors
+     */
+    public function __construct(
+        public readonly array $taskDescriptors,
+        public readonly array $symfonyTaskDescriptors,
+    ) {
+    }
+}
diff --git a/src/Event/AfterApplicationInitializationEvent.php b/src/Event/AfterApplicationInitializationEvent.php
@@ -3,7 +3,7 @@
 namespace Castor\Event;
 
 use Castor\Console\Application;
-use Castor\TaskDescriptorCollection;
+use Castor\Descriptor\TaskDescriptorCollection;
 
 class AfterApplicationInitializationEvent
 {

diff --git a/src/Fingerprint/FingerprintHelper.php b/src/Fingerprint/FingerprintHelper.php
@@ -5,6 +5,7 @@
 use Psr\Cache\CacheItemPoolInterface;
 use Symfony\Contracts\Cache\CacheInterface;
 
+/** @internal */
 class FingerprintHelper
 {
     private const SUFFIX = '.fingerprint';

diff --git a/src/FunctionFinder.php b/src/FunctionFinder.php
@@ -7,6 +7,11 @@
 use Castor\Attribute\AsListener;
 use Castor\Attribute\AsSymfonyTask;
 use Castor\Attribute\AsTask;
+use Castor\Descriptor\ContextDescriptor;
+use Castor\Descriptor\ContextGeneratorDescriptor;
+use Castor\Descriptor\ListenerDescriptor;
+use Castor\Descriptor\SymfonyTaskDescriptor;
+use Castor\Descriptor\TaskDescriptor;
 use Castor\Exception\FunctionConfigurationException;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Finder\Finder;

diff --git a/src/GlobalHelper.php b/src/GlobalHelper.php
@@ -3,6 +3,7 @@
 namespace Castor;
 
 use Castor\Console\Application;
+use Castor\Console\Output\SectionOutput;
 use Monolog\Logger;
 use Psr\Cache\CacheItemPoolInterface;
 use Symfony\Component\Console\Command\Command;

diff --git a/src/Listener/UpdateCastorListener.php b/src/Listener/UpdateCastorListener.php
@@ -3,7 +3,7 @@
 namespace Castor\Listener;
 
 use Castor\Console\Application;
-use Castor\PlatformUtil;
+use Castor\PlatformHelper;
 use JoliCode\PhpOsHelper\OsHelper;
 use Psr\Cache\CacheItemPoolInterface;
 use Psr\Log\LoggerInterface;
@@ -33,7 +33,7 @@ public function checkUpdate(ConsoleCommandEvent $event): void
         if (class_exists(\RepackedApplication::class)) {
             return;
         }
-        if (PlatformUtil::getEnv('DISABLE_VERSION_CHECK')) {
+        if (PlatformHelper::getEnv('DISABLE_VERSION_CHECK')) {
             return;
         }
 

diff --git a/src/PlatformUtil.php → src/PlatformHelper.php b/src/PlatformUtil.php → src/PlatformHelper.php
@@ -9,7 +9,7 @@
  *
  * @internal
  */
-final class PlatformUtil
+final class PlatformHelper
 {
     /**
      * getenv() equivalent but reads from the runtime global variables first.

diff --git a/src/TaskDescriptorCollection.php b/src/TaskDescriptorCollection.php
@@ -2,15 +2,13 @@
 
 namespace Castor;
 
-class TaskDescriptorCollection
+use Castor\Descriptor\TaskDescriptorCollection as BaseTaskDescriptorCollection;
+
+trigger_deprecation('castor', '0.15.0', 'The "%s" class is deprecated, use "%s" instead.', TaskDescriptorCollection::class, BaseTaskDescriptorCollection::class);
+
+/**
+ * @deprecated since Castor 0.15.0, use Castor\Descriptor\TaskDescriptorCollection instead
+ */
+class TaskDescriptorCollection extends BaseTaskDescriptorCollection
 {
-    /**
-     * @param TaskDescriptor[]        $taskDescriptors
-     * @param SymfonyTaskDescriptor[] $symfonyTaskDescriptors
-     */
-    public function __construct(
-        public readonly array $taskDescriptors,
-        public readonly array $symfonyTaskDescriptors,
-    ) {
-    }
 }
diff --git a/tests/Examples/Fingerprint/FingerprintedTestCase.php b/tests/Examples/Fingerprint/FingerprintedTestCase.php
@@ -2,7 +2,7 @@
 
 namespace Castor\Tests\Examples\Fingerprint;
 
-use Castor\PlatformUtil;
+use Castor\PlatformHelper;
 use Castor\Tests\TaskTestCase;
 use Symfony\Component\Finder\Finder;
 
@@ -20,10 +20,10 @@ protected function setUp(): void
 
     private static function clearFingerprintsCache(): void
     {
-        if (is_dir(PlatformUtil::getCacheDirectory())) {
+        if (is_dir(PlatformHelper::getCacheDirectory())) {
             foreach (
                 (new Finder())
-                    ->in(PlatformUtil::getCacheDirectory())
+                    ->in(PlatformHelper::getCacheDirectory())
                     ->contains('.fingerprint')
                     ->files() as $file
             ) {
@@ -32,7 +32,7 @@ private static function clearFingerprintsCache(): void
 
             foreach (
                 (new Finder())
-                    ->in(PlatformUtil::getCacheDirectory())
+                    ->in(PlatformHelper::getCacheDirectory())
                     ->notContains('.fingerprint')
                     ->directories() as $directory
             ) {

diff --git a/tests/Examples/Generated/ContextGeneratorArg2Test.php.err.txt b/tests/Examples/Generated/ContextGeneratorArg2Test.php.err.txt
@@ -1,5 +1,5 @@
 
-In FunctionFinder.php line 218:
+In FunctionFinder.php line 223:
 
   Function "gen()" is not properly configured:          
   The context generator "foo" must not have arguments.  

diff --git a/tests/Examples/Generated/ContextGeneratorArgTest.php.err.txt b/tests/Examples/Generated/ContextGeneratorArgTest.php.err.txt
@@ -1,5 +1,5 @@
 
-In FunctionFinder.php line 209:
+In FunctionFinder.php line 214:
 
   Function "gen()" is not properly configured:     
   The contexts generator must not have arguments.  

diff --git a/tests/Examples/Generated/ContextGeneratorNotCallableTest.php.err.txt b/tests/Examples/Generated/ContextGeneratorNotCallableTest.php.err.txt
@@ -1,5 +1,5 @@
 
-In FunctionFinder.php line 214:
+In FunctionFinder.php line 219:
 
   Function "gen()" is not properly configured:  
   The context generator "foo" is not callable.  

diff --git a/tests/bin/compile-get-cache-key b/tests/bin/compile-get-cache-key
@@ -4,7 +4,7 @@
 require __DIR__ . '/../../vendor/autoload.php';
 
 use Castor\Console\Command\CompileCommand;
-use Castor\PlatformUtil;
+use Castor\PlatformHelper;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Command\Command;
 
@@ -14,7 +14,7 @@ $command = (new class() extends CompileCommand {
         }}
     )
     ->setCode(Closure::bind(
-        fn($input) => (print PlatformUtil::getCacheDirectory() . '/castor-php-static-compiler/' . $this->generatePHPBuildCacheKey($input)) && 0,
+        fn($input) => (print PlatformHelper::getCacheDirectory() . '/castor-php-static-compiler/' . $this->generatePHPBuildCacheKey($input)) && 0,
         null,
         CompileCommand::class
     ))