Merge pull request #1 from guillermoandrae/master

Documentation, cleanup, verbosity messages.

Author: guillermoandrae

.scrutinizer.yml

@@ -0,0 +1,17 @@
+tools:
+  external_code_coverage: true
+  php_sim: true
+  php_pdepend: true
+  php_analyzer: true
+  php_code_sniffer:
+    config:
+      standard: "PSR2"
+filter:
+  excluded_paths:
+    - 'reports/*'
+    - 'tests/*'
+    - 'vendor/*'
+build_failure_conditions:
+  - 'issues.label("coding-style").exists'
+  - 'project.metric("scrutinizer.quality", < 8)'
+  - 'project.metric("scrutinizer.test_coverage", < 0.80)'

.travis.yml

@@ -1,5 +1,21 @@
 language: php
+
 php:
   - 5.5
+  - 5.6
+  - hhvm
+
+sudo: false
+
+matrix:
+  fast_finish: true
+
 install:
-  - composer install --no-interaction --prefer-source
+  - composer install --no-interaction --prefer-source
+
+script:
+  - ./vendor/bin/phpunit --coverage-clover=coverage.clover
+
+after_script:
+  - wget https://scrutinizer-ci.com/ocular.phar
+  - php ocular.phar code-coverage:upload --format=php-clover coverage.clover

CONTRIBUTING.md

@@ -0,0 +1,10 @@
+# Contributing
+
+## Pull Requests
+
+1. Create your own [fork](https://help.github.com/articles/fork-a-repo) of the repo.
+2. Send a pull request with your changes.
+
+## Style Guide
+
+All pull requests must adhere to the [PSR-2 standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md).

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Hampton Roads PHP
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,4 +1,22 @@
 # hrphp-cli
-[![Build Status](https://api.travis-ci.org/hrphp/hrphp-cli.png?branch=master)](http://travis-ci.org/hrphp/hrphp-cli)
+[![Travis branch](https://img.shields.io/travis/hrphp/hrphp-cli.svg?style=flat)](https://travis-ci.org/hrphp/hrphp-cli) [![Coverage Status](http://img.shields.io/scrutinizer/coverage/g/hrphp/hrphp-cli.svg?style=flat)](https://scrutinizer-ci.com/g/hrphp/hrphp-cli/?branch=master) [![Code Quality](http://img.shields.io/scrutinizer/g/hrphp/hrphp-cli.svg?style=flat)](https://scrutinizer-ci.com/g/hrphp/hrphp-cli/?branch=master) [![HHVM](https://img.shields.io/hhvm/hrphp/hrphp-cli.svg?style=flat)](http://hhvm.h4cc.de/package/hrphp/hrphp-cli.json)
 
 CLI tool for HRPHP related shenanigans.
+
+## Usage
+You can use this tool in one of two ways.
+
+You can execute the `hrphp` file in the `bin` directory:
+```
+./bin/hrphp <command>
+```
+
+Or you can download and run the phar:
+```
+php hrphp.phar <command>
+```
+
+Run the `list` command to see a list of available commands:
+```
+php hrphp.phar list
+```

composer.json

@@ -2,7 +2,6 @@
   "name": "hrphp/hrphp-cli",
   "description": "CLI tool for HRPHP related shenanigans.",
   "require": {
-    "php": ">=5.5",
     "symfony/console": "~2.6",
     "phing/phing": "@stable",
     "kherge/box": "~2.0",

src/library/Command/PingCommand.php

@@ -37,24 +37,31 @@ public function getClient()
         return $this->client;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     protected function configure()
     {
         $this->setName('ping')
             ->setDescription('Pings the HRPHP website');
     }
 
+    /**
+     * {@inheritdoc}
+     */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $output->writeln(sprintf('<info>%s command</info>', $this->getName()));
         $response = $this->getClient()->get(HRPHP_URL);
-        /*
+
         if ($output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
             $output->writeln(sprintf('Attempting to hit %s at %s...', HRPHP_URL, date('H:i:s A')));
         }
+
         if ($output->getVerbosity() >= OutputInterface::VERBOSITY_VERY_VERBOSE) {
             $output->writeln(sprintf('Ping being sent from %s...', gethostname()));
         }
-        */
+
         if ($response->getStatusCode() === 200) {
             $output->writeln(sprintf('%s is up!', HRPHP_URL));
         }

tests/library/Command/PingCommandTest.php

@@ -14,6 +14,7 @@
 use GuzzleHttp\Psr7\Response;
 use Hrphp\Cli\Command\PingCommand;
 use Symfony\Component\Console\Application;
+use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Tester\CommandTester;
 
 class PingCommandTest extends \PHPUnit_Framework_TestCase
@@ -34,6 +35,26 @@ public function testPing()
         self::assertContains(sprintf('%s is up!', HRPHP_URL), $output);
     }
 
+    public function testVerbosePing()
+    {
+        $commandTester = $this->getCommandTester(
+            'ping',
+            [ 'verbosity' => OutputInterface::VERBOSITY_VERBOSE ]
+        );
+        $output = $commandTester->getDisplay();
+        self::assertContains('Attempting to hit', $output);
+    }
+
+    public function testVeryVerbosePing()
+    {
+        $commandTester = $this->getCommandTester(
+            'ping',
+            [ 'verbosity' => OutputInterface::VERBOSITY_VERY_VERBOSE ]
+        );
+        $output = $commandTester->getDisplay();
+        self::assertContains('Ping being sent from', $output);
+    }
+
     protected function setUp()
     {
         $command = new PingCommand($this->getClient());
@@ -58,13 +79,14 @@ protected function getClient()
 
     /**
      * @param string $commandName
+     * @param array $options
      * @return CommandTester
      */
-    protected function getCommandTester($commandName)
+    protected function getCommandTester($commandName, array $options = [])
     {
         $command = $this->getApplication()->find($commandName);
         $commandTester = new CommandTester($command);
-        $commandTester->execute(array_merge(array('command' => $commandName)));
+        $commandTester->execute(['command' => $commandName], $options);
         return $commandTester;
     }