Add PHPCS scaffold tool bin/phpcs-scaffold

Scripts/Scaffold/Collection/StandardCollection.php

@@ -0,0 +1,71 @@
+<?php
+
+/**
+ * PHPCSDevTools, tools for PHP_CodeSniffer sniff developers.
+ *
+ * @package   PHPCSDevTools
+ * @copyright 2019 PHPCSDevTools Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSDevTools
+ */
+
+namespace PHPCSDevTools\Scripts\Scaffold\Collection;
+
+use PHPCSDevTools\Scripts\Scaffold\Exception\ScaffolderException;
+use PHPCSDevTools\Scripts\Scaffold\Standard\NameInterface;
+use PHPCSDevTools\Scripts\Scaffold\StandardInterface;
+
+/**
+ * Represents a collection of standard.
+ */
+final class StandardCollection implements StandardCollectionInterface
+{
+
+    /**
+     * The standards in the collection, keyed by standard name.
+     *
+     * @var array<non-empty-string, StandardInterface>
+     */
+    private $standards = [];
+
+    /**
+     * Add the standard metadata to the collection.
+     *
+     * @param StandardInterface $standard The standard metadata to add
+     *
+     * @return void
+     */
+    public function add(StandardInterface $standard)
+    {
+        $this->standards[$standard->getName()->toString()] = $standard;
+    }
+
+    /**
+     * Get the standard metadata for a given standard name.
+     *
+     * @param NameInterface $standardName The name of the standard
+     *
+     * @return StandardInterface
+     */
+    public function get(NameInterface $standardName)
+    {
+        if (isset($this->standards[$standardName->toString()]) === false) {
+            throw new ScaffolderException(\sprintf(
+                'Standard "%s" not found in collection.',
+                $standardName->toString()
+            ));
+        }
+
+        return $this->standards[$standardName->toString()];
+    }
+
+    /**
+     * Get all discovered standards keyed by standard name.
+     *
+     * @return array<non-empty-string, StandardInterface>
+     */
+    public function toArray()
+    {
+        return $this->standards;
+    }
+}

Scripts/Scaffold/Collection/StandardCollectionInterface.php

@@ -0,0 +1,47 @@
+<?php
+
+/**
+ * PHPCSDevTools, tools for PHP_CodeSniffer sniff developers.
+ *
+ * @package   PHPCSDevTools
+ * @copyright 2019 PHPCSDevTools Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSDevTools
+ */
+
+namespace PHPCSDevTools\Scripts\Scaffold\Collection;
+
+use PHPCSDevTools\Scripts\Scaffold\Standard\NameInterface;
+use PHPCSDevTools\Scripts\Scaffold\StandardInterface;
+
+/**
+ * Interface StandardCollectionInterface.
+ */
+interface StandardCollectionInterface
+{
+
+    /**
+     * Add the standard metadata to the collection.
+     *
+     * @param StandardInterface $standard The standard metadata to add
+     *
+     * @return void
+     */
+    public function add(StandardInterface $standard);
+
+    /**
+     * Get the standard metadata for a given standard name.
+     *
+     * @param NameInterface $standardName The name of the standard
+     *
+     * @return StandardInterface
+     */
+    public function get(NameInterface $standardName);
+
+    /**
+     * Get all discovered standards keyed by standard name.
+     *
+     * @return array<non-empty-string, StandardInterface>
+     */
+    public function toArray();
+}

Scripts/Scaffold/Console/Application.php

@@ -0,0 +1,79 @@
+<?php
+
+/**
+ * PHPCSDevTools, tools for PHP_CodeSniffer sniff developers.
+ *
+ * @package   PHPCSDevTools
+ * @copyright 2019 PHPCSDevTools Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSDevTools
+ */
+
+namespace PHPCSDevTools\Scripts\Scaffold\Console;
+
+use PHPCSDevTools\Scripts\Scaffold\DispatcherInterface;
+use PHPCSDevTools\Scripts\Scaffold\DotSeparatedSniff;
+use PHPCSDevTools\Scripts\Scaffold\Event\ApplicationConstructedEvent;
+use PHPCSDevTools\Scripts\Scaffold\Event\ApplicationFinishedEvent;
+use PHPCSDevTools\Scripts\Scaffold\Event\ApplicationStartedEvent;
+use PHPCSDevTools\Scripts\Scaffold\Event\ApplicationStartingEvent;
+use PHPCSDevTools\Scripts\Scaffold\Event\Exception\ApplicationExceptionEvent;
+use PHPCSDevTools\Scripts\Scaffold\Exception\ScaffolderException;
+use PHPCSDevTools\Scripts\Scaffold\WorkspaceInterface;
+use PHPCSDevTools\Tests\Scaffold\ScaffolderTest;
+
+/**
+ * Coordinates the generation of scaffold files for a sniff.
+ *
+ * @see ScaffolderTest
+ */
+final class Application implements ApplicationInterface
+{
+
+    /**
+     * The event dispatcher to use for dispatching events.
+     *
+     * @var DispatcherInterface
+     */
+    private $dispatcher;
+
+    /**
+     * Create a new application instance.
+     *
+     * @param DispatcherInterface $dispatcher the event dispatcher to use for dispatching events
+     */
+    public function __construct(DispatcherInterface $dispatcher)
+    {
+        $this->dispatcher = $dispatcher;
+    }
+
+    /**
+     * Run the application with the given arguments.
+     *
+     * @param RequestInterface   $request   the validated application arguments
+     * @param WorkspaceInterface $workspace the workspace in which the application should run
+     *
+     * @throws ScaffolderException if an error occurs during scaffolding
+     *
+     * @return void
+     */
+    public function run(RequestInterface $request, WorkspaceInterface $workspace)
+    {
+        $this->dispatcher->dispatch(new ApplicationConstructedEvent($workspace));
+
+        $this->dispatcher->dispatch(new ApplicationStartingEvent($request));
+
+        $dotSeparatedSniff = DotSeparatedSniff::fromRequest($request);
+
+        $exitCode = 1;
+
+        try {
+            $this->dispatcher->dispatch(new ApplicationStartedEvent($dotSeparatedSniff, $workspace));
+            $exitCode = 0;
+        } catch (\Exception $exception) {
+            $this->dispatcher->dispatch(new ApplicationExceptionEvent($dotSeparatedSniff, $exception, $workspace));
+        }
+
+        $this->dispatcher->dispatch(new ApplicationFinishedEvent($exitCode, $dotSeparatedSniff, $workspace));
+    }
+}

