BespokeDocBlockParser::processCommandTag() - Code Metrics - Inspection of "Remove phpdocumentor/reflection-docblock in favor..." - consolidation/annotated-command - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 07d3c8...3be31c )

by Greg

created 2017-10-13 21:44 UTC

BespokeDocBlockParser::processCommandTag() A

↳ Parent: BespokeDocBlockParser

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	6
nc	2
nop	1

<?php
namespace Consolidation\AnnotatedCommand\Parser\Internal;

use Consolidation\AnnotatedCommand\Parser\CommandInfo;
use Consolidation\AnnotatedCommand\Parser\DefaultsWithDescriptions;

/**
 * Given a class and method name, parse the annotations in the
 * DocBlock comment, and provide accessor methods for all of
 * the elements that are needed to create an annotated Command.
 */
class BespokeDocBlockParser
{
    protected $fqcnCache;

    /**
     * @var array
     */
    protected $tagProcessors = [
        'command' => 'processCommandTag',
        'name' => 'processCommandTag',
        'arg' => 'processArgumentTag',
        'param' => 'processArgumentTag',
        'return' => 'processReturnTag',
        'option' => 'processOptionTag',
        'default' => 'processDefaultTag',
        'aliases' => 'processAliases',
        'usage' => 'processUsageTag',
        'description' => 'processAlternateDescriptionTag',
        'desc' => 'processAlternateDescriptionTag',
    ];

    public function __construct(CommandInfo $commandInfo, \ReflectionMethod $reflection, $fqcnCache = null)
    {
        $this->commandInfo = $commandInfo;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->reflection = $reflection;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->fqcnCache = $fqcnCache ?: new FullyQualifiedClassCache();
    }

    /**
     * Parse the docBlock comment for this command, and set the
     * fields of this class with the data thereby obtained.
     */
    public function parse()
    {
        $doc = $this->reflection->getDocComment();
        $this->parseDocBlock($doc);
    }

    /**
     * Save any tag that we do not explicitly recognize in the
     * 'otherAnnotations' map.
     */
    protected function processGenericTag($tag)
    {
        $this->commandInfo->addAnnotation($tag->getTag(), $tag->getContent());
    }

    /**
     * Set the name of the command from a @command or @name annotation.
     */
    protected function processCommandTag($tag)
    {
        if (!$tag->hasWordAndDescription($matches)) {

            throw new \Exception('Could not determine command name from tag ' . (string)$tag);
        }
        $commandName = $matches['word'];
        $this->commandInfo->setName($commandName);
        // We also store the name in the 'other annotations' so that is is
        // possible to determine if the method had a @command annotation.
        $this->commandInfo->addAnnotation($tag->getTag(), $commandName);
    }

    /**
     * The @description and @desc annotations may be used in
     * place of the synopsis (which we call 'description').
     * This is discouraged.
     *
     * @deprecated
     */
    protected function processAlternateDescriptionTag($tag)
    {
        $this->commandInfo->setDescription($tag->getContent());
    }

    /**
     * Store the data from a @arg annotation in our argument descriptions.
     */
    protected function processArgumentTag($tag)

    {
        if (!$tag->hasVariable($matches)) {

            throw new \Exception('Could not determine argument name from tag ' . (string)$tag);
        }
        if ($matches['variable'] == $this->optionParamName()) {
            return;
        }
        $this->addOptionOrArgumentTag($tag, $this->commandInfo->arguments(), $matches['variable'], $matches['description']);
    }

    /**
     * Store the data from an @option annotation in our option descriptions.
     */
    protected function processOptionTag($tag)

    {
        if (!$tag->hasVariable($matches)) {

            throw new \Exception('Could not determine option name from tag ' . (string)$tag);
        }
        $this->addOptionOrArgumentTag($tag, $this->commandInfo->options(), $matches['variable'], $matches['description']);
    }

    protected function addOptionOrArgumentTag($tag, DefaultsWithDescriptions $set, $name, $description)

    {
        $variableName = $this->commandInfo->findMatchingOption($name);
        $description = static::removeLineBreaks($description);
        $set->add($variableName, $description);
    }

