Initial commit

Author: alexmerlin

.gitignore

@@ -0,0 +1,35 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Composer template
+composer.phar
+/vendor/
+
+# Commit your application's lock file http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file
+# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
+composer.lock
+
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff:
+.idea
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties

OSSMETADATA

@@ -0,0 +1 @@
+osslifecycle=active

README.md

@@ -0,0 +1,60 @@
+# dot-cli
+
+DotKernel component to build console applications based on laminas-cli
+
+### Requirements
+- PHP >= 7.4
+- laminas/laminas-servicemanager >= 3.6,
+- laminas/laminas-cli >= 1.0
+
+
+### Setup
+#### 1. Install package
+Run the following command in your application's root directory:
+```bash
+$ composer require dotkernel/dot-cli
+```
+
+#### 2. Register ConfigProvider
+Open your application's `config/config.php` and add `Dot\Cli\ConfigProvider::class,` under the _DK packages_ comment.
+
+#### 3. Copy bootstrap file
+Locate in this package the following file `bin/cli.php` then copy it to your application's `bin/` directory.
+This is the bootstrap file you will use to execute your commands with.
+
+#### 4. Copy config file
+Locate in this package the following file `config/autoload/cli.global.php` then copy it to your application's `config/autoload/` directory.
+This is the config file you will add your commands to.
+
+
+### Testing
+Using the command line, go to your application's root directory, then type the following command:
+```bash
+$ php /bin/cli.php
+```
+The output should look similar to this, containing information on how to start using dot-cli:
+```text
+DotKernel CLI 1.0.0
+
+Usage:
+  command [options] [arguments]
+
+Options:
+  -h, --help            Display help for the given command. When no command is given display help for the list command
+  -q, --quiet           Do not output any message
+  -V, --version         Display this application version
+      --ansi            Force ANSI output
+      --no-ansi         Disable ANSI output
+  -n, --no-interaction  Do not ask any interactive question
+  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
+Available commands:
+  demo-command  Demo command description.
+  help          Display help for a command
+  list          List commands
+```
+As shown in `config/autoload/cli.global.php`, dot-cli includes a demo command `demo-command` that will help you understand the basics of creating a new command.
+For more information, see [laminas-cli documentation](https://docs.laminas.dev/laminas-cli/).
+
+## License
+MIT

bin/cli.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+use Dot\Cli\Factory\ApplicationFactory;
+use Psr\Container\ContainerInterface;
+
+chdir(dirname(__DIR__));
+require 'vendor/autoload.php';
+
+/** @var ContainerInterface $container */
+$container = require 'config/container.php';
+
+$applicationFactory = new ApplicationFactory();
+exit($applicationFactory($container)->run());

composer.json

@@ -0,0 +1,35 @@
+{
+    "name": "dotkernel/dot-cli",
+    "type": "library",
+    "description": "DotKernel component for creating console applications based on laminas-cli",
+    "license": "MIT",
+    "homepage": "https://github.com/dotkernel/dot-cli",
+    "keywords": [
+        "cli",
+        "console",
+        "dotkernel",
+        "laminas",
+        "mezzio"
+    ],
+    "authors": [
+        {
+            "name": "DotKernel Team",
+            "email": "team@dotkernel.com"
+        }
+    ],
+    "require": {
+        "php": "^7.4",
+        "laminas/laminas-dependency-plugin": "^2.1",
+        "laminas/laminas-cli": "^1.0",
+        "laminas/laminas-servicemanager": "^3.6"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^9.5",
+        "squizlabs/php_codesniffer": "^3.5"
+    },
+    "autoload": {
+        "psr-4": {
+            "Dot\\Cli\\": "src"
+        }
+    }
+}

config/autoload/cli.global.php

@@ -0,0 +1,22 @@
+<?php
+
+use Dot\Cli\Command\DemoCommand;
+use Dot\Cli\FileLockerInterface;
+
+/**
+ * Documentation: https://docs.laminas.dev/laminas-cli/
+ */
+return [
+    'dot_cli' => [
+        'version' => '1.0.0',
+        'name' => 'DotKernel CLI',
+        'showVersion' => true,
+        'commands' => [
+            'demo-command' => DemoCommand::class,
+        ]
+    ],
+    FileLockerInterface::class => [
+        'enabled' => true,
+        'dirPath' => getcwd() . '/data/lock',
+    ]
+];

src/Application.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dot\Cli;
+
+use Exception;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Throwable;
+
+/**
+ * Class Application
+ * @package Dot\Cli
+ */
+class Application extends \Symfony\Component\Console\Application
+{
+    private FileLockerInterface $fileLocker;
+
+    /**
+     * Application constructor.
+     * @param FileLockerInterface $fileLocker
+     * @param array $config
+     */
+    public function __construct(FileLockerInterface $fileLocker, array $config)
+    {
+        parent::__construct($config['name'] ?? 'UNKNOWN', $config['version'] ?? 'UNKNOWN');
+
+        $this->fileLocker = $fileLocker;
+    }
+
+    /**
+     * Application destructor.
+     */
+    public function __destruct()
+    {
+        $this->fileLocker->unlock();
+    }
+
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return int
+     * @throws Throwable
+     */
+    public function doRun(InputInterface $input, OutputInterface $output): int
+    {
+        $commandName = $this->getCommandName($input);
+        $this->fileLocker->setCommandName($commandName)->setEnabled(true);
+
+        try {
+            $this->fileLocker->lock();
+        } catch (Exception $exception) {
+            $output->writeln($exception->getMessage());
+            return 0;
+        }
+
+        return parent::doRun($input, $output);
+    }
+}

src/Command/DemoCommand.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dot\Cli\Command;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * Class DemoCommand
+ * @package Dot\Cli\Command
+ */
+class DemoCommand extends Command
+{
+    protected static $defaultName = 'demo-command';
+
+    /**
+     * @return void
+     */
+    protected function configure(): void
+    {
+        $this
+            ->setName(self::$defaultName)
+            ->setDescription('Demo command description.')
+            ->addOption('opt_required', 'r', InputOption::VALUE_REQUIRED, 'Required parameter')
+            ->addOption('opt_optional', 'o', InputOption::VALUE_OPTIONAL, 'Optional parameter')
+            ->addArgument('arg_required', InputArgument::REQUIRED, 'Required argument')
+            ->addArgument('arg_optional', InputArgument::OPTIONAL, 'Optional argument', 'arg')
+            ->addArgument('arg_array', InputArgument::IS_ARRAY, 'Array argument');
+    }
+
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return int
+     */
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $output->writeln('opt_required=' . $input->getOption('opt_required'));
+        $output->writeln('opt_optional=' . $input->getOption('opt_optional'));
+        $output->writeln('arg_required=' . $input->getArgument('arg_required'));
+        $output->writeln('arg_optional=' . $input->getArgument('arg_optional'));
+        $output->writeln('arg_array=[' . implode(', ', $input->getArgument('arg_array')) . ']');
+
+        return 0;
+    }
+}

