Merge pull request #5 from iamleeg/list-licenses

Adds ability to show licenses used

bin/php-legal-licenses

@@ -9,7 +9,7 @@ if (file_exists(__DIR__.'/../vendor/autoload.php')) {
     require __DIR__.'/vendor/autoload.php';
 }
 
-$app = new Symfony\Component\Console\Application('PHP Legal Licenses', '1.0.0');
+$app = new Symfony\Component\Console\Application('PHP Legal Licenses', '1.1.0');
 $app->add(new Comcast\PhpLegalLicenses\Console\GenerateCommand);
-
+$app->add(new Comcast\PhpLegalLicenses\Console\ShowCommand);
 $app->run();

src/Comcast/PhpLegalLicenses/Command/DependencyLicenseCommand.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Comcast\PhpLegalLicenses\Console;
+
+use RuntimeException;
+use Symfony\Component\Console\Command\Command;
+
+class DependencyLicenseCommand extends Command
+{
+    /**
+     * Generates a list of dependencies from a project's composer.lock file.
+     *
+     * @return array
+     */
+    protected function getDependencyList()
+    {
+        $this->verifyComposerLockFilePresent();
+        $packages = $this->parseComposerLockFile();
+        $dependencies = $packages['packages'];
+
+        return $dependencies;
+    }
+
+    /**
+     * Verify that the composer.lock file exists.
+     *
+     * @return void
+     */
+    protected function verifyComposerLockFilePresent()
+    {
+        if (is_file(getcwd().'/composer.lock')) {
+            return;
+        }
+
+        throw new RuntimeException('Composer Lock file missing! Please run composer install and try again.');
+    }
+
+    /**
+     * Parses the composer.lock file to retrieve all installed packages.
+     *
+     * @return array
+     */
+    protected function parseComposerLockFile()
+    {
+        $path = getcwd().'/composer.lock';
+        $contents = file_get_contents($path);
+
+        return json_decode($contents, true);
+    }
+}

src/Comcast/PhpLegalLicenses/Command/GenerateCommand.php

@@ -2,12 +2,10 @@
 
 namespace Comcast\PhpLegalLicenses\Console;
 
-use RuntimeException;
-use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
-class GenerateCommand extends Command
+class GenerateCommand extends DependencyLicenseCommand
 {
     /**
      * Configure the command options.
@@ -31,42 +29,14 @@ protected function configure()
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
-        $this->verifyComposerLockFilePresent($output);
-        $packages = $this->parseComposerLockFile();
+        $dependencies = $this->getDependencyList();
 
         $output->writeln('<info>Generating Licenses file...</info>');
-        $this->generateLicensesText($packages['packages']);
+        $this->generateLicensesText($dependencies);
 
         $output->writeln('<info>Done!</info>');
     }
 
-    /**
-     * Verify that the composer.lock file exists.
-     *
-     * @return void
-     */
-    protected function verifyComposerLockFilePresent()
-    {
-        if (is_file(getcwd().'/composer.lock')) {
-            return;
-        }
-
-        throw new RuntimeException('Composer Lock file missing! Please run composer install and try again.');
-    }
-
-    /**
-     * Parses the composer.lock file to retrieve all installed packages.
-     *
-     * @return array
-     */
-    protected function parseComposerLockFile()
-    {
-        $path = getcwd().'/composer.lock';
-        $contents = file_get_contents($path);
-
-        return json_decode($contents, true);
-    }
-
     /**
      * Generates Licenses Text using packages retrieved from composer.lock file.
      *

src/Comcast/PhpLegalLicenses/Command/ShowCommand.php

@@ -0,0 +1,80 @@
+<?php
+
+namespace Comcast\PhpLegalLicenses\Console;
+
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class ShowCommand extends DependencyLicenseCommand
+{
+    /**
+     * Configure the command options.
+     *
+     * @return void
+     */
+    protected function configure()
+    {
+        $this
+        ->setName('show')
+        ->setDescription('Show licenses used by project dependencies.');
+    }
+
+    /**
+     * Execute the command.
+     *
+     * @param \Symfony\Component\Console\Input\InputInterface   $input
+     * @param \Symfony\Component\Console\Output\OutputInterface $output
+     *
+     * @return void
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $dependencies = $this->getDependencyList();
+        $this->outputDependencyLicenses($dependencies, $output);
+    }
+
+    /**
+     * Generates Licenses list using packages retrieved from composer.lock file.
+     *
+     * @param array $dependencies
+     *
+     * @return void
+     */
+    protected function outputDependencyLicenses($dependencies, $output)
+    {
+        foreach ($dependencies as $dependency) {
+            $text = $this->getTextForDependency($dependency);
+            $output->writeln($text);
+        }
+    }
+
+    /**
+     * Retrieves text containing version and license information for the specified dependency.
+     *
+     * @param array $dependency
+     *
+     * @return string
+     */
+    protected function getTextForDependency($dependency)
+    {
+        $name = $dependency['name'];
+        $version = $dependency['version'];
+        $licenseNames = isset($dependency['license']) ? implode(', ', $dependency['license']) : 'Not configured.';
+
+        return $this->generateDependencyText($name, $version, $licenseNames);
+    }
+
+    /**
+     * Generate formatted line detailing the version and license information for a particular dependency.
+     *
+     * @param string $name
+     * @param string $version
+     * @param string $licenceNames
+     *
+     * @return string
+     */
+    protected function generateDependencyText($name, $version, $licenseNames)
+    {
+        return "$name@$version [$licenseNames]";
+    }
+}