From 4b29e666b06762b4b36438c9370c38bc43121f78 Mon Sep 17 00:00:00 2001
From: Kasimir Cash <kasimir.cash@outlook.com>
Date: Wed, 28 Feb 2024 12:23:28 +0000
Subject: Command Line Parser Concept (#6099)

* Adds logic for validation

* Adds validation to do-install

* Adds help to do-install

* Adds validation & help to reconfigure

* Adds validation to check.translation

* Adds validation to manipulate.translation

* Small fixes to help texts

* Refactors language option validation

* Adds default options to validation

* Fixes validation with regex

* Refactors readAs functions

* Updates to new regex validation format

* Fixes typing around default values

* Adds file extension validation

* Restandardises validation & parsing typing around array of strings

* Adds NotOneOf validation

* Adds ArrayOfString read as

* Refactors existing validation

* Adds validation throughout cli

* Removes unused file

* Adds new CL parser with goal of wrapping CLI behaviour

* Hides parsing and validation

* Rewites CL parser to make better use of classes

* Rolls out new parser across CL

* Fixes error during unknown option check

* Fixes misnamed property calls

* Seperates validations into more appropriate locations

* Adds common boolean forms to validation

* Moves CommandLineParser and Option classes into their own files

* Fixes error when validating Int type

* Rewrites appendTypedValues -> appendTypedValidValues now filters invalid values from output

* Renames  ->  for clarity

* Adds some docs clarifying option defaults and value taking behaviour

* Refactors getUsageMessage for readability

* Minor formatting changes

* Adds tests for CommandLineParser

* Adds more tests

* Adds minor fixs

* Reconfigure now correctly updates config

* More fixes to reconfigure

* Fixes required files for CommandLineParserTest

* Use .php extension for PHP file

* PHPStan ignore instead of wrong typing

* Refactors to support php 7.4

* Moves away from dynamic properties by adding 'Definintions' to all commands

* Renames target to definition for clarity

* Stops null from being returned as a valid value in a certain edge case

* Adds PHPStan ignore instead of incorrect typing

* Refactors tests to take account of new typing solution

* Marks file as executable

* Draft CLI rework

* Finish rewrite as object-oriented

* Fix PHPStan ignore and make more strongly typed

* Rename class Option to CliOption

* Light renaming + anonymous classes

---------

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
---
 cli/CliOption.php | 104 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 104 insertions(+)
 create mode 100644 cli/CliOption.php

(limited to 'cli/CliOption.php')

diff --git a/cli/CliOption.php b/cli/CliOption.php
new file mode 100644
index 000000000..d0eace311
--- /dev/null
+++ b/cli/CliOption.php
@@ -0,0 +1,104 @@
+<?php
+declare(strict_types=1);
+
+final class CliOption {
+	public const VALUE_NONE = 'none';
+	public const VALUE_REQUIRED = 'required';
+	public const VALUE_OPTIONAL = 'optional';
+
+	private string $longAlias;
+	private ?string $shortAlias;
+	private string $valueTaken = self::VALUE_REQUIRED;
+	/** @var array{type:string,isArray:bool} $types */
+	private array $types = ['type' => 'string', 'isArray' => false];
+	private string $optionalValueDefault = '';
+	private ?string $deprecatedAlias = null;
+
+	public function __construct(string $longAlias, ?string $shortAlias = null) {
+		$this->longAlias = $longAlias;
+		$this->shortAlias = $shortAlias;
+	}
+
+	/** Sets this option to be treated as a flag. */
+	public function withValueNone(): self {
+		$this->valueTaken = static::VALUE_NONE;
+		return $this;
+	}
+
+	/** Sets this option to always require a value when used. */
+	public function withValueRequired(): self {
+		$this->valueTaken = static::VALUE_REQUIRED;
+		return $this;
+	}
+
+	/**
+	 * Sets this option to accept both values and flag behavior.
+	 * @param string $optionalValueDefault When this option is used as a flag it receives this value as input.
+	 */
+	public function withValueOptional(string $optionalValueDefault = ''): self {
+		$this->valueTaken = static::VALUE_OPTIONAL;
+		$this->optionalValueDefault = $optionalValueDefault;
+		return $this;
+	}
+
+	public function typeOfString(): self {
+		$this->types = ['type' => 'string', 'isArray' => false];
+		return $this;
+	}
+
+	public function typeOfInt(): self {
+		$this->types = ['type' => 'int', 'isArray' => false];
+		return $this;
+	}
+
+	public function typeOfBool(): self {
+		$this->types = ['type' => 'bool', 'isArray' => false];
+		return $this;
+	}
+
+	public function typeOfArrayOfString(): self {
+		$this->types = ['type' => 'string', 'isArray' => true];
+		return $this;
+	}
+
+	public function deprecatedAs(string $deprecated): self {
+		$this->deprecatedAlias = $deprecated;
+		return $this;
+	}
+
+	public function getValueTaken(): string {
+		return $this->valueTaken;
+	}
+
+	public function getOptionalValueDefault(): string {
+		return $this->optionalValueDefault;
+	}
+
+	public function getDeprecatedAlias(): ?string {
+		return $this->deprecatedAlias;
+	}
+
+	public function getLongAlias(): string {
+		return $this->longAlias;
+	}
+
+	public function getShortAlias(): ?string {
+		return $this->shortAlias;
+	}
+
+	/** @return array{type:string,isArray:bool} */
+	public function getTypes(): array {
+		return $this->types;
+	}
+
+	/** @return string[] */
+	public function getAliases(): array {
+		$aliases = [
+			$this->longAlias,
+			$this->shortAlias,
+			$this->deprecatedAlias,
+		];
+
+		return array_filter($aliases);
+	}
+}
-- 
cgit v1.2.3