src/ConfigProvider.php

@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dot\Cli;
+
+use Dot\Cli\Factory\ApplicationFactory;
+use Dot\Cli\Factory\FileLockerFactory;
+
+/**
+ * Class ConfigProvider
+ * @package Dot\Cli
+ */
+class ConfigProvider
+{
+    /**
+     * @return array
+     */
+    public function __invoke(): array
+    {
+        return [
+            'dependencies' => $this->getDependencyConfig(),
+        ];
+    }
+
+    /**
+     * @return string[][]
+     */
+    public function getDependencyConfig(): array
+    {
+        return [
+            'aliases' => [
+                FileLockerInterface::class => FileLocker::class
+            ],
+            'factories' => [
+                Application::class => ApplicationFactory::class,
+                FileLocker::class => FileLockerFactory::class
+            ]
+        ];
+    }
+}

src/Factory/ApplicationFactory.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dot\Cli\Factory;
+
+use Dot\Cli\FileLockerInterface;
+use Laminas\Cli\ContainerCommandLoader;
+use Laminas\Cli\Listener\TerminateListener;
+use PackageVersions\Versions;
+use Psr\Container\ContainerInterface;
+use Symfony\Component\Console\Application;
+use Symfony\Component\Console\ConsoleEvents;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Webmozart\Assert\Assert;
+
+/**
+ * Class ApplicationFactory
+ */
+class ApplicationFactory
+{
+    /**
+     * @param ContainerInterface $container
+     * @return Application
+     */
+    public function __invoke(ContainerInterface $container): Application
+    {
+        $config = $container->get('config')['dot_cli'] ?? [];
+        Assert::isMap($config);
+
+        /** @psalm-suppress DeprecatedClass */
+        $version = strstr(Versions::getVersion('laminas/laminas-cli'), '@', true);
+        Assert::string($version);
+
+        $commands = $config['commands'] ?? [];
+        Assert::isMap($commands);
+        Assert::allString($commands);
+
+        $eventDispatcherServiceName = __NAMESPACE__ . '\SymfonyEventDispatcher';
+        $dispatcher                 = $container->has($eventDispatcherServiceName)
+            ? $container->get($eventDispatcherServiceName)
+            : new EventDispatcher();
+        Assert::isInstanceOf($dispatcher, EventDispatcherInterface::class);
+
+        $dispatcher->addListener(ConsoleEvents::TERMINATE, new TerminateListener($config));
+
+        $fileLocker = $container->get(FileLockerInterface::class);
+        Assert::isInstanceOf($fileLocker, FileLockerInterface::class);
+
+        $application = new \Dot\Cli\Application($fileLocker, $config);
+        // phpcs:ignore WebimpressCodingStandard.PHP.CorrectClassNameCase
+        $application->setCommandLoader(new ContainerCommandLoader($container, $commands));
+        $application->setDispatcher($dispatcher);
+        $application->setAutoExit(false);
+
+        return $application;
+    }
+}