Remove Shim plugin dependency (#325)

dereuromark · web-flow · commit 29a0ae3e38f8 · 2023-09-10T18:30:27.000+02:00
* Remove shim dep
diff --git a/composer.json b/composer.json
@@ -40,7 +40,7 @@
 	"require-dev": {
 		"cakephp/plugin-installer": "^2.0.1",
 		"cakephp/migrations": "^4.0.1",
-		"dereuromark/cakephp-shim": "dev-cake5",
+		"dereuromark/cakephp-shim": "^3.0.0",
 		"fig-r/psr2r-sniffer": "dev-next",
 		"phpunit/phpunit": "^10.1"
 	},
diff --git a/src/Command/Annotate/CallbacksCommand.php b/src/Command/Annotate/CallbacksCommand.php
@@ -59,7 +59,7 @@ public function execute(Arguments $args, ConsoleIo $io): int {
 	 * @return void
 	 */
 	protected function _callbacks(string $folder) {
-		$this->io?->out(str_replace(ROOT, '', $folder), 1, ConsoleIo::VERBOSE);
+		$this->io->out(str_replace(ROOT, '', $folder), 1, ConsoleIo::VERBOSE);
 
 		$folderContent = glob($folder . '*') ?: [];
 		foreach ($folderContent as $path) {
@@ -83,7 +83,7 @@ protected function _callbacks(string $folder) {
 					continue;
 				}
 
-				$this->io?->out('-> ' . $name, 1, ConsoleIo::VERBOSE);
+				$this->io->out('-> ' . $name, 1, ConsoleIo::VERBOSE);
 
 				$annotator = $this->getAnnotator(CallbackAnnotator::class);
 				$annotator->annotate($path);
diff --git a/src/Command/Annotate/ClassesCommand.php b/src/Command/Annotate/ClassesCommand.php
@@ -78,7 +78,7 @@ public function execute(Arguments $args, ConsoleIo $io): int {
 	 * @return void
 	 */
 	protected function _classes(string $folder) {
-		$this->io?->out(str_replace(ROOT, '', $folder), 1, ConsoleIo::VERBOSE);
+		$this->io->out(str_replace(ROOT, '', $folder), 1, ConsoleIo::VERBOSE);
 
 		$folderContent = glob($folder . '*') ?: [];
 		foreach ($folderContent as $path) {
@@ -108,7 +108,7 @@ protected function _classes(string $folder) {
 					continue;
 				}
 
-				$this->io?->out('-> ' . $name, 1, ConsoleIo::VERBOSE);
+				$this->io->out('-> ' . $name, 1, ConsoleIo::VERBOSE);
 
 				$annotator = $this->getAnnotator(ClassAnnotator::class);
 				$annotator->annotate($path);
diff --git a/src/Command/Annotate/CommandsCommand.php b/src/Command/Annotate/CommandsCommand.php
@@ -44,7 +44,7 @@ public function execute(Arguments $args, ConsoleIo $io): int {
 	 * @return void
 	 */
 	protected function _commands(string $folder) {
-		$this->io?->out(str_replace(ROOT, '', $folder), 1, ConsoleIo::VERBOSE);
+		$this->io->out(str_replace(ROOT, '', $folder), 1, ConsoleIo::VERBOSE);
 
 		$folderContent = glob($folder . '*') ?: [];
 		foreach ($folderContent as $file) {
@@ -56,7 +56,7 @@ protected function _commands(string $folder) {
 				continue;
 			}
 
-			$this->io?->out('-> ' . $name, 1, ConsoleIo::VERBOSE);
+			$this->io->out('-> ' . $name, 1, ConsoleIo::VERBOSE);
 			$annotator = $this->getAnnotator(CommandAnnotator::class);
 			$annotator->annotate($file);
 		}
diff --git a/src/Command/Annotate/ComponentsCommand.php b/src/Command/Annotate/ComponentsCommand.php
@@ -44,7 +44,7 @@ public function execute(Arguments $args, ConsoleIo $io): int {
 	 * @return void
 	 */
 	protected function _components(string $folder) {
-		$this->io?->out(str_replace(ROOT, '', $folder), 1, ConsoleIo::VERBOSE);
+		$this->io->out(str_replace(ROOT, '', $folder), 1, ConsoleIo::VERBOSE);
 
 		$folderContent = glob($folder . '*') ?: [];
 		foreach ($folderContent as $path) {
@@ -56,7 +56,7 @@ protected function _components(string $folder) {
 					continue;
 				}
 
-				$this->io?->out('-> ' . $name, 1, ConsoleIo::VERBOSE);
+				$this->io->out('-> ' . $name, 1, ConsoleIo::VERBOSE);
 				$annotator = $this->getAnnotator(ComponentAnnotator::class);
 				$annotator->annotate($path);
 			}
diff --git a/src/Command/Annotate/ControllersCommand.php b/src/Command/Annotate/ControllersCommand.php
@@ -45,7 +45,7 @@ public function execute(Arguments $args, ConsoleIo $io): int {
 	 * @return void
 	 */
 	protected function _controllers(string $folder) {
-		$this->io?->out(str_replace(ROOT, '', $folder), 1, ConsoleIo::VERBOSE);
+		$this->io->out(str_replace(ROOT, '', $folder), 1, ConsoleIo::VERBOSE);
 
 		$folderContent = glob($folder . '*') ?: [];
 		foreach ($folderContent as $path) {
@@ -69,7 +69,7 @@ protected function _controllers(string $folder) {
 					continue;
 				}
 
-				$this->io?->out('-> ' . $name, 1, ConsoleIo::VERBOSE);
+				$this->io->out('-> ' . $name, 1, ConsoleIo::VERBOSE);
 
 				$annotator = $this->getAnnotator(ControllerAnnotator::class);
 				$annotator->annotate($path);
diff --git a/src/Command/Annotate/HelpersCommand.php b/src/Command/Annotate/HelpersCommand.php
@@ -44,7 +44,7 @@ public function execute(Arguments $args, ConsoleIo $io): int {
 	 * @return void
 	 */
 	protected function _helpers($folder) {
-		$this->io?->out(str_replace(ROOT, '', $folder), 1, ConsoleIo::VERBOSE);
+		$this->io->out(str_replace(ROOT, '', $folder), 1, ConsoleIo::VERBOSE);
 
 		$folderContent = glob($folder . '*') ?: [];
 		foreach ($folderContent as $path) {
@@ -56,7 +56,7 @@ protected function _helpers($folder) {
 					continue;
 				}
 
-				$this->io?->out('-> ' . $name, 1, ConsoleIo::VERBOSE);
+				$this->io->out('-> ' . $name, 1, ConsoleIo::VERBOSE);
 				$annotator = $this->getAnnotator(HelperAnnotator::class);
 				$annotator->annotate($path);
 			}
diff --git a/src/Command/Annotate/ModelsCommand.php b/src/Command/Annotate/ModelsCommand.php
@@ -44,7 +44,7 @@ public function execute(Arguments $args, ConsoleIo $io): int {
 	 * @return void
 	 */
 	protected function _models(string $folder) {
-		$this->io?->out(str_replace(ROOT, '', $folder), 1, ConsoleIo::VERBOSE);
+		$this->io->out(str_replace(ROOT, '', $folder), 1, ConsoleIo::VERBOSE);
 
 		$folderContent = glob($folder . '*') ?: [];
 		foreach ($folderContent as $file) {
@@ -56,7 +56,7 @@ protected function _models(string $folder) {
 				continue;
 			}
 
-			$this->io?->out('-> ' . $name, 1, ConsoleIo::VERBOSE);
+			$this->io->out('-> ' . $name, 1, ConsoleIo::VERBOSE);
 
 			$annotator = $this->getAnnotator(ModelAnnotator::class);
 			$annotator->annotate($file);
diff --git a/src/Command/Annotate/TemplatesCommand.php b/src/Command/Annotate/TemplatesCommand.php
@@ -44,7 +44,7 @@ public function execute(Arguments $args, ConsoleIo $io): int {
 	 * @return void
 	 */
 	protected function _templates($folder) {
-		$this->io?->out(str_replace(ROOT, '', $folder), 1, ConsoleIo::VERBOSE);
+		$this->io->out(str_replace(ROOT, '', $folder), 1, ConsoleIo::VERBOSE);
 
 		$folderContent = glob($folder . '*') ?: [];
 		foreach ($folderContent as $path) {
@@ -61,8 +61,8 @@ protected function _templates($folder) {
 						continue;
 					}
 
-					if ($this->args?->getOption('verbose')) {
-						$this->io?->warning(sprintf('Skipped template folder `%s`', str_replace(ROOT, '', $subFolder)));
+					if ($this->args->getOption('verbose')) {
+						$this->io->warning(sprintf('Skipped template folder `%s`', str_replace(ROOT, '', $subFolder)));
 					}
 
 					break;
@@ -84,7 +84,7 @@ protected function _templates($folder) {
 					continue;
 				}
 
-				$this->io?->out('-> ' . $name, 1, ConsoleIo::VERBOSE);
+				$this->io->out('-> ' . $name, 1, ConsoleIo::VERBOSE);
 				$annotator = $this->getAnnotator(TemplateAnnotator::class);
 				$annotator->annotate($path);
 			}
diff --git a/src/Command/AnnotateCommand.php b/src/Command/AnnotateCommand.php
@@ -2,13 +2,13 @@
 
 namespace IdeHelper\Command;
 
+use Cake\Command\Command;
 use Cake\Console\Arguments;
 use Cake\Console\ConsoleIo;
 use Cake\Console\ConsoleOptionParser;
 use Cake\Core\Configure;
 use IdeHelper\Annotator\AbstractAnnotator;
 use IdeHelper\Console\Io;
-use Shim\Command\Command;
 
 abstract class AnnotateCommand extends Command {
 
@@ -36,6 +36,16 @@ abstract class AnnotateCommand extends Command {
 	 */
 	protected array $_instantiatedAnnotators = [];
 
+	/**
+	 * @var \Cake\Console\Arguments
+	 */
+	protected Arguments $args;
+
+	/**
+	 * @var \Cake\Console\ConsoleIo
+	 */
+	protected ConsoleIo $io;
+
 	/**
 	 * @return void
 	 */
@@ -59,6 +69,9 @@ public function initialize(): void {
 	 * @return int|null|void The exit code or null for success
 	 */
 	public function execute(Arguments $args, ConsoleIo $io) {
+		$this->args = $args;
+		$this->io = $io;
+
 		parent::execute($args, $io);
 
 		if ($args->getOption('ci')) {
diff --git a/src/Command/GenerateCodeCompletionCommand.php b/src/Command/GenerateCodeCompletionCommand.php
@@ -2,12 +2,12 @@
 
 namespace IdeHelper\Command;
 
+use Cake\Command\Command;
 use Cake\Console\Arguments;
 use Cake\Console\ConsoleIo;
 use Cake\Console\ConsoleOptionParser;
 use IdeHelper\CodeCompletion\CodeCompletionGenerator;
 use IdeHelper\CodeCompletion\TaskCollection;
-use Shim\Command\Command;
 
 class GenerateCodeCompletionCommand extends Command {
 
diff --git a/src/Command/GeneratePhpStormMetaCommand.php b/src/Command/GeneratePhpStormMetaCommand.php
@@ -2,14 +2,14 @@
 
 namespace IdeHelper\Command;
 
+use Cake\Command\Command;
 use Cake\Console\Arguments;
 use Cake\Console\ConsoleIo;
 use Cake\Console\ConsoleOptionParser;
 use IdeHelper\Console\Io;
 use IdeHelper\Generator\PhpstormGenerator;
 use IdeHelper\Generator\TaskCollection;
 use RuntimeException;
-use Shim\Command\Command;
 
 class GeneratePhpStormMetaCommand extends Command {
 
@@ -18,6 +18,11 @@ class GeneratePhpStormMetaCommand extends Command {
 	 */
 	public const CODE_CHANGES = 2;
 
+	/**
+	 * @var \Cake\Console\ConsoleIo
+	 */
+	protected ConsoleIo $io;
+
 	/**
 	 * @return string
 	 */
@@ -33,6 +38,8 @@ public static function getDescription(): string {
 	 * @return int The exit code or null for success
 	 */
 	public function execute(Arguments $args, ConsoleIo $io): int {
+		$this->io = $io;
+
 		parent::execute($args, $io);
 
 		$phpstormGenerator = $this->getGenerator();
diff --git a/src/Command/IlluminateCommand.php b/src/Command/IlluminateCommand.php
@@ -2,6 +2,7 @@
 
 namespace IdeHelper\Command;
 
+use Cake\Command\Command;
 use Cake\Console\Arguments;
 use Cake\Console\ConsoleIo;
 use Cake\Console\ConsoleOptionParser;
@@ -10,7 +11,6 @@
 use IdeHelper\Illuminator\Illuminator;
 use IdeHelper\Illuminator\TaskCollection;
 use InvalidArgumentException;
-use Shim\Command\Command;
 
 class IlluminateCommand extends Command {
 
@@ -19,6 +19,11 @@ class IlluminateCommand extends Command {
 	 */
 	public const CODE_CHANGES = 2;
 
+	/**
+	 * @var \Cake\Console\ConsoleIo
+	 */
+	protected ConsoleIo $io;
+
 	/**
 	 * @return string
 	 */
@@ -37,7 +42,10 @@ public static function getDescription(): string {
 	 * @return int The exit code or null for success
 	 */
 	public function execute(Arguments $args, ConsoleIo $io): int {
+		$this->io = $io;
+
 		parent::execute($args, $io);
+
 		$path = $args->getArgument('path');
 		if (!$path) {
 			$path = ($args->getOption('plugin') ? 'src' : APP_DIR) . DS;
@@ -52,7 +60,7 @@ public function execute(Arguments $args, ConsoleIo $io): int {
 			throw new InvalidArgumentException('Path does not exist: ' . $path);
 		}
 
-		$illuminator = $this->getIlluminator();
+		$illuminator = $this->getIlluminator($args);
 		$filesChanged = $illuminator->illuminate($path, (string)$args->getOption('filter') ?: null);
 		if (!$filesChanged) {
 			return static::CODE_SUCCESS;
@@ -114,14 +122,14 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption
 	}
 
 	/**
+	 * @param \Cake\Console\Arguments $args
+	 *
 	 * @return \IdeHelper\Illuminator\Illuminator
 	 */
-	protected function getIlluminator(): Illuminator {
-		assert($this->args !== null, 'Args not set');
-
-		$tasks = $this->args->getOption('task') ? explode(',', (string)$this->args->getOption('task')) : [];
+	protected function getIlluminator(Arguments $args): Illuminator {
+		$tasks = $args->getOption('task') ? explode(',', (string)$args->getOption('task')) : [];
 
-		$taskCollection = new TaskCollection($this->io(), $this->args->getOptions(), $tasks);
+		$taskCollection = new TaskCollection($this->io(), $args->getOptions(), $tasks);
 
 		return new Illuminator($taskCollection);
 	}
diff --git a/tests/TestCase/Command/GeneratePhpstormMetaCommandTest.php b/tests/TestCase/Command/GeneratePhpstormMetaCommandTest.php
@@ -30,6 +30,9 @@ class GeneratePhpstormMetaCommandTest extends TestCase {
 	 */
 	protected ConsoleOutput $err;
 
+	/**
+	 * @var \Cake\Console\ConsoleIo
+	 */
 	protected ConsoleIo $io;
 
 	protected const META_FOLDER = ROOT . DS . '.phpstorm.meta.php' . DS;

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ public function execute(Arguments $args, ConsoleIo $io): int {`
`44`	`44`	`* @return void`
`45`	`45`	`*/`
`46`	`46`	`protected function _templates($folder) {`
`47`		`- $this->io?->out(str_replace(ROOT, '', $folder), 1, ConsoleIo::VERBOSE);`
	`47`	`+ $this->io->out(str_replace(ROOT, '', $folder), 1, ConsoleIo::VERBOSE);`
`48`	`48`
`49`	`49`	`$folderContent = glob($folder . '*') ?: [];`
`50`	`50`	`foreach ($folderContent as $path) {`
`@@ -61,8 +61,8 @@ protected function _templates($folder) {`
`61`	`61`	`continue;`
`62`	`62`	`}`
`63`	`63`
`64`		`- if ($this->args?->getOption('verbose')) {`
`65`		- $this->io?->warning(sprintf('Skipped template folder `%s`', str_replace(ROOT, '', $subFolder)));
	`64`	`+ if ($this->args->getOption('verbose')) {`
	`65`	+ $this->io->warning(sprintf('Skipped template folder `%s`', str_replace(ROOT, '', $subFolder)));
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`break;`
`@@ -84,7 +84,7 @@ protected function _templates($folder) {`
`84`	`84`	`continue;`
`85`	`85`	`}`
`86`	`86`
`87`		`- $this->io?->out('-> ' . $name, 1, ConsoleIo::VERBOSE);`
	`87`	`+ $this->io->out('-> ' . $name, 1, ConsoleIo::VERBOSE);`
`88`	`88`	`$annotator = $this->getAnnotator(TemplateAnnotator::class);`
`89`	`89`	`$annotator->annotate($path);`
`90`	`90`	`}`