ArgumentParser::addToOptionCache() - Code Metrics - Inspection of "Defining new interfaces and improving validation" - ekowabaka/clearice - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dev ( d9deb8...1060a4 )

by James Ekow Abaka

created 2020-05-26 06:12 UTC

ArgumentParser::addToOptionCache() A

↳ Parent: ArgumentParser

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3.0175

Importance

Changes

Metric	Value
eloc	8
c	0
b	0
f	0
dl	0
loc	11
ccs	7
cts	8
cp	0.875
rs	10
cc	3
nc	3
nop	2
crap	3.0175

<?php

namespace clearice\argparser;
use clearice\utils\ProgramControl;


/**
 * For parsing arguments in ClearIce
 *
 * @package clearice\argparser
 */
class ArgumentParser
{
    /**
     * Description to put on top of the help message.
     * @var string
     */
    private $description;

    /**
     * A little message for the foot of the help message.
     * @var string
     */
    private $footer;

    /**
     * The name of the application.
     * @var string
     */
    private $name;

    /**
     * Commands that the application can execute.
     * @var array
     */
    private $commands = [];

    /**
     * A cache of all the options added.
     * The array keys represents a concatenation of the command and either the short or long name of the option. Elements
     * in this array will be the same as those in the options property. However, options that have both a short and long
     * name would appear twice.
     * @var array
     */
    private $optionsCache = [];

    /**
     * All the possible options for arguments.
     * @var array
     */
    private $options = [];

    /**
     * An instance of the help generator.
     * @var HelpMessageGenerator
     */
    private $helpGenerator;

    /**
     * An instance of the validator.
     * @var Validator
     */
    private $validator;

    /**
     * An instance of the ProgramControl class which is responsible for terminating the application.
     * @var ProgramControl
     */
    private $programControl;


    /**
     * Flag raised when help has been enabled.
     * @var bool
     */
    private $helpEnabled = false;

    /**
     * ArgumentParser constructor.
     *
     * @param ValidatorInterface $validator
     * @param HelpGeneratorInterface $helpWriter
     */
    public function __construct(ValidatorInterface $validator = null, HelpGeneratorInterface $helpWriter = null)
    {
        $this->helpGenerator = $helpWriter ?? new HelpMessageGenerator();
        $this->validator = $validator ?? new Validator();
    }

    /**
     * Add an option to the option cache for easy access through associative arrays.
     * The option cache associates arguments with their options.
     *
     * @param string $identifier
     * @param mixed $option
     * @throws OptionExistsException
     */
    private function addToOptionCache(string $identifier, $option) : void
    {
        if (!isset($option[$identifier])) {
            return;
        }
        $cacheKey = "${option['command']}${option[$identifier]}";
        if (!isset($this->optionsCache[$cacheKey])) {
            $this->optionsCache[$cacheKey] = $option;
        } else {
            throw new OptionExistsException(
                "An argument option with $identifier {$option['command']} {$option[$identifier]} already exists."
            );
        }
    }

    /**
     * @param string $command
     * @param string $name
     * @return mixed
     * @throws InvalidArgumentException
     */
    private function retrieveOptionFromCache(string $command, string $name)
    {
        $key = $command . $name;
        if(isset($this->optionsCache[$key])) {
            return $this->optionsCache[$key];
        } else if(isset($this->optionsCache[$name]) && $this->optionsCache[$name]['command'] == "") {
            return $this->optionsCache[$name];
        } else{
            throw new InvalidArgumentException("Unknown option '$name'. Please run with `--help` for more information on valid options.");
        }
    }

