Fixes #9: Support --help in addition to 'help'

Author: greg-1-anderson

.travis.yml

@@ -7,11 +7,12 @@ branches:
     - /^[[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+.*$/
 
 php:
-  - 5.3
-  - 5.4
-  - 5.5
-  - 5.6
+  - 7.1
   - 7.0
+  - 5.6
+  - 5.5
+  - 5.4
+  - 5.3
 
 sudo: false
 
@@ -24,8 +25,7 @@ before_script:
   - composer install
 
 script:
-  - vendor/bin/phpcs --standard=PSR2 -n src
-  - vendor/bin/phpunit
+  - composer test
 
 after_success:
   - travis_retry php vendor/bin/coveralls -v

composer.json

@@ -18,6 +18,12 @@
         "satooshi/php-coveralls": "^1.0",
         "squizlabs/php_codesniffer": "2.*"
     },
+    "scripts": {
+        "test": [ "@phpunit", "@cs" ],
+        "phpunit": "phpunit --colors=always",
+        "cs": "phpcs --standard=PSR2 -n src",
+        "cbf": "phpcbf --standard=PSR2 -n src"
+    },
     "bin": ["bin/cgr"],
     "autoload": {
         "psr-4": {"Consolidation\\Cgr\\": "src"}

help/help

@@ -0,0 +1,32 @@
+The 'cgr' tool is a "safer" alternative to 'composer global require'.
+Installing projects with cgr helps avoid dependency conflicts between
+different tools.  Use 'cgr' wherever 'composer global require' is recommended.
+
+Examples:
+
+Install a project:
+------------------
+$ cgr drush/drush
+
+Display the info of a project:
+-----------------------------
+$ cgr info drush/drush
+
+Display the info of all projects installed via 'cgr':
+----------------------------------------------------
+$ cgr info
+
+Update a project:
+-----------------
+$ cgr update drush/drush
+
+Update all projects installed via 'cgr':
+----------------------------------------
+$ cgr update
+
+Remove a project:
+-----------------
+$ cgr remove drush/drush
+
+For more information, see: https://github.com/consolidation/cgr
+

src/Application.php

@@ -30,9 +30,9 @@ public function run($argv, $home)
 
         list($argv, $options) = $this->parseOutOurOptions($argv, $optionDefaultValues);
 
-        if (reset($argv) == 'help') {
-            $this->help($argv);
-            return 0;
+        $helpArg = $this->getHelpArgValue($argv);
+        if (!empty($helpArg)) {
+            return $this->help($helpArg);
         }
 
         $commandList = $this->separateProjectAndGetCommandList($argv, $home, $options);
@@ -42,44 +42,47 @@ public function run($argv, $home)
         return $this->runCommandList($commandList, $options);
     }
 
-    public function help($argv)
+    /**
+     * Returns the first argument after `help`, or the
+     * first argument if `--help` is present. Otherwise,
+     * returns an empty string.
+     */
+    public function getHelpArgValue($argv)
     {
-        // Future: support 'help <command>'?
-        print <<<EOT
-The 'cgr' tool is a "safer" alternative to 'composer global require'.
-Installing projects with cgr helps avoid dependency conflicts between
-different tools.  Use 'cgr' wherever 'composer global require' is recommended.
-
-Examples:
-
-Install a project:
-------------------
-$ cgr drush/drush
+        $hasHelp = false;
+        $helpArg = '';
 
-Display the info of a project:
------------------------------
-$ cgr info drush/drush
-
-Display the info of all projects installed via 'cgr':
-----------------------------------------------------
-$ cgr info
+        foreach ($argv as $arg) {
+            if (($arg == 'help') || ($arg == '--help') || ($arg == '-h')) {
+                $hasHelp = true;
+            } elseif (($arg[0] != '-') && empty($helpArg)) {
+                $helpArg = $arg;
+            }
+        }
 
-Update a project:
------------------
-$ cgr update drush/drush
+        if (!$hasHelp) {
+            return false;
+        }
 
-Update all projects installed via 'cgr':
-----------------------------------------
-$ cgr update
+        if (empty($helpArg)) {
+            return 'help';
+        }
 
-Remove a project:
------------------
-$ cgr remove drush/drush
+        return $helpArg;
+    }
 
-For more information, see: https://github.com/consolidation/cgr
+    public function help($helpArg)
+    {
+        $helpFile = dirname(__DIR__) . '/help/' . $helpArg;
 
+        if (!file_exists($helpFile)) {
+            print "No help available for '$helpArg'\n";
+            return 1;
+        }
 
-EOT;
+        $helpContents = file_get_contents($helpFile);
+        print $helpContents;
+        return 0;
     }
 
     /**