Merge pull request #256 from alanpoulain/dependencies-step

Replace the bower install step to manage yarn and npm as well

Author: mnapoli

README.md

@@ -34,8 +34,8 @@ interface Step
 
 Steps are very granular, thus extremely easy to write and test. For example:
 
-- `LoadConfig`: loads the `couscous.yml` config file
-- `RunBowerInstall`
+- `LoadConfig`: load the `couscous.yml` config file
+- `InstallDependencies`: install the dependencies (using yarn, npm or bower)
 - `LoadMarkdownFiles`: load the content of all the `*.md` files in memory
 - `RenderMarkdown`: render the markdown content
 - `WriteFiles`: write the in-memory processed files to the target directory

docs/templates.md

@@ -148,9 +148,9 @@ Then you can use it in the layouts:
 All your Markdown links will be rewritten by Couscous to work. However, make sure you write relative links.
 A good rule of thumb is: **if it works on GitHub.com, it will work with Couscous**.
 
-## Bower
+## Dependencies
 
-If a `bower.json` file is present in the `website/` directory, dependencies will be
-installed automatically.
+If a `package.json` or a `bower.json` file is present in the `website/` directory, dependencies will be
+installed automatically by using `yarn`, `npm` or `bower`.
 
-In that case, you need [to have Bower installed](https://bower.io/). If you don't have a `bower.json`, you don't need to install Bower.
+In that case, you need to have one of these tools installed. If you don't have a dependency file, you don't need to install one of them.

src/Application/config.php

@@ -17,7 +17,7 @@
         DI\get('Couscous\Module\Template\Step\FetchRemoteTemplate'),
         DI\get('Couscous\Module\Template\Step\ValidateTemplateDirectory'),
 
-        DI\get('Couscous\Module\Bower\Step\RunBowerInstall'),
+        DI\get('Couscous\Module\Dependencies\Step\InstallDependencies'),
 
         DI\get('Couscous\Module\Markdown\Step\LoadMarkdownFiles'),
         DI\get('Couscous\Module\Template\Step\LoadAssets'),

src/CommandRunner/CommandRunner.php

@@ -10,8 +10,7 @@
 class CommandRunner
 {
     /**
-     * Runs a command.
-     *
+     * Run a command.
      *
      * @param string $command The command to be executed.
      *
@@ -21,7 +20,7 @@ class CommandRunner
      */
     public function run($command)
     {
-        if (PHP_OS === 'WINNT') {
+        if ($this->isWindows()) {
             exec($command, $output, $returnValue);
         } else {
             exec($command . ' 2>&1', $output, $returnValue);
@@ -35,4 +34,28 @@ public function run($command)
 
         return $output;
     }
+
+    /**
+     * Check if a command exists.
+     *
+     * @param string $command
+     *
+     * @return bool
+     */
+    public function commandExists($command)
+    {
+        $exists = $this->isWindows() ? 'where' : 'command -v';
+
+        return !empty(exec("$exists $command"));
+    }
+
+    /**
+     * Check if the OS is Windows.
+     *
+     * @return bool
+     */
+    private function isWindows()
+    {
+        return stripos(PHP_OS, 'WIN') === 0;
+    }
 }

src/Module/Bower/Step/RunBowerInstall.php

@@ -0,0 +1,125 @@
+<?php
+
+namespace Couscous\Module\Dependencies\Step;
+
+use Couscous\CommandRunner\CommandRunner;
+use Couscous\Model\Project;
+use Couscous\Step;
+use Psr\Log\LoggerInterface;
+use Symfony\Component\Filesystem\Filesystem;
+
+/**
+ * Install dependencies using yarn, npm or bower.
+ *
+ * @author Matthieu Napoli <[email protected]>
+ */
+class InstallDependencies implements Step
+{
+    /**
+     * @var Filesystem
+     */
+    private $filesystem;
+
+    /**
+     * @var CommandRunner
+     */
+    private $commandRunner;
+
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    public function __construct(
+        Filesystem $filesystem,
+        CommandRunner $commandRunner,
+        LoggerInterface $logger
+    ) {
+        $this->filesystem = $filesystem;
+        $this->commandRunner = $commandRunner;
+        $this->logger = $logger;
+    }
+
+    public function __invoke(Project $project)
+    {
+        $canUseYarn = $this->canUseYarn($project);
+        $canUseNpm = $this->canUseNpm($project);
+        $canUseBower = $this->canUseBower($project);
+
+        if ($project->regenerate || (!$canUseYarn && !$canUseNpm && !$canUseBower)) {
+            return;
+        }
+
+        $command = 'bower';
+        if ($canUseNpm) {
+            $command = 'npm';
+        }
+        // Use yarn preferably
+        if ($canUseYarn) {
+            $command = 'yarn';
+        }
+
+        $this->logger->notice("Executing \"$command install\"");
+
+        $result = $this->commandRunner->run(sprintf(
+            "cd \"%s\" && $command install",
+            $project->metadata['template.directory']
+        ));
+
+        if ($result) {
+            $this->logger->info($result);
+        }
+    }
+
+    /**
+     * @return bool
+     */
+    private function canUseYarn(Project $project)
+    {
+        return $this->hasPackageJson($project) && $this->commandRunner->commandExists('yarn');
+    }
+
+    /**
+     * @return bool
+     */
+    private function canUseNpm(Project $project)
+    {
+        return $this->hasPackageJson($project) && $this->commandRunner->commandExists('npm');
+    }
+
+    /**
+     * @return bool
+     */
+    private function canUseBower(Project $project)
+    {
+        return $this->hasBowerJson($project) && $this->commandRunner->commandExists('bower');
+    }
+
+    /**
+     * @return bool
+     */
+    private function hasPackageJson(Project $project)
+    {
+        if (!$project->metadata['template.directory']) {
+            return false;
+        }
+
+        $filename = $project->metadata['template.directory'].'/package.json';
+
+        return $this->filesystem->exists($filename);
+    }
+
+    /**
+     * @return bool
+     */
+    private function hasBowerJson(Project $project)
+    {
+        if (!$project->metadata['template.directory']) {
+            return false;
+        }
+
+        $filename = $project->metadata['template.directory'].'/bower.json';
+
+        return $this->filesystem->exists($filename);
+    }
+}

src/Module/Dependencies/Step/InstallDependencies.php

@@ -43,4 +43,30 @@ public function failure_executing_command_throws_runtime_exception()
 
         $this->commandRunner->run($command);
     }
+
+    /**
+     * @test
+     */
+    public function successful_command_exists()
+    {
+        $command = 'echo';
+        $expected = true;
+
+        $output = $this->commandRunner->commandExists($command);
+
+        $this->assertEquals($expected, $output);
+    }
+
+    /**
+     * @test
+     */
+    public function failure_command_exists()
+    {
+        $command = 'not_existing_command';
+        $expected = false;
+
+        $output = $this->commandRunner->commandExists($command);
+
+        $this->assertEquals($expected, $output);
+    }
 }