    /**
     * Store the data from a @default annotation in our argument or option store,
     * as appropriate.
     */
    protected function processDefaultTag($tag)
    {
        if (!$tag->hasVariable($matches)) {

            throw new \Exception('Could not determine parameter name for default value from tag ' . (string)$tag);
        }
        $variableName = $matches['variable'];
        $defaultValue = $this->interpretDefaultValue($matches['description']);
        if ($this->commandInfo->arguments()->exists($variableName)) {
            $this->commandInfo->arguments()->setDefaultValue($variableName, $defaultValue);
            return;
        }
        $variableName = $this->commandInfo->findMatchingOption($variableName);
        if ($this->commandInfo->options()->exists($variableName)) {
            $this->commandInfo->options()->setDefaultValue($variableName, $defaultValue);
        }
    }

    /**
     * Store the data from a @usage annotation in our example usage list.
     */
    protected function processUsageTag($tag)
    {
        $lines = explode("\n", $tag->getContent());
        $usage = trim(array_shift($lines));
        $description = static::removeLineBreaks(implode("\n", array_map(function ($line) {
            return trim($line);
        }, $lines)));

        $this->commandInfo->setExampleUsage($usage, $description);
    }

    /**
     * Process the comma-separated list of aliases
     */
    protected function processAliases($tag)
    {
        $this->commandInfo->setAliases((string)$tag->getContent());
    }

    /**
     * Store the data from a @return annotation in our argument descriptions.
     */
    protected function processReturnTag($tag)
    {
        // The return type might be a variable -- '$this'. It will
        // usually be a type, like RowsOfFields, or \Namespace\RowsOfFields.
        if (!$tag->hasVariableAndDescription($matches)) {

            throw new \Exception('Could not determine return type from tag ' . (string)$tag);
        }
        // Look at namespace and `use` statments to make returnType a fqdn
        $returnType = $matches['variable'];
        $returnType = $this->findFullyQualifiedClass($returnType);
        $this->commandInfo->setReturnType($returnType);
    }

    protected function findFullyQualifiedClass($className)
    {
        if (strpos($className, '\\') !== false) {
            return $className;
        }

        return $this->fqcnCache->qualify($this->reflection->getFileName(), $className);
    }

    private function parseDocBlock($doc)
    {
        // Remove the leading /** and the trailing */
        $doc = preg_replace('#^\s*/\*+\s*#', '', $doc);
        $doc = preg_replace('#\s*\*+/\s*#', '', $doc);

        // Nothing left? Exit.
        if (empty($doc)) {
            return;
        }

        $tagFactory = new TagFactory();
        $lines = [];

        foreach (explode("\n", $doc) as $row) {
            // Remove trailing whitespace and leading space + '*'s
            $row = rtrim($row);
            $row = preg_replace('#^[ \t]*\**#', '', $row);

            if (!$tagFactory->parseLine($row)) {
                $lines[] = $row;
            }
        }

        $this->processDescriptionAndHelp($lines);
        $this->processAllTags($tagFactory->getTags());
    }

    protected function processDescriptionAndHelp($lines)
    {
        // Trim all of the lines individually.
        $lines =
            array_map(
                function ($line) {
                    return trim($line);
                },
                $lines
            );

        // Everything up to the first blank line goes in the description.
        $description = array_shift($lines);
        while ($this->nextLineIsNotEmpty($lines)) {
            $description .= ' ' . array_shift($lines);
        }

        // Everything else goes in the help.
        $help = trim(implode("\n", $lines));

        $this->commandInfo->setDescription($description);
        $this->commandInfo->setHelp($help);
    }

    protected function nextLineIsNotEmpty($lines)
    {
        if (empty($lines)) {
            return false;
        }

        $nextLine = trim($lines[0]);
        return !empty($nextLine);
    }

    protected function processAllTags($tags)
    {
        // Iterate over all of the tags, and process them as necessary.
        foreach ($tags as $tag) {
            $processFn = [$this, 'processGenericTag'];
            if (array_key_exists($tag->getTag(), $this->tagProcessors)) {
                $processFn = [$this, $this->tagProcessors[$tag->getTag()]];
            }
            $processFn($tag);
        }
    }

    protected function lastParameterName()
    {
        $params = $this->commandInfo->getParameters();
        $param = end($params);
        if (!$param) {
            return '';
        }
        return $param->name;
    }

    /**
     * Return the name of the last parameter if it holds the options.
     */
    public function optionParamName()
    {
        // Remember the name of the last parameter, if it holds the options.
        // We will use this information to ignore @param annotations for the options.
        if (!isset($this->optionParamName)) {
            $this->optionParamName = '';
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $options = $this->commandInfo->options();
            if (!$options->isEmpty()) {
                $this->optionParamName = $this->lastParameterName();
            }
        }

        return $this->optionParamName;
    }