    /**
     * Add an option to be parsed.
     * Arguments are presented as a structured array with the following possible keys.
     *
     *  name: The name of the option prefixed with a double dash --
     *  short_name: A shorter single character option prefixed with a single dash -
     *  type: Required for all options that take values. An option specified without a type is considered to be a
     *        boolean flag.
     *  repeats: A boolean value that states whether the option can be repeated or not. Repeatable options are returned
     *        as arrays.
     *  default: A default value for the option.
     *  help: A help message for the option
     *
     * @param array $option
     * @throws OptionExistsException
     * @throws InvalidArgumentDescriptionException
     * @throws UnknownCommandException
     */
    public function addOption(array $option): void
    {
        $this->validator->validateOption($option, $this->commands);
        $option['command'] = $option['command'] ?? '';
        $option['repeats'] = $option['repeats'] ?? false;
        $this->options[] = $option;
        $this->addToOptionCache('name', $option);
        $this->addToOptionCache('short_name', $option);
    }

    /**
     * @param $arguments
     * @param $argPointer
     * @return mixed
     * @throws InvalidValueException
     */
    private function getNextValueOrFail($arguments, &$argPointer, $name)
    {
        if (isset($arguments[$argPointer + 1]) && $arguments[$argPointer + 1][0] != '-') {
            $argPointer++;
            return $arguments[$argPointer];
        } else {
            throw new InvalidValueException("A value must be passed along with argument $name.");
        }
    }

    /**
     * Parse a long argument that is prefixed with a double dash "--"
     *
     * @param $arguments
     * @param $argPointer
     * @throws InvalidValueException
     * @throws InvalidArgumentException
     */
    private function parseLongArgument($command, $arguments, &$argPointer, &$output)
    {
        $string = substr($arguments[$argPointer], 2);
        preg_match("/(?<name>[a-zA-Z_0-9-]+)(?<equal>=?)(?<value>.*)/", $string, $matches);
        $option = $this->retrieveOptionFromCache($command, $matches['name']);
        $value = true;

        if (isset($option['type'])) {
            if ($matches['equal'] === '=') {
                $value = $matches['value'];
            } else {
                $value = $this->getNextValueOrFail($arguments, $argPointer, $matches['name']);
            }
        }

        $this->assignValue($option, $output, $option['name'], $value);
    }

    /**
     * Parse a short argument that is prefixed with a single dash '-'
     *
     * @param $command
     * @param $arguments
     * @param $argPointer
     * @throws InvalidValueException
     * @throws InvalidArgumentException
     */
    private function parseShortArgument($command, $arguments, &$argPointer, &$output)
    {
        $argument = $arguments[$argPointer];
        $option = $this->retrieveOptionFromCache($command, substr($argument, 1, 1));
        $value = true;

        if (isset($option['type'])) {
            if (substr($argument, 2) != "") {
                $value = substr($argument, 2);
            } else {
                $value = $this->getNextValueOrFail($arguments, $argPointer, $option['name']);
            }
        }

        $this->assignValue($option, $output, $option['name'], $value);
    }

    private function assignValue($option, &$output, $key, $value)
    {
        if($option['repeats']) {
            $output[$key] = isset($output[$key]) ? array_merge($output[$key], [$value]) : [$value];
        } else {
            $output[$key] = $value;
        }
    }

    /**
     * @param $arguments
     * @param $argPointer
     * @param $output
     * @throws InvalidValueException
     * @throws InvalidArgumentException
     */
    private function parseArgumentArray($arguments, &$argPointer, &$output)
    {
        $numArguments = count($arguments);
        $command = $output['__command'] ?? '';
        for (; $argPointer < $numArguments; $argPointer++) {
            $arg = $arguments[$argPointer];
            if (substr($arg, 0, 2) == "--") {
                $this->parseLongArgument($command, $arguments, $argPointer, $output);
            } else if ($arg[0] == '-') {
                $this->parseShortArgument($command, $arguments, $argPointer, $output);
            } else {
                $output['__args'] = isset($output['__args']) ? array_merge($output['__args'], [$arg]) : [$arg];
            }
        }
    }

    /**
     * @param $output
     * @throws HelpMessageRequestedException
     */
    private function maybeShowHelp($output)
    {
        if ((isset($output['help']) && $output['help'] && $this->helpEnabled)) {
            print $this->getHelpMessage($output['__command'] ?? null);
            throw new HelpMessageRequestedException();
        }
    }

