0.3.0 - cleanup, renames, more tests

Author: Robin de Graaf

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Parable Console
 
+## 0.3.0
+
+_Changes_
+
+- Renamed `Option` and `Argument` to have `Parameter` suffix for clarity (`OptionParameter` and `ArgumentParameter`).
+- Renamed `Help` command to `HelpCommand` for clarity.
+- Renamed `Command` and `Parameter` namespaces to plural for consistency.
+- Changed `Environment::TERMINAL_DEFAULT_HEIGHT` to 24.
+- Added `InputTest` to prevent future breaking changes to that class as well.
+
 ## 0.2.0
 
 _Changes_

composer.json

@@ -14,7 +14,7 @@
   ],
   "require": {
     "php": ">=7.1",
-    "parable-php/di": "^0.2.3"
+    "parable-php/di": "^0.2.5"
   },
   "require-dev": {
     "phpunit/phpunit": "^7.0"

src/Application.php

@@ -2,6 +2,8 @@
 
 namespace Parable\Console;
 
+use Throwable;
+
 class Application
 {
     /**
@@ -53,13 +55,16 @@ public function __construct(
         $this->input     = $input;
         $this->parameter = $parameter;
 
-        set_exception_handler(function (Exception $e) {
+        $throwableClosure = function (Throwable $e) {
             $this->output->writeErrorBlock([$e->getMessage()]);
 
             if ($this->activeCommand) {
                 $this->output->writeln('<yellow>Usage</yellow>: ' . $this->activeCommand->getUsage());
             }
-        });
+        };
+
+        set_exception_handler($throwableClosure);
+        set_error_handler($throwableClosure);
     }
 
     public function setName(string $name): void

src/Command.php

@@ -2,8 +2,8 @@
 
 namespace Parable\Console;
 
-use Parable\Console\Parameter\Argument;
-use Parable\Console\Parameter\Option;
+use Parable\Console\Parameters\ArgumentParameter;
+use Parable\Console\Parameters\OptionParameter;
 
 class Command
 {
@@ -43,12 +43,12 @@ class Command
     protected $callable;
 
     /**
-     * @var Option[]
+     * @var OptionParameter[]
      */
     protected $options = [];
 
     /**
-     * @var Argument[]
+     * @var ArgumentParameter[]
      */
     protected $arguments = [];
 
@@ -100,7 +100,7 @@ public function addOption(
         $defaultValue = null,
         bool $flagOption = false
     ): void {
-        $this->options[$name] = new Option(
+        $this->options[$name] = new OptionParameter(
             $name,
             $valueRequired,
             $defaultValue,
@@ -109,7 +109,7 @@ public function addOption(
     }
 
     /**
-     * @return Option[]
+     * @return OptionParameter[]
      */
     public function getOptions(): array
     {
@@ -121,11 +121,11 @@ public function addArgument(
         int $required = Parameter::PARAMETER_OPTIONAL,
         $defaultValue = null
     ): void {
-        $this->arguments[] = new Argument($name, $required, $defaultValue);
+        $this->arguments[] = new ArgumentParameter($name, $required, $defaultValue);
     }
 
     /**
-     * @return Argument[]
+     * @return ArgumentParameter[]
      */
     public function getArguments(): array
     {

src/Command/Help.php src/Commands/HelpCommand.phpsrc/Command/Help.php renamed to src/Commands/HelpCommand.php

@@ -1,10 +1,10 @@
 <?php declare(strict_types=1);
 
-namespace Parable\Console\Command;
+namespace Parable\Console\Commands;
 
 use Parable\Console\Command;
 
-class Help extends Command
+class HelpCommand extends Command
 {
     /**
      * @var string

src/Environment.php

@@ -4,16 +4,16 @@
 
 class Environment
 {
-    const TERMINAL_DEFAULT_HEIGHT = 25;
-    const TERMINAL_DEFAULT_WIDTH = 80;
+    public const TERMINAL_DEFAULT_HEIGHT = 24;
+    public const TERMINAL_DEFAULT_WIDTH = 80;
 
     public function getTerminalWidth(): int
     {
         if (!$this->isShellAvailable()) {
             return self::TERMINAL_DEFAULT_WIDTH;
         }
 
-        return (int)shell_exec('tput cols');
+        return (int)shell_exec('TERM=ansi tput cols');
     }
 
     public function getTerminalHeight(): int
@@ -22,7 +22,7 @@ public function getTerminalHeight(): int
             return self::TERMINAL_DEFAULT_HEIGHT;
         }
 
-        return (int)shell_exec('tput lines');
+        return (int)shell_exec('TERM=ansi tput lines');
     }
 
     public function isShellAvailable(): bool

src/Input.php

@@ -56,7 +56,7 @@ public function getKeyPress(): string
         $this->disableRequireReturn();
 
         $input = null;
-        while (1) {
+        while (true) {
             $input = $this->getRaw();
             break;
         }

src/Parameter.php

@@ -2,8 +2,8 @@
 
 namespace Parable\Console;
 
-use Parable\Console\Parameter\Argument;
-use Parable\Console\Parameter\Option;
+use Parable\Console\Parameters\ArgumentParameter;
+use Parable\Console\Parameters\OptionParameter;
 
 class Parameter
 {
@@ -44,12 +44,12 @@ class Parameter
     protected $arguments = [];
 
     /**
-     * @var Option[]
+     * @var OptionParameter[]
      */
     protected $commandOptions = [];
 
     /**
-     * @var Argument[]
+     * @var ArgumentParameter[]
      */
     protected $commandArguments = [];
 
@@ -173,12 +173,12 @@ public function getCommandName(): ?string
     }
 
     /**
-     * @param Option[] $options
+     * @param OptionParameter[] $options
      */
     public function setCommandOptions(array $options): void
     {
         foreach ($options as $name => $option) {
-            if ((!$option instanceof Option)) {
+            if ((!$option instanceof OptionParameter)) {
                 throw Exception::fromMessage(
                     "Options must be instances of Parameter\\Option. %s is not.",
                     $name
@@ -245,13 +245,13 @@ public function getOptions(): array
     /**
      * Set the arguments from a command.
      *
-     * @param Argument[] $arguments
+     * @param ArgumentParameter[] $arguments
      */
     public function setCommandArguments(array $arguments): void
     {
         $orderedArguments = [];
         foreach ($arguments as $index => $argument) {
-            if (!($argument instanceof Argument)) {
+            if (!($argument instanceof ArgumentParameter)) {
                 throw Exception::fromMessage(
                     "Arguments must be instances of Parameter\\Argument. The item at index %d is not.",
                     $index

src/Parameter/AbstractParameter.php src/Parameters/AbstractParameter.phpsrc/Parameter/AbstractParameter.php renamed to src/Parameters/AbstractParameter.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types=1);
 
-namespace Parable\Console\Parameter;
+namespace Parable\Console\Parameters;
 
 abstract class AbstractParameter
 {

src/Parameter/Argument.php src/Parameters/ArgumentParameter.phpsrc/Parameter/Argument.php renamed to src/Parameters/ArgumentParameter.php

@@ -1,11 +1,11 @@
 <?php declare(strict_types=1);
 
-namespace Parable\Console\Parameter;
+namespace Parable\Console\Parameters;
 
 use Parable\Console\Exception;
 use Parable\Console\Parameter;
 
-class Argument extends AbstractParameter
+class ArgumentParameter extends AbstractParameter
 {
     /**
      * @var int