Scripts/Scaffold/Console/ApplicationInterface.php

@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * PHPCSDevTools, tools for PHP_CodeSniffer sniff developers.
+ *
+ * @package   PHPCSDevTools
+ * @copyright 2019 PHPCSDevTools Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSDevTools
+ */
+
+namespace PHPCSDevTools\Scripts\Scaffold\Console;
+
+use PHPCSDevTools\Scripts\Scaffold\Exception\ScaffolderException;
+use PHPCSDevTools\Scripts\Scaffold\WorkspaceInterface;
+
+/**
+ * Defines the scaffold orchestration entry point.
+ */
+interface ApplicationInterface
+{
+
+    /**
+     * Run the application with the given arguments.
+     *
+     * @param RequestInterface   $request   the validated application arguments
+     * @param WorkspaceInterface $workspace the workspace in which the application should run
+     *
+     * @throws ScaffolderException if an error occurs during scaffolding
+     *
+     * @return void
+     */
+    public function run(RequestInterface $request, WorkspaceInterface $workspace);
+}

Scripts/Scaffold/Console/Request.php

@@ -0,0 +1,81 @@
+<?php
+
+/**
+ * PHPCSDevTools, tools for PHP_CodeSniffer sniff developers.
+ *
+ * @package   PHPCSDevTools
+ * @copyright 2019 PHPCSDevTools Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSDevTools
+ */
+
+namespace PHPCSDevTools\Scripts\Scaffold\Console;
+
+use PHPCSDevTools\Tests\Scaffold\RequestTest;
+
+/**
+ * Represents the validated inputs needed to run the scaffold application.
+ *
+ * @see RequestTest
+ */
+final class Request implements RequestInterface
+{
+
+    /**
+     * The command line arguments.
+     *
+     * @var list<non-empty-string>
+     */
+    private $arguments;
+
+    /**
+     * Create a new application arguments value object.
+     *
+     * @param list<string> $arguments the command line arguments passed to the application
+     *
+     * @throws \InvalidArgumentException if any argument is not a non-empty string
+     */
+    public function __construct(array $arguments)
+    {
+        foreach ($arguments as $argument) {
+            if (\is_string($argument) === false) {
+                throw new \InvalidArgumentException(\sprintf(
+                    'Each argument must be a string. "%s" given.',
+                    \is_object($argument) ? \get_class($argument) : \gettype($argument)
+                ));
+            }
+
+            if (\trim($argument) === '') {
+                throw new \InvalidArgumentException('Each argument must be a non-empty-string.');
+            }
+        }
+
+        $this->arguments = $arguments;
+    }
+
+    /**
+     * Get the command.
+     *
+     * @throws \InvalidArgumentException if no arguments are provided
+     *
+     * @return non-empty-string
+     */
+    public function getCommand()
+    {
+        foreach ($this->arguments as $argument) {
+            return $argument;
+        }
+
+        throw new \InvalidArgumentException('At least one argument is required to determine the command.');
+    }
+
+    /**
+     * Get command line arguments as an array.
+     *
+     * @return list<non-empty-string>
+     */
+    public function toArray()
+    {
+        return $this->arguments;
+    }
+}

Scripts/Scaffold/Console/RequestInterface.php

@@ -0,0 +1,33 @@
+<?php
+
+/**
+ * PHPCSDevTools, tools for PHP_CodeSniffer sniff developers.
+ *
+ * @package   PHPCSDevTools
+ * @copyright 2019 PHPCSDevTools Contributors
+ * @license   https://opensource.org/licenses/LGPL-3.0 LGPL3
+ * @link      https://github.com/PHPCSStandards/PHPCSDevTools
+ */
+
+namespace PHPCSDevTools\Scripts\Scaffold\Console;
+
+/**
+ * Defines the validated inputs needed to run the scaffold application.
+ */
+interface RequestInterface
+{
+
+    /**
+     * Get the command to run.
+     *
+     * @return non-empty-string
+     */
+    public function getCommand();
+
+    /**
+     * Get the validated command line arguments.
+     *
+     * @return list<non-empty-string>
+     */
+    public function toArray();
+}