    private function parseCommand($arguments, &$argPointer, &$output)
    {
        if (count($arguments) > 1 && isset($this->commands[$arguments[$argPointer]])) {
            $output["__command"] = $arguments[$argPointer];
            $argPointer++;
        }
    }

    /**
     * @param $parsed
     * @throws InvalidArgumentException
     */
    private function fillInDefaults(&$parsed)
    {
        foreach($this->options as $option) {
            if(!isset($parsed[$option['name']]) && isset($option['default']) && $option['command'] == ($parsed['__command'] ?? "")) {
                $parsed[$option['name']] = $option['default'];
            }
        }
    }

    /**
     * Parses command line arguments and return a structured array of options and their associated values.
     *
     * @param array $arguments An optional array of arguments that would be parsed instead of those passed to the CLI.
     * @return array
     * @throws InvalidValueException
     */
    public function parse($arguments = null)
    {
        try{
            global $argv;
            $arguments = $arguments ?? $argv;
            $argPointer = 1;
            $parsed = [];
            $this->name = $this->name ?? $arguments[0];
            $this->parseCommand($arguments, $argPointer, $parsed);
            $this->parseArgumentArray($arguments, $argPointer, $parsed);
            $this->maybeShowHelp($parsed);
            $this->validator->validateArguments($this->options, $parsed);
            $this->fillInDefaults($parsed);
            $parsed['__executed'] = $this->name;
            return $parsed;
        } catch (HelpMessageRequestedException $exception) {
            exit(0);

        } catch (InvalidArgumentException $exception) {
            print $exception->getMessage() . PHP_EOL;
            exit(128);

        }
    }

    /**
     * Enables help messages so they show automatically.
     * This method also allows you to optionally pass the name of the application, a description header for the help 
     * message and a footer.
     *
     * @param string $name The name of the application binary
     * @param string $description A description to be displayed on top of the help message
     * @param string $footer A footer message to be displayed after the help message
     *
     * @throws InvalidArgumentDescriptionException
     * @throws OptionExistsException
     * @throws UnknownCommandException
     */
    public function enableHelp(string $description = null, string $footer = null, string $name = null) : void
    {
        $this->name = $name;
        $this->description = $description;
        $this->footer = $footer;
        $this->helpEnabled = true;
        $this->addOption(['name' => 'help', 'short_name' => 'h', 'help' => "display this help message"]);
        foreach($this->commands as $command) {
            $this->addOption(['name' => 'help', 'help' => 'display this help message', 'command' => $command['name']]);
        }
    }

    public function getHelpMessage($command = '')
    {
        return $this->helpGenerator->generate(
            $this->name, $command ?? null,
            ['options' => $this->options, 'commands' => $this->commands],
            $this->description, $this->footer
        );
    }

    /**
     * @param $command
     * @throws CommandExistsException
     * @throws InvalidArgumentDescriptionException
     */
    public function addCommand($command)
    {
        $this->validator->validateCommand($command, $this->commands);
        $this->commands[$command['name']] = $command;
    }
}


