ArgumentParser::parseArgumentArray() - Code Metrics - Inspection of "Merge pull request #4 from ekowabaka/dev" - ekowabaka/clearice - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ba24d6...47edb6 )

by James Ekow Abaka

created 2018-08-05 04:23 UTC

ArgumentParser::parseArgumentArray() A

↳ Parent: ArgumentParser

Complexity

Conditions	5
Paths	5

Size

Total Lines	12
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	5

Importance

Changes

Metric	Value
eloc	10
dl	0
loc	12
c	0
b	0
f	0
ccs	9
cts	9
cp	1
rs	9.6111
cc	5
nc	5
nop	3
crap	5

<?php

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


/**
 * Class ArgumentParser
 *
 * @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;

    public function __construct($helpWriter = null, $programControl = null)
    {
        $this->helpGenerator = $helpWriter ?? new HelpMessageGenerator();
        $this->programControl = $programControl ?? new ProgramControl();
        $this->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 $key
     * @param string $name
     * @return mixed
     * @throws InvalidArgumentException
     */
    private function retrieveOptionFromCache(string $key, string $name)
    {
        if(!isset($this->optionsCache[$key])) {
            throw new InvalidArgumentException("Unknown option '$name'. Please run with `--help` for more information on valid options.");
        }
        return $this->optionsCache[$key];
    }

    /**
     * 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);
        $key = $command . $matches['name'];
        $option = $this->retrieveOptionFromCache($key, $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];
        $key = $command . substr($argument, 1, 1);
        $option = $this->retrieveOptionFromCache($key, 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;
function myFunction($a, $b) {
    // Do something
}
            $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);
            return $parsed;
        } catch (HelpMessageRequestedException $exception) {
            $this->programControl->quit();
        } catch (InvalidArgumentException $exception) {
            print $exception->getMessage() . PHP_EOL;
            $this->programControl->quit();
        }
    }

    /**
     * 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;
    }
}


Push — master ( ba24d6...47edb6 )

ArgumentParser::parseArgumentArray() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1		<?php
2
3		namespace clearice\argparser;
4		use clearice\utils\ProgramControl;
5
6
7		/**
8		* Class ArgumentParser
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;
70
71		/**
72		* Flag raised when help has been enabled.
73		* @var bool
74		*/
75		private $helpEnabled = false;
76
77	14	public function __construct($helpWriter = null, $programControl = null)
78		{
79	14	$this->helpGenerator = $helpWriter ?? new HelpMessageGenerator();
80	14	$this->programControl = $programControl ?? new ProgramControl();
81	14	$this->validator = new Validator();
82	14	}
83
84		/**
85		* Add an option to the option cache for easy access through associative arrays.
86		* The option cache associates arguments with their options.
87		*
88		* @param string $identifier
89		* @param mixed $option
90		* @throws OptionExistsException
91		*/
92	13	private function addToOptionCache(string $identifier, $option) : void
93		{
94	13	if (!isset($option[$identifier])) {
95	2	return;
96		}
97		$cacheKey = "${option['command']}${option[$identifier]}";
98		if (!isset($this->optionsCache[$cacheKey])) {
99	13	$this->optionsCache[$cacheKey] = $option;
100		} else {
101	2	throw new OptionExistsException(
102	2	"An argument option with $identifier {$option['command']} {$option[$identifier]} already exists."
103		);
104		}
105	13	}
106
107		/**
108		* @param string $key
109		* @param string $name
110		* @return mixed
111		* @throws InvalidArgumentException
112		*/
113		private function retrieveOptionFromCache(string $key, string $name)
114		{
115	7	if(!isset($this->optionsCache[$key])) {
116		throw new InvalidArgumentException("Unknown option '$name'. Please run with `--help` for more information on valid options.");
117		}
118	7	return $this->optionsCache[$key];
119		}
120
121		/**
122		* Add an option to be parsed.
123		* Arguments are presented as a structured array with the following possible keys.
124		*
125		* name: The name of the option prefixed with a double dash --
126		* short_name: A shorter single character option prefixed with a single dash -
127		* type: Required for all options that take values. An option specified without a type is considered to be a
128		* boolean flag.
129		* repeats: A boolean value that states whether the option can be repeated or not. Repeatable options are returned
130		* as arrays.
131		* default: A default value for the option.
132		* help: A help message for the option
133		*
134		* @param array $option
135		* @throws OptionExistsException
136		* @throws InvalidArgumentDescriptionException
137		* @throws UnknownCommandException
138		*/
139		public function addOption(array $option): void
140		{
141	14	$this->validator->validateOption($option, $this->commands);
142	13	$option['command'] = $option['command'] ?? '';
143	13	$option['repeats'] = $option['repeats'] ?? false;
144	13	$this->options[] = $option;
145	13	$this->addToOptionCache('name', $option);
146	13	$this->addToOptionCache('short_name', $option);
147	13	}
148
149		/**
150		* @param $arguments
151		* @param $argPointer
152		* @return mixed
153		* @throws InvalidValueException
154		*/
155		private function getNextValueOrFail($arguments, &$argPointer, $name)
156		{
157	5	if (isset($arguments[$argPointer + 1]) && $arguments[$argPointer + 1][0] != '-') {
158	3	$argPointer++;
159	3	return $arguments[$argPointer];
160		} else {
161	2	throw new InvalidValueException("A value must be passed along with argument $name.");
162		}
163		}
164
165		/**
166		* Parse a long argument that is prefixed with a double dash "--"
167		*
168		* @param $arguments
169		* @param $argPointer
170		* @throws InvalidValueException
171		* @throws InvalidArgumentException
172		*/
173		private function parseLongArgument($command, $arguments, &$argPointer, &$output)
174		{
175	5	$string = substr($arguments[$argPointer], 2);
176	5	preg_match("/(?<name>[a-zA-Z_0-9-]+)(?<equal>=?)(?<value>.*)/", $string, $matches);
177	5	$key = $command . $matches['name'];
178	5	$option = $this->retrieveOptionFromCache($key, $matches['name']);
179	5	$value = true;
180
181	5	if (isset($option['type'])) {
182	4	if ($matches['equal'] === '=') {
183	1	$value = $matches['value'];
184		} else {
185	4	$value = $this->getNextValueOrFail($arguments, $argPointer, $matches['name']);
186		}
187		}
188
189	4	$this->assignValue($option, $output, $option['name'], $value);
190	4	}
191
192		/**
193		* Parse a short argument that is prefixed with a single dash '-'
194		*
195		* @param $command
196		* @param $arguments
197		* @param $argPointer
198		* @throws InvalidValueException
199		* @throws InvalidArgumentException
200		*/
201		private function parseShortArgument($command, $arguments, &$argPointer, &$output)
202		{
203	3	$argument = $arguments[$argPointer];
204	3	$key = $command . substr($argument, 1, 1);
205	3	$option = $this->retrieveOptionFromCache($key, substr($argument, 1, 1));
206	3	$value = true;
207
208	3	if (isset($option['type'])) {
209	3	if (substr($argument, 2) != "") {
210	2	$value = substr($argument, 2);
211		} else {
212	2	$value = $this->getNextValueOrFail($arguments, $argPointer, $option['name']);
213		}
214		}
215
216	2	$this->assignValue($option, $output, $option['name'], $value);
217	2	}
218
219		private function assignValue($option, &$output, $key, $value)
220		{
221	5	if($option['repeats']) {
222	1	$output[$key] = isset($output[$key]) ? array_merge($output[$key], [$value]) : [$value];
223		} else {
224	4	$output[$key] = $value;
225		}
226	5	}
227
228		/**
229		* @param $arguments
230		* @param $argPointer
231		* @param $output
232		* @throws InvalidValueException
233		* @throws InvalidArgumentException
234		*/
235		private function parseArgumentArray($arguments, &$argPointer, &$output)
236		{
237	7	$numArguments = count($arguments);
238	7	$command = $output['__command'] ?? '';
239	7	for (; $argPointer < $numArguments; $argPointer++) {
240	7	$arg = $arguments[$argPointer];
241	7	if (substr($arg, 0, 2) == "--") {
242	5	$this->parseLongArgument($command, $arguments, $argPointer, $output);
243	3	} else if ($arg[0] == '-') {
244	3	$this->parseShortArgument($command, $arguments, $argPointer, $output);
245		} else {
246	1	$output['__args'] = isset($output['__args']) ? array_merge($output['__args'], [$arg]) : [$arg];
247		}
248		}
249	5	}
250
251		/**
252		* @param $output
253		* @throws HelpMessageRequestedException
254		*/
255		private function maybeShowHelp($output)
256		{
257	5	if ((isset($output['help']) && $output['help'] && $this->helpEnabled)) {
258	1	print $this->getHelpMessage($output['__command'] ?? null);
259	1	throw new HelpMessageRequestedException();
260		}
261	4	}
262
263		private function parseCommand($arguments, &$argPointer, &$output)
264		{
265	7	if (count($arguments) > 1 && isset($this->commands[$arguments[$argPointer]])) {
266	1	$output["__command"] = $arguments[$argPointer];
267	1	$argPointer++;
268		}
269	7	}
270
271		/**
272		* @param $parsed
273		* @throws InvalidArgumentException
274		*/
275		private function fillInDefaults(&$parsed)
276		{
277	4	foreach($this->options as $option) {
278	4	if(!isset($parsed[$option['name']]) && isset($option['default']) && $option['command'] == ($parsed['__command'] ?? "")) {
279	4	$parsed[$option['name']] = $option['default'];
280		}
281		}
282	4	}
283
284		/**
285		* Parses command line arguments and return a structured array of options and their associated values.
286		*
287		* @param array $arguments An optional array of arguments that would be parsed instead of those passed to the CLI.
288		* @return array
289		* @throws InvalidValueException
290		*/
291		public function parse($arguments = null)
292		{
293		try{
294	7	global $argv;
		0 ignored issues – show Compatibility Best Practice introduced 2018-06-19 20:13 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
295	7	$arguments = $arguments ?? $argv;
296	7	$argPointer = 1;
297	7	$parsed = [];
298	7	$this->name = $this->name ?? $arguments[0];
299	7	$this->parseCommand($arguments, $argPointer, $parsed);
300	7	$this->parseArgumentArray($arguments, $argPointer, $parsed);
301	5	$this->maybeShowHelp($parsed);
302	4	$this->validator->validateArguments($this->options, $parsed);
303	4	$this->fillInDefaults($parsed);
304	4	return $parsed;
305	3	} catch (HelpMessageRequestedException $exception) {
306	1	$this->programControl->quit();
307	2	} catch (InvalidArgumentException $exception) {
308		print $exception->getMessage() . PHP_EOL;
309		$this->programControl->quit();
310		}
311	1	}
312
313		/**
314		* Enables help messages so they show automatically.
315		* This method also allows you to optionally pass the name of the application, a description header for the help
316		* message and a footer.
317		*
318		* @param string $name The name of the application binary
319		* @param string $description A description to be displayed on top of the help message
320		* @param string $footer A footer message to be displayed after the help message
321		*
322		* @throws InvalidArgumentDescriptionException
323		* @throws OptionExistsException
324		* @throws UnknownCommandException
325		*/
326		public function enableHelp(string $description = null, string $footer = null, string $name = null) : void
327		{
328	2	$this->name = $name;
329	2	$this->description = $description;
330	2	$this->footer = $footer;
331	2	$this->helpEnabled = true;
332	2	$this->addOption(['name' => 'help', 'short_name' => 'h', 'help' => "display this help message"]);
333	2	foreach($this->commands as $command) {
334	1	$this->addOption(['name' => 'help', 'help' => 'display this help message', 'command' => $command['name']]);
335		}
336	2	}
337
338		public function getHelpMessage($command = '')
339		{
340	2	return $this->helpGenerator->generate(
341	2	$this->name, $command ?? null,
342	2	['options' => $this->options, 'commands' => $this->commands],
343	2	$this->description, $this->footer
344		);
345		}
346
347		/**
348		* @param $command
349		* @throws CommandExistsException
350		* @throws InvalidArgumentDescriptionException
351		*/
352		public function addCommand($command)
353		{
354	5	$this->validator->validateCommand($command, $this->commands);
355	5	$this->commands[$command['name']] = $command;
356	5	}
357		}
358

ekowabaka / clearice

Push — master ( ba24d6...47edb6 )

ArgumentParser::parseArgumentArray() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like