    protected function interpretDefaultValue($defaultValue)
    {
        $defaults = [
            'null' => null,
            'true' => true,
            'false' => false,
            "''" => '',
            '[]' => [],
        ];
        foreach ($defaults as $defaultName => $defaultTypedValue) {
            if ($defaultValue == $defaultName) {
                return $defaultTypedValue;
            }
        }
        return $defaultValue;
    }

    /**
     * Given a list that might be 'a b c' or 'a, b, c' or 'a,b,c',
     * convert the data into the last of these forms.
     */
    protected static function convertListToCommaSeparated($text)
    {
        return preg_replace('#[ \t\n\r,]+#', ',', $text);
    }

    /**
     * Take a multiline description and convert it into a single
     * long unbroken line.
     */
    protected static function removeLineBreaks($text)
    {
        return trim(preg_replace('#[ \t\n\r]+#', ' ', $text));
    }
}


1		<?php
2		namespace Consolidation\AnnotatedCommand\Parser\Internal;
3
4		use Consolidation\AnnotatedCommand\Parser\CommandInfo;
5		use Consolidation\AnnotatedCommand\Parser\DefaultsWithDescriptions;
6
7		/**
8		* Given a class and method name, parse the annotations in the
9		* DocBlock comment, and provide accessor methods for all of
10		* the elements that are needed to create an annotated Command.
11		*/
12		class BespokeDocBlockParser
13		{
14		protected $fqcnCache;
15
16		/**
17		* @var array
18		*/
19		protected $tagProcessors = [
20		'command' => 'processCommandTag',
21		'name' => 'processCommandTag',
22		'arg' => 'processArgumentTag',
23		'param' => 'processArgumentTag',
24		'return' => 'processReturnTag',
25		'option' => 'processOptionTag',
26		'default' => 'processDefaultTag',
27		'aliases' => 'processAliases',
28		'usage' => 'processUsageTag',
29		'description' => 'processAlternateDescriptionTag',
30		'desc' => 'processAlternateDescriptionTag',
31		];
32
33		public function __construct(CommandInfo $commandInfo, \ReflectionMethod $reflection, $fqcnCache = null)
34		{
35		$this->commandInfo = $commandInfo;
		0 ignored issues – show Bug introduced 2017-10-12 23:17 UTC by Report Bug Copy Issue Report The property `commandInfo` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
36		$this->reflection = $reflection;
		0 ignored issues – show Bug introduced 2017-10-12 23:17 UTC by Report Bug Copy Issue Report The property `reflection` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
37		$this->fqcnCache = $fqcnCache ?: new FullyQualifiedClassCache();
38		}
39
40		/**
41		* Parse the docBlock comment for this command, and set the
42		* fields of this class with the data thereby obtained.
43		*/
44		public function parse()
45		{
46		$doc = $this->reflection->getDocComment();
47		$this->parseDocBlock($doc);
48		}
49
50		/**
51		* Save any tag that we do not explicitly recognize in the
52		* 'otherAnnotations' map.
53		*/
54		protected function processGenericTag($tag)
55		{
56		$this->commandInfo->addAnnotation($tag->getTag(), $tag->getContent());
57		}
58
59		/**
60		* Set the name of the command from a @command or @name annotation.
61		*/
62		protected function processCommandTag($tag)
63		{
64		if (!$tag->hasWordAndDescription($matches)) {
		0 ignored issues – show Bug introduced 2017-10-12 20:03 UTC by Report Bug Copy Issue Report The variable `$matches` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
65		throw new \Exception('Could not determine command name from tag ' . (string)$tag);
66		}
67		$commandName = $matches['word'];
68		$this->commandInfo->setName($commandName);
69		// We also store the name in the 'other annotations' so that is is
70		// possible to determine if the method had a @command annotation.
71		$this->commandInfo->addAnnotation($tag->getTag(), $commandName);
72		}
73
74		/**
75		* The @description and @desc annotations may be used in
76		* place of the synopsis (which we call 'description').
77		* This is discouraged.
78		*
79		* @deprecated
80		*/
81		protected function processAlternateDescriptionTag($tag)
82		{
83		$this->commandInfo->setDescription($tag->getContent());
84		}
85
86		/**
87		* Store the data from a @arg annotation in our argument descriptions.
88		*/
89	View Code Duplication	protected function processArgumentTag($tag)
		0 ignored issues – show Duplication introduced 2017-10-12 23:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
90		{
91		if (!$tag->hasVariable($matches)) {
		0 ignored issues – show Bug introduced 2017-10-12 23:17 UTC by Report Bug Copy Issue Report The variable `$matches` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
92		throw new \Exception('Could not determine argument name from tag ' . (string)$tag);
93		}
94		if ($matches['variable'] == $this->optionParamName()) {
95		return;
96		}
97		$this->addOptionOrArgumentTag($tag, $this->commandInfo->arguments(), $matches['variable'], $matches['description']);
98		}
99
100		/**
101		* Store the data from an @option annotation in our option descriptions.
102		*/
103	View Code Duplication	protected function processOptionTag($tag)
		0 ignored issues – show Duplication introduced 2017-10-12 23:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
104		{
105		if (!$tag->hasVariable($matches)) {
		0 ignored issues – show Bug introduced 2017-10-12 23:17 UTC by Report Bug Copy Issue Report The variable `$matches` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
106		throw new \Exception('Could not determine option name from tag ' . (string)$tag);
107		}
108		$this->addOptionOrArgumentTag($tag, $this->commandInfo->options(), $matches['variable'], $matches['description']);
109		}
110
111		protected function addOptionOrArgumentTag($tag, DefaultsWithDescriptions $set, $name, $description)
		0 ignored issues – show Unused Code introduced 2017-10-12 23:17 UTC by Report Bug Copy Issue Report The parameter `$tag` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
112		{
113		$variableName = $this->commandInfo->findMatchingOption($name);
114		$description = static::removeLineBreaks($description);
115		$set->add($variableName, $description);
116		}
117
118		/**
119		* Store the data from a @default annotation in our argument or option store,
120		* as appropriate.
121		*/
122		protected function processDefaultTag($tag)
123		{
124		if (!$tag->hasVariable($matches)) {
		0 ignored issues – show Bug introduced 2017-10-13 19:21 UTC by Report Bug Copy Issue Report The variable `$matches` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
125		throw new \Exception('Could not determine parameter name for default value from tag ' . (string)$tag);
126		}
127		$variableName = $matches['variable'];
128		$defaultValue = $this->interpretDefaultValue($matches['description']);
129		if ($this->commandInfo->arguments()->exists($variableName)) {
130		$this->commandInfo->arguments()->setDefaultValue($variableName, $defaultValue);
131		return;
132		}
133		$variableName = $this->commandInfo->findMatchingOption($variableName);
134		if ($this->commandInfo->options()->exists($variableName)) {
135		$this->commandInfo->options()->setDefaultValue($variableName, $defaultValue);
136		}
137		}
138
139		/**
140		* Store the data from a @usage annotation in our example usage list.
141		*/
142		protected function processUsageTag($tag)
143		{
144		$lines = explode("\n", $tag->getContent());
145		$usage = trim(array_shift($lines));
146		$description = static::removeLineBreaks(implode("\n", array_map(function ($line) {
147		return trim($line);
148		}, $lines)));
149
150		$this->commandInfo->setExampleUsage($usage, $description);
151		}
152
153		/**
154		* Process the comma-separated list of aliases
155		*/
156		protected function processAliases($tag)
157		{
158		$this->commandInfo->setAliases((string)$tag->getContent());
159		}
160
161		/**
162		* Store the data from a @return annotation in our argument descriptions.
163		*/
164		protected function processReturnTag($tag)
165		{
166		// The return type might be a variable -- '$this'. It will
167		// usually be a type, like RowsOfFields, or \Namespace\RowsOfFields.
168		if (!$tag->hasVariableAndDescription($matches)) {
		0 ignored issues – show Bug introduced 2017-10-13 19:29 UTC by Report Bug Copy Issue Report The variable `$matches` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
169		throw new \Exception('Could not determine return type from tag ' . (string)$tag);
170		}
171		// Look at namespace and `use` statments to make returnType a fqdn
172		$returnType = $matches['variable'];
173		$returnType = $this->findFullyQualifiedClass($returnType);
174		$this->commandInfo->setReturnType($returnType);
175		}
176
177		protected function findFullyQualifiedClass($className)
178		{
179		if (strpos($className, '\\') !== false) {
180		return $className;
181		}
182
183		return $this->fqcnCache->qualify($this->reflection->getFileName(), $className);
184		}
185
186		private function parseDocBlock($doc)
187		{
188		// Remove the leading /** and the trailing */
189		$doc = preg_replace('#^\s/\+\s*#', '', $doc);
190		$doc = preg_replace('#\s\+/\s*#', '', $doc);
191
192		// Nothing left? Exit.
193		if (empty($doc)) {
194		return;
195		}
196
197		$tagFactory = new TagFactory();
198		$lines = [];
199
200		foreach (explode("\n", $doc) as $row) {
201		// Remove trailing whitespace and leading space + '*'s
202		$row = rtrim($row);
203		$row = preg_replace('#^[ \t]\*#', '', $row);
204
205		if (!$tagFactory->parseLine($row)) {
206		$lines[] = $row;
207		}
208		}
209
210		$this->processDescriptionAndHelp($lines);
211		$this->processAllTags($tagFactory->getTags());
212		}
213
214		protected function processDescriptionAndHelp($lines)
215		{
216		// Trim all of the lines individually.
217		$lines =
218		array_map(
219		function ($line) {
220		return trim($line);
221		},
222		$lines
223		);
224
225		// Everything up to the first blank line goes in the description.
226		$description = array_shift($lines);
227		while ($this->nextLineIsNotEmpty($lines)) {
228		$description .= ' ' . array_shift($lines);
229		}
230
231		// Everything else goes in the help.
232		$help = trim(implode("\n", $lines));
233
234		$this->commandInfo->setDescription($description);
235		$this->commandInfo->setHelp($help);
236		}
237
238		protected function nextLineIsNotEmpty($lines)
239		{
240		if (empty($lines)) {
241		return false;
242		}
243
244		$nextLine = trim($lines[0]);
245		return !empty($nextLine);
246		}
247
248		protected function processAllTags($tags)
249		{
250		// Iterate over all of the tags, and process them as necessary.
251		foreach ($tags as $tag) {
252		$processFn = [$this, 'processGenericTag'];
253		if (array_key_exists($tag->getTag(), $this->tagProcessors)) {
254		$processFn = [$this, $this->tagProcessors[$tag->getTag()]];
255		}
256		$processFn($tag);
257		}
258		}
259
260		protected function lastParameterName()
261		{
262		$params = $this->commandInfo->getParameters();
263		$param = end($params);
264		if (!$param) {
265		return '';
266		}
267		return $param->name;
268		}
269
270		/**
271		* Return the name of the last parameter if it holds the options.
272		*/
273		public function optionParamName()
274		{
275		// Remember the name of the last parameter, if it holds the options.
276		// We will use this information to ignore @param annotations for the options.
277		if (!isset($this->optionParamName)) {
278		$this->optionParamName = '';
		0 ignored issues – show Bug introduced 2017-10-12 23:17 UTC by Report Bug Copy Issue Report The property `optionParamName` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
279		$options = $this->commandInfo->options();
280		if (!$options->isEmpty()) {
281		$this->optionParamName = $this->lastParameterName();
282		}
283		}
284
285		return $this->optionParamName;
286		}
287
288		protected function interpretDefaultValue($defaultValue)
289		{
290		$defaults = [
291		'null' => null,
292		'true' => true,
293		'false' => false,
294		"''" => '',
295		'[]' => [],
296		];
297		foreach ($defaults as $defaultName => $defaultTypedValue) {
298		if ($defaultValue == $defaultName) {
299		return $defaultTypedValue;
300		}
301		}
302		return $defaultValue;
303		}
304
305		/**
306		* Given a list that might be 'a b c' or 'a, b, c' or 'a,b,c',
307		* convert the data into the last of these forms.
308		*/
309		protected static function convertListToCommaSeparated($text)
310		{
311		return preg_replace('#[ \t\n\r,]+#', ',', $text);
312		}
313
314		/**
315		* Take a multiline description and convert it into a single
316		* long unbroken line.
317		*/
318		protected static function removeLineBreaks($text)
319		{
320		return trim(preg_replace('#[ \t\n\r]+#', ' ', $text));
321		}
322		}
323

consolidation / annotated-command

Push — master ( 07d3c8...3be31c )

BespokeDocBlockParser::processCommandTag() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like