Tidy up types (#96)

* Tidy up types

* Check output is set

* Update deps

src/Application.php

@@ -2,23 +2,21 @@
 namespace Gt\Cli;
 
 use Gt\Cli\Argument\ArgumentValueList;
-use Gt\Cli\Argument\NotEnoughArgumentsException;
 use Gt\Cli\Command\Command;
-use Gt\Cli\Command\CommandException;
 use Gt\Cli\Command\HelpCommand;
 use Gt\Cli\Command\InvalidCommandException;
 use Gt\Cli\Command\VersionCommand;
 use Gt\Cli\Parameter\MissingRequiredParameterException;
-use Gt\Cli\Parameter\MissingRequiredParameterValueException;
 use Gt\Cli\Argument\ArgumentList;
 
 class Application {
- protected $description;
- protected $arguments;
- protected $commands;
- protected $stream;
- protected $helpCommand;
- protected $versionCommand;
+ protected string $description;
+ protected ?ArgumentList $arguments;
+ /** @var Command[] */
+ protected array $commands;
+ protected Stream $stream;
+ protected HelpCommand $helpCommand;
+ protected VersionCommand $versionCommand;
 
  public function __construct(
  string $description,
@@ -53,7 +51,7 @@ public function __construct(
  $this->versionCommand->setOutput($this->stream);
  }
 
- public function setStream($in, $out, $error) {
+ public function setStream(string $in, string $out, string $error):void {
  $this->stream->setStream($in, $out, $error);
  }
 
@@ -137,4 +135,4 @@ protected function findCommandByName(string $name):Command {
 
  throw new InvalidCommandException($name);
  }
-}
+}

src/Argument/Argument.php

@@ -3,8 +3,8 @@
 
 abstract class Argument {
  const USER_DATA = "__user-data__";
- protected $key;
- protected $value;
+ protected string $key;
+ protected ?string $value;
 
  public function __construct(string $rawKey, string $value = null) {
  $this->key = $this->processRawKey($rawKey);
@@ -29,4 +29,4 @@ public function getKey():string {
  public function getValue():?string {
  return $this->value;
  }
-}
+}

src/Argument/ArgumentList.php

@@ -4,13 +4,14 @@
 use Gt\Cli\Parameter\Parameter;
 use Iterator;
 
+/** @implements Iterator<int, Argument> */
 class ArgumentList implements Iterator {
  const DEFAULT_COMMAND = "help";
 
- protected $script;
+ protected string $script;
  /** @var Argument[] */
- protected $argumentList = [];
- protected $iteratorIndex;
+ protected array $argumentList = [];
+ protected int $iteratorIndex;
 
  public function __construct(string $script, string...$arguments) {
  $this->script = $script;
@@ -25,18 +26,20 @@ public function getCommandName():string {
  return $this->argumentList[0]->getValue();
  }
 
+ /** @param string[] $arguments */
  protected function buildArgumentList(array $arguments):void {
  $commandArgument = array_shift($arguments);
  if($commandArgument) {
- $this->argumentList []= new CommandArgument(
- $commandArgument
+ array_push(
+ $this->argumentList,
+ new CommandArgument($commandArgument)
  );
  }
  else {
  $defaultCommandArgument = new CommandArgument(
  self::DEFAULT_COMMAND
  );
- $this->argumentList []= $defaultCommandArgument;
+ array_push($this->argumentList, $defaultCommandArgument);
  }
 
  $skipNextArgument = false;
@@ -82,19 +85,27 @@ protected function buildArgumentList(array $arguments):void {
  }
 
  if ($arg[1] === "-") {
- $this->argumentList []= new LongOptionArgument(
- $name,
- $value
+ array_push(
+ $this->argumentList,
+ new LongOptionArgument(
+ $name,
+ $value
+ )
  );
  }
  else {
- $this->argumentList []= new ShortOptionArgument(
- $arg,
- $value
+ array_push($this->argumentList,
+ new ShortOptionArgument(
+ $arg,
+ $value
+ )
  );
  }
  } else {
- $this->argumentList []= new NamedArgument($arg);
+ array_push(
+ $this->argumentList,
+ new NamedArgument($arg)
+ );
  }
  }
  }
@@ -177,4 +188,4 @@ public function getValueForParameter(Parameter $parameter):?string {
 
  return null;
  }
-}
+}

src/Argument/ArgumentValue.php

@@ -2,9 +2,10 @@
 namespace Gt\Cli\Argument;
 
 class ArgumentValue {
- protected $key;
- protected $valueList;
- protected $queueIndex;
+ protected string $key;
+ /** @var string[] */
+ protected array $valueList;
+ protected int $queueIndex;
 
  public function __construct(string $key) {
  $this->key = $key;
@@ -17,7 +18,7 @@ public function __toString():string {
  }
 
  public function push(string $value = null):void {
- $this->valueList []= $value;
+ array_push($this->valueList, $value);
  }
 
  public function getKey():string {
@@ -30,7 +31,8 @@ public function get():?string {
  return $value;
  }
 
+ /** @return string[] */
  public function getAll():array {
  return $this->valueList;
  }
-}
+}

src/Argument/ArgumentValueList.php

@@ -3,13 +3,15 @@
 
 use Iterator;
 
+/** @implements Iterator<int, ArgumentValue> */
 class ArgumentValueList implements Iterator {
  const DEFAULT_ARGUMENT_VALUE = "//\\DEFAULT ARGUMENT VALUE\\//";
 
  /** @var ArgumentValue[] */
- protected $valueList = [];
- protected $argumentValueMap = [];
- protected $iteratorIndex;
+ protected array $valueList = [];
+ /** @var array<string, ArgumentValue> */
+ protected array $argumentValueMap = [];
+ protected int $iteratorIndex;
 
  public function set(string $key, string $value = null):void {
  if($this->contains($key)) {
@@ -28,7 +30,7 @@ public function set(string $key, string $value = null):void {
 
  public function get(
  string $key,
- $default = self::DEFAULT_ARGUMENT_VALUE
+ string $default = self::DEFAULT_ARGUMENT_VALUE
  ):ArgumentValue {
 // $default is handled in this manner because we want to allow null to be a
 // valid value for the default.
@@ -48,12 +50,12 @@ public function contains(string $key):bool {
  }
 
  /** @link https://php.net/manual/en/iterator.rewind.php */
- public function rewind() {
+ public function rewind():void {
  $this->iteratorIndex = 0;
  }
 
  /** @link https://php.net/manual/en/iterator.key.php */
- public function key() {
+ public function key():int {
  return $this->iteratorIndex;
  }
 
@@ -65,19 +67,19 @@ public function valid():bool {
  }
 
  /** @link https://php.net/manual/en/iterator.current.php */
- public function current() {
+ public function current():?ArgumentValue {
  if(!$this->iteratorIndex) {
  $this->rewind();
  }
  return $this->valueList[$this->iteratorIndex] ?? null;
  }
 
  /** @link https://php.net/manual/en/iterator.next.php */
- public function next() {
+ public function next():void {
  $this->iteratorIndex++;
  }
 
- public function first() {
+ public function first():?ArgumentValue {
  return $this->valueList[0] ?? null;
  }
-}
+}

src/Argument/NamedArgument.php

@@ -2,11 +2,11 @@
 namespace Gt\Cli\Argument;
 
 class NamedArgument extends Argument {
- public function __construct($value) {
+ public function __construct(string $value) {
  parent::__construct("", $value);
  }
 
  protected function processRawKey(string $rawKey): string {
  return "";
  }
-}
+}

src/Command/Command.php

@@ -15,10 +15,9 @@
 use Gt\Cli\Stream;
 
 abstract class Command {
- /** @var Stream */
- protected $output;
+ protected ?Stream $output;
 
- public function setOutput(Stream $output = null) {
+ public function setOutput(Stream $output = null):void {
  $this->output = $output;
  }
 
@@ -231,7 +230,7 @@ public function getArgumentValueList(
  continue;
  }
  elseif($argument instanceof NamedArgument) {
- /** @var NamedParameter $parameter */
+ /** @var NamedParameter|null $parameter */
  $parameter = $namedParameterList[
  $namedParameterIndex
  ] ?? null;
@@ -285,7 +284,7 @@ protected function write(
  string $message,
  string $streamName = Stream::OUT
  ):void {
- if(is_null($this->output)) {
+ if(!isset($this->output) || is_null($this->output)) {
  return;
  }
 
@@ -298,4 +297,4 @@ protected function writeLine(
  ):void {
  $this->write($message . PHP_EOL, $streamName);
  }
-}
+}

src/Command/HelpCommand.php

@@ -8,10 +8,10 @@
 class HelpCommand extends Command {
  const ALL_COMMANDS = "*";
 
- protected $applicationDescription;
+ protected string $applicationDescription;
  /** @var Command[] */
- protected $applicationCommandList;
- protected $scriptName;
+ protected array $applicationCommandList;
+ protected ?string $scriptName;
 
  /**
  * @param Command[] $applicationCommandList
@@ -140,4 +140,4 @@ protected function getHelpForCommand(string $commandName = null):string {
 
  return $output;
  }
-}
+}

src/Command/VersionCommand.php

@@ -6,17 +6,18 @@
 use Gt\Cli\Parameter\Parameter;
 
 class VersionCommand extends Command {
- protected $script;
+ protected string $script;
 
  public function __construct(string $script) {
  $this->script = $script;
  }
 
  public function run(ArgumentValueList $arguments = null):void {
- $this->writeLine($this->getVersion($arguments->get(
- "command",
- null
- )));
+ $this->writeLine(
+ $this->getVersion($arguments->get(
+ "command"
+ )
+ ));
  }
 
  public function getName():string {
@@ -88,4 +89,4 @@ protected function getVersion(string $command = null):string {
 
  return $version;
  }
-}
+}