Add add command and tidy up

Author: scottwakefield

composer.lock

@@ -1,6 +1,8 @@
 #!/usr/bin/env php
 <?php
+
 use Symfony\Component\Console\Application;
+use Club\KickoffInstaller\Console\AddCommand;
 use Club\KickoffInstaller\Console\NewCommand;
 use Club\KickoffInstaller\Console\ConfigCommand;
 
@@ -10,7 +12,8 @@ if (file_exists(__DIR__.'/../../autoload.php')) {
     require __DIR__.'/vendor/autoload.php';
 }
 
-$app = new Application('CraftCMS Installer', '1.0.0');
+$app = new Application('CraftCMS Installer', '1.1.0');
 $app->add(new NewCommand);
+$app->add(new AddCommand);
 $app->add(new ConfigCommand);
 $app->run();

kickoff

@@ -0,0 +1,38 @@
+<?php
+
+namespace Club\KickoffInstaller\Console;
+
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class AddCommand extends InstallationCommand
+{
+    /**
+     * Configure the command.
+     */
+    protected function configure()
+    {
+        $this->setName('add')
+             ->setDescription('Add a framework installation to an existing project')
+             ->addArgument('framework', InputArgument::REQUIRED);
+    }
+
+    /**
+     * Execute the command.
+     *
+     * @param InputInterface  $input
+     * @param OutputInterface $output
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $installerClass = $this->getInstallerClass(
+            $input->getArgument('framework')
+        );
+
+        $installer = new $installerClass($input, $output, getcwd());
+        $installer->install();
+
+        $output->writeln("<comment>`{$installer->name()}` added to your project. Happy coding!</comment>");
+    }
+}

src/Console/AddCommand.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Club\KickoffInstaller\Console;
+
+use InvalidArgumentException;
+use Symfony\Component\Console\Command\Command;
+
+abstract class InstallationCommand extends Command
+{
+    /**
+     * Available installers.
+     *
+     * @return array An array of available installer class names
+     */
+    protected function installers()
+    {
+        return [
+            'CraftCms' => \Club\KickoffInstaller\Installers\CraftCms\Installer::class,
+        ];
+    }
+
+    /**
+     * Get the full class name of an installer.
+     *
+     * @param string $framework Framework short-name
+     *
+     * @return string Installer class name
+     */
+    protected function getInstallerClass($framework)
+    {
+        $installers = $this->installers();
+
+        if (!array_key_exists($framework, $installers)) {
+            throw new InvalidArgumentException("An installer for `$framework` does not exist.");
+        }
+
+        return $installers[$framework];
+    }
+}

src/Console/InstallationCommand.php

@@ -1,20 +1,17 @@
 <?php
+
 namespace Club\KickoffInstaller\Console;
 
-use InvalidArgumentException;
-use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Club\KickoffInstaller\Installers\Kickoff\Installer as KickoffInstaller;
 
-class NewCommand extends Command
+class NewCommand extends InstallationCommand
 {
     /**
      * Configure the command.
-     *
-     * @return void
      */
     protected function configure()
     {
@@ -24,41 +21,11 @@ protected function configure()
              ->addOption('clean', null, InputOption::VALUE_NONE, 'If set, Kickoff will be omitted from the install');
     }
 
-    /**
-     * Available installers.
-     *
-     * @return array An array of available installer class names.
-     */
-    protected function installers()
-    {
-        return [
-            'CraftCms' => \Club\KickoffInstaller\Installers\CraftCms\Installer::class,
-        ];
-    }
-
-    /**
-     * Get the full class name of an installer.
-     *
-     * @param  string $framework Framework short-name.
-     * @return string Installer class name.
-     */
-    protected function getInstallerClass($framework)
-    {
-        $installers = $this->installers();
-
-        if (!array_key_exists($framework, $installers)) {
-            throw new InvalidArgumentException("An installer for `$framework` does not exist.");
-        }
-
-        return $installers[$framework];
-    }
-
     /**
      * Execute the command.
      *
-     * @param  InputInterface  $input
-     * @param  OutputInterface $output
-     * @return void
+     * @param InputInterface  $input
+     * @param OutputInterface $output
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {

src/Console/NewCommand.php

@@ -28,7 +28,7 @@ class Installer extends BaseInstaller
     protected $downloadTo = 'craft.zip';
 
     /**
-     * Configurable directories to path constant mappings
+     * Configurable directories to path constant mappings.
      *
      * @var array
      */
@@ -41,7 +41,7 @@ class Installer extends BaseInstaller
     ];
 
     /**
-     * Commands to run when Kickoff isn't installed
+     * Commands to run when Kickoff isn't installed.
      *
      * @return array An array of commands
      */
@@ -63,7 +63,7 @@ public function clean()
     }
 
     /**
-     * Commands to run once the framework has been downloaded
+     * Commands to run once the framework has been downloaded.
      *
      * @return array An array of commands
      */
@@ -79,9 +79,7 @@ protected function kickoff()
     }
 
     /**
-     * Runs when the installation process is complete
-     *
-     * @return void
+     * Runs when the installation process is complete.
      */
     protected function complete()
     {
@@ -91,8 +89,7 @@ protected function complete()
     /**
      * Move Craft Directories in to those defined in the configuration file.
      *
-     * @param  object $mappings An object of directory mappings
-     * @return void
+     * @param object $mappings An object of directory mappings
      */
     protected function moveCraftDirectories($mappings)
     {
@@ -125,25 +122,20 @@ protected function moveCraftDirectories($mappings)
 
     /**
      * Swap the default Kickoff index file with the Craft index file.
-     *
-     * @return void
      */
     protected function swapIndexFile()
     {
         $this->output->writeln('<info>Moving Front Controller...</info>');
 
         $this->runCommands([
             'mv tmp/public/index.php ./public/',
-            'rm public/index.html',
         ]);
 
         $this->output->writeln('<comment>Front Controller moved!</comment>');
     }
 
     /**
-     * Inject custom directory mappings into the Craft index file
-     *
-     * @return void
+     * Inject custom directory mappings into the Craft index file.
      */
     protected function updateFrontController()
     {
@@ -156,10 +148,9 @@ protected function updateFrontController()
     }
 
     /**
-     * Install PHPDotEnv Library
+     * Install PHPDotEnv Library.
      *
-     * @param  object $mappings An object of directory mappings
-     * @return void
+     * @param object $mappings An object of directory mappings
      */
     protected function installPhpDotEnv($mappings)
     {
@@ -181,14 +172,13 @@ protected function installPhpDotEnv($mappings)
     }
 
     /**
-     * Replace path names in the Craft index file
+     * Replace path names in the Craft index file.
      *
-     * @param  object $mappings An object of directory mappings
-     * @return void
+     * @param object $mappings An object of directory mappings
      */
     protected function replacePaths($mappings)
     {
-        $commands  = [];
+        $commands = [];
         foreach (self::$pathConstants as $key => $constant) {
             if (isset($mappings->$key)) {
                 $path = str_replace('/', '\/', "../{$mappings->$key}/");