1		<?php
2
3		namespace clearice\argparser;
4		use clearice\utils\ProgramControl;
5
6
7		/**
8		* For parsing arguments in ClearIce
9		*
10		* @package clearice\argparser
11		*/
12		class ArgumentParser
13		{
14		/**
15		* Description to put on top of the help message.
16		* @var string
17		*/
18		private $description;
19
20		/**
21		* A little message for the foot of the help message.
22		* @var string
23		*/
24		private $footer;
25
26		/**
27		* The name of the application.
28		* @var string
29		*/
30		private $name;
31
32		/**
33		* Commands that the application can execute.
34		* @var array
35		*/
36		private $commands = [];
37
38		/**
39		* A cache of all the options added.
40		* The array keys represents a concatenation of the command and either the short or long name of the option. Elements
41		* in this array will be the same as those in the options property. However, options that have both a short and long
42		* name would appear twice.
43		* @var array
44		*/
45		private $optionsCache = [];
46
47		/**
48		* All the possible options for arguments.
49		* @var array
50		*/
51		private $options = [];
52
53		/**
54		* An instance of the help generator.
55		* @var HelpMessageGenerator
56		*/
57		private $helpGenerator;
58
59		/**
60		* An instance of the validator.
61		* @var Validator
62		*/
63		private $validator;
64
65		/**
66		* An instance of the ProgramControl class which is responsible for terminating the application.
67		* @var ProgramControl
68		*/
69		private $programControl;
		0 ignored issues – show introduced 2020-05-26 06:13 UTC by Report Bug Copy Issue Report The private property `$programControl` is not used, and could be removed. Loading history...
70
71		/**
72		* Flag raised when help has been enabled.
73		* @var bool
74		*/
75		private $helpEnabled = false;
76
77		/**
78		* ArgumentParser constructor.
79		*
80		* @param ValidatorInterface $validator
81		* @param HelpGeneratorInterface $helpWriter
82		*/
83	8	public function __construct(ValidatorInterface $validator = null, HelpGeneratorInterface $helpWriter = null)
84		{
85	8	$this->helpGenerator = $helpWriter ?? new HelpMessageGenerator();
86	8	$this->validator = $validator ?? new Validator();
87	8	}
88
89		/**
90		* Add an option to the option cache for easy access through associative arrays.
91		* The option cache associates arguments with their options.
92		*
93		* @param string $identifier
94		* @param mixed $option
95		* @throws OptionExistsException
96		*/
97	6	private function addToOptionCache(string $identifier, $option) : void
98		{
99	6	if (!isset($option[$identifier])) {
100		return;
101		}
102	6	$cacheKey = "${option['command']}${option[$identifier]}";
103	6	if (!isset($this->optionsCache[$cacheKey])) {
104	6	$this->optionsCache[$cacheKey] = $option;
105		} else {
106	1	throw new OptionExistsException(
107	1	"An argument option with $identifier {$option['command']} {$option[$identifier]} already exists."
108		);
109		}
110	6	}
111
112		/**
113		* @param string $command
114		* @param string $name
115		* @return mixed
116		* @throws InvalidArgumentException
117		*/
118	4	private function retrieveOptionFromCache(string $command, string $name)
119		{
120	4	$key = $command . $name;
121	4	if(isset($this->optionsCache[$key])) {
122	4	return $this->optionsCache[$key];
123		} else if(isset($this->optionsCache[$name]) && $this->optionsCache[$name]['command'] == "") {
124		return $this->optionsCache[$name];
125		} else{
126		throw new InvalidArgumentException("Unknown option '$name'. Please run with `--help` for more information on valid options.");
127		}
128		}
129
130		/**
131		* Add an option to be parsed.
132		* Arguments are presented as a structured array with the following possible keys.
133		*
134		* name: The name of the option prefixed with a double dash --
135		* short_name: A shorter single character option prefixed with a single dash -
136		* type: Required for all options that take values. An option specified without a type is considered to be a
137		* boolean flag.
138		* repeats: A boolean value that states whether the option can be repeated or not. Repeatable options are returned
139		* as arrays.
140		* default: A default value for the option.
141		* help: A help message for the option
142		*
143		* @param array $option
144		* @throws OptionExistsException
145		* @throws InvalidArgumentDescriptionException
146		* @throws UnknownCommandException
147		*/
148	8	public function addOption(array $option): void
149		{
150	8	$this->validator->validateOption($option, $this->commands);
151	6	$option['command'] = $option['command'] ?? '';
152	6	$option['repeats'] = $option['repeats'] ?? false;
153	6	$this->options[] = $option;
154	6	$this->addToOptionCache('name', $option);
155	6	$this->addToOptionCache('short_name', $option);
156	6	}
157
158		/**
159		* @param $arguments
160		* @param $argPointer
161		* @return mixed
162		* @throws InvalidValueException
163		*/
164	3	private function getNextValueOrFail($arguments, &$argPointer, $name)
165		{
166	3	if (isset($arguments[$argPointer + 1]) && $arguments[$argPointer + 1][0] != '-') {
167	2	$argPointer++;
168	2	return $arguments[$argPointer];
169		} else {
170	1	throw new InvalidValueException("A value must be passed along with argument $name.");
171		}
172		}
173
174		/**
175		* Parse a long argument that is prefixed with a double dash "--"
176		*
177		* @param $arguments
178		* @param $argPointer
179		* @throws InvalidValueException
180		* @throws InvalidArgumentException
181		*/
182	2	private function parseLongArgument($command, $arguments, &$argPointer, &$output)
183		{
184	2	$string = substr($arguments[$argPointer], 2);
185	2	preg_match("/(?<name>[a-zA-Z_0-9-]+)(?<equal>=?)(?<value>.*)/", $string, $matches);
186	2	$option = $this->retrieveOptionFromCache($command, $matches['name']);
187	2	$value = true;
188
189	2	if (isset($option['type'])) {
190	2	if ($matches['equal'] === '=') {
191	1	$value = $matches['value'];
192		} else {
193	2	$value = $this->getNextValueOrFail($arguments, $argPointer, $matches['name']);
194		}
195		}
196
197	2	$this->assignValue($option, $output, $option['name'], $value);
198	2	}
199
200		/**
201		* Parse a short argument that is prefixed with a single dash '-'
202		*
203		* @param $command
204		* @param $arguments
205		* @param $argPointer
206		* @throws InvalidValueException
207		* @throws InvalidArgumentException
208		*/
209	3	private function parseShortArgument($command, $arguments, &$argPointer, &$output)
210		{
211	3	$argument = $arguments[$argPointer];
212	3	$option = $this->retrieveOptionFromCache($command, substr($argument, 1, 1));
213	3	$value = true;
214
215	3	if (isset($option['type'])) {
216	3	if (substr($argument, 2) != "") {
217	2	$value = substr($argument, 2);
218		} else {
219	2	$value = $this->getNextValueOrFail($arguments, $argPointer, $option['name']);
220		}
221		}
222
223	2	$this->assignValue($option, $output, $option['name'], $value);
224	2	}
225
226	3	private function assignValue($option, &$output, $key, $value)
227		{
228	3	if($option['repeats']) {
229	1	$output[$key] = isset($output[$key]) ? array_merge($output[$key], [$value]) : [$value];
230		} else {
231	2	$output[$key] = $value;
232		}
233	3	}
234
235		/**
236		* @param $arguments
237		* @param $argPointer
238		* @param $output
239		* @throws InvalidValueException
240		* @throws InvalidArgumentException
241		*/
242	4	private function parseArgumentArray($arguments, &$argPointer, &$output)
243		{
244	4	$numArguments = count($arguments);
245	4	$command = $output['__command'] ?? '';
246	4	for (; $argPointer < $numArguments; $argPointer++) {
247	4	$arg = $arguments[$argPointer];
248	4	if (substr($arg, 0, 2) == "--") {
249	2	$this->parseLongArgument($command, $arguments, $argPointer, $output);
250	3	} else if ($arg[0] == '-') {
251	3	$this->parseShortArgument($command, $arguments, $argPointer, $output);
252		} else {
253	1	$output['__args'] = isset($output['__args']) ? array_merge($output['__args'], [$arg]) : [$arg];
254		}
255		}
256	3	}
257
258		/**
259		* @param $output
260		* @throws HelpMessageRequestedException
261		*/
262	3	private function maybeShowHelp($output)
263		{
264	3	if ((isset($output['help']) && $output['help'] && $this->helpEnabled)) {
265		print $this->getHelpMessage($output['__command'] ?? null);
266		throw new HelpMessageRequestedException();
267		}
268	3	}
269
270	4	private function parseCommand($arguments, &$argPointer, &$output)
271		{
272	4	if (count($arguments) > 1 && isset($this->commands[$arguments[$argPointer]])) {
273		$output["__command"] = $arguments[$argPointer];
274		$argPointer++;
275		}
276	4	}
277
278		/**
279		* @param $parsed
280		* @throws InvalidArgumentException
281		*/
282	3	private function fillInDefaults(&$parsed)
283		{
284	3	foreach($this->options as $option) {
285	3	if(!isset($parsed[$option['name']]) && isset($option['default']) && $option['command'] == ($parsed['__command'] ?? "")) {
286	1	$parsed[$option['name']] = $option['default'];
287		}
288		}
289	3	}
290
291		/**
292		* Parses command line arguments and return a structured array of options and their associated values.
293		*
294		* @param array $arguments An optional array of arguments that would be parsed instead of those passed to the CLI.
295		* @return array
296		* @throws InvalidValueException
297		*/
298	4	public function parse($arguments = null)
299		{
300		try{
301	4	global $argv;
302	4	$arguments = $arguments ?? $argv;
303	4	$argPointer = 1;
304	4	$parsed = [];
305	4	$this->name = $this->name ?? $arguments[0];
306	4	$this->parseCommand($arguments, $argPointer, $parsed);
307	4	$this->parseArgumentArray($arguments, $argPointer, $parsed);
308	3	$this->maybeShowHelp($parsed);
309	3	$this->validator->validateArguments($this->options, $parsed);
310	3	$this->fillInDefaults($parsed);
311	3	$parsed['__executed'] = $this->name;
312	3	return $parsed;
313	1	} catch (HelpMessageRequestedException $exception) {
314		exit(0);
		0 ignored issues – show Best Practice introduced 2020-05-26 06:13 UTC by Report Bug Copy Issue Report Using `exit` here is not recommended. In general, usage of exit should be done with care and only when running in a scripting context like a CLI script. Loading history...
315	1	} catch (InvalidArgumentException $exception) {
316		print $exception->getMessage() . PHP_EOL;
317		exit(128);
		0 ignored issues – show Best Practice introduced 2020-05-26 06:13 UTC by Report Bug Copy Issue Report Using `exit` here is not recommended. In general, usage of exit should be done with care and only when running in a scripting context like a CLI script. Loading history...
318		}
319		}
320
321		/**
322		* Enables help messages so they show automatically.
323		* This method also allows you to optionally pass the name of the application, a description header for the help
324		* message and a footer.
325		*
326		* @param string $name The name of the application binary
327		* @param string $description A description to be displayed on top of the help message
328		* @param string $footer A footer message to be displayed after the help message
329		*
330		* @throws InvalidArgumentDescriptionException
331		* @throws OptionExistsException
332		* @throws UnknownCommandException
333		*/
334		public function enableHelp(string $description = null, string $footer = null, string $name = null) : void
335		{
336		$this->name = $name;
337		$this->description = $description;
338		$this->footer = $footer;
339		$this->helpEnabled = true;
340		$this->addOption(['name' => 'help', 'short_name' => 'h', 'help' => "display this help message"]);
341		foreach($this->commands as $command) {
342		$this->addOption(['name' => 'help', 'help' => 'display this help message', 'command' => $command['name']]);
343		}
344		}
345
346		public function getHelpMessage($command = '')
347		{
348		return $this->helpGenerator->generate(
349		$this->name, $command ?? null,
350		['options' => $this->options, 'commands' => $this->commands],
351		$this->description, $this->footer
352		);
353		}
354
355		/**
356		* @param $command
357		* @throws CommandExistsException
358		* @throws InvalidArgumentDescriptionException
359		*/
360		public function addCommand($command)
361		{
362		$this->validator->validateCommand($command, $this->commands);
363		$this->commands[$command['name']] = $command;
364		}
365		}
366

ekowabaka / clearice

Push — dev ( d9deb8...1060a4 )

ArgumentParser::addToOptionCache() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like