Issues in Parser.php - All Issues - Inspection of "Restore setting target dir" - phpDocumentor/phpDocumentor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( a89061...54507c )

by Jaap

created 2018-06-17 18:08 UTC

src/phpDocumentor/Application/Stage/Parser.php (3 issues)

Labels

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * This file is part of phpDocumentor.
 *
 *  For the full copyright and license information, please view the LICENSE
 *  file that was distributed with this source code.
 *
 *  @copyright 2010-2017 Mike van Riel<[email protected]>
 *  @license   http://www.opensource.org/licenses/mit-license.php MIT
 *  @link      http://phpdoc.org
 */

namespace phpDocumentor\Application\Stage;

use phpDocumentor\Descriptor\Cache\ProjectDescriptorMapper;
use phpDocumentor\Descriptor\ProjectDescriptor;
use phpDocumentor\Descriptor\ProjectDescriptorBuilder;
use phpDocumentor\DomainModel\Parser\FileCollector;
use phpDocumentor\Event\LogEvent;
use phpDocumentor\Parser\Parser as DocParser;
use phpDocumentor\Partials\Collection as PartialsCollection;
use phpDocumentor\Reflection\DocBlock\ExampleFinder;
use Psr\Log\LogLevel;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Zend\Cache\Storage\StorageInterface;

/**
 * Parses the given source code and creates a structure file.
 *
 * The parse task uses the source files defined either by -f or -d options and
 * generates a structure file (structure.xml) at the target location (which is
 * the folder 'output' unless the option -t is provided).
 */
final class Parser
{
    /** @var ProjectDescriptorBuilder $builder */
    private $builder;

    /** @var DocParser $parser */
    private $parser;

    /** @var StorageInterface */
    private $cache;

    /**
     * @var ExampleFinder
     */
    private $exampleFinder;

    /**
     * @var PartialsCollection
     */
    private $partials;

    /**
     * @var FileCollector
     */
    private $fileCollector;

    /**
     * @var EventDispatcherInterface
     */
    private $eventDispatcher;

    /**
     * ParseCommand constructor.
     */
    public function __construct(
        ProjectDescriptorBuilder $builder,
        DocParser $parser,
        FileCollector $fileCollector,
        StorageInterface $cache,
        ExampleFinder $exampleFinder,
        PartialsCollection $partials,
        EventDispatcherInterface $eventDispatcher
    ) {
        $this->builder = $builder;
        $this->parser = $parser;
        $this->cache = $cache;
        $this->exampleFinder = $exampleFinder;
        $this->partials = $partials;
        $this->fileCollector = $fileCollector;
        $this->eventDispatcher = $eventDispatcher;
    }

    private function getBuilder(): ProjectDescriptorBuilder
    {
        return $this->builder;
    }

    private function getParser(): DocParser
    {
        return $this->parser;
    }

    /**
     * Returns the Cache.
     *
     * @throws \InvalidArgumentException
     */
    private function getCache(): StorageInterface
    {
        return $this->cache;
    }

    /**
     * Executes the business logic involved with this command.
     *
     * @return array
     * @throws \Exception if the target location is not a folder.
     */
    public function __invoke(array $configuration)
    {
        //Grep only the first version for now. Multi version support will be added later
        $version = current($configuration['phpdocumentor']['versions']);

        //We are currently in the parser stage so grep the api config.
        //And for now we support a single api definition. Could be more in the future.
        $apiConfig = $version['api'][0];

        $parser = $this->getParser();
        $parser->setForced(!$configuration['phpdocumentor']['use-cache']);
        $parser->setEncoding($apiConfig['encoding']);
        $parser->setMarkers($apiConfig['markers']);
        $parser->setIgnoredTags($apiConfig['ignore-tags']);
        $parser->setValidate($apiConfig['validate']);
        $parser->setDefaultPackageName($apiConfig['default-package-name']);

        $builder = $this->getBuilder();
        $builder->createProjectDescriptor();
        $projectDescriptor = $builder->getProjectDescriptor();
        $projectDescriptor->setName($configuration['phpdocumentor']['title']);
        $projectDescriptor->setPartials($this->partials);

        $visibility = $this->getVisibility($apiConfig);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        $projectDescriptor->getSettings()->setVisibility($visibility);

        $mapper = new ProjectDescriptorMapper($this->getCache());

        if ($configuration['phpdocumentor']['use-cache']) {
            //TODO: Re-enable garbage collection here.
            //$mapper->garbageCollect($files);

            $mapper->populate($projectDescriptor);
        }

        //TODO: Should determine root based on filesystems. Could be an issue for multiple.
        // Need some config update here.
        $this->exampleFinder->setSourceDirectory(getcwd());
        $this->exampleFinder->setExampleDirectories(['.']);

        $this->log('PPCPP:LOG-COLLECTING');
        $files = $this->getFileCollection($apiConfig);
        $this->log('PPCPP:LOG-OK');
        $this->log('PPCPP:LOG-INITIALIZING');

        $this->log('PPCPP:LOG-OK');
        $this->log('PPCPP:LOG-PARSING');

        $parser->parse($builder, $files);

        $this->log('PPCPP:LOG-STORECACHE', LogLevel::INFO);
        $projectDescriptor->getSettings()->clearModifiedFlag();
        $mapper->save($projectDescriptor);
        $this->log('PPCPP:LOG-OK');

        return $configuration;
    }

    /**
     * Returns the collection of files based on the input and configuration.
     */
    private function getFileCollection(array $apiConfig): array
    {
        $ignorePaths = array_map(
            function ($value) {
                if (substr($value, -1) === '*') {
                    return substr($value, 0, -1);
                }

                return $value;
            },
            $apiConfig['ignore']['paths']
        );

        return $this->fileCollector->getFiles(
            $apiConfig['source']['dsn'],
            $apiConfig['source']['paths'],
            [
                'paths' => $ignorePaths,
                'hidden' => $apiConfig['ignore']['hidden'],
            ],
            $apiConfig['extensions']
        );
    }

    private function getVisibility(array $apiConfig): ?int
    {
        $visibilities = $apiConfig['visibility'];
        $visibility = null;
        foreach ($visibilities as $item) {
            switch ($item) {
                case 'public':
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
                    $visibility |= ProjectDescriptor\Settings::VISIBILITY_PUBLIC;
                    break;
                case 'protected':
                    $visibility |= ProjectDescriptor\Settings::VISIBILITY_PROTECTED;
                    break;
                case 'private':
                    $visibility |= ProjectDescriptor\Settings::VISIBILITY_PRIVATE;
                    break;
            }
        }
        return $visibility;
    }

    /**
     * Dispatches a logging request.
     *
     * @param string   $message  The message to log.
     * @param string   $priority The logging priority as declared in the LogLevel PSR-3 class.
     * @param string[] $parameters
     */
    private function log($message, $priority = LogLevel::INFO, $parameters = [])
    {
        $this->eventDispatcher->dispatch(
            'system.log',
            LogEvent::createInstance($this)
                ->setContext($parameters)
                ->setMessage($message)
                ->setPriority($priority)
        );
    }
}


1			<?php
2			/**
3			* This file is part of phpDocumentor.
4			*
5			* For the full copyright and license information, please view the LICENSE
6			* file that was distributed with this source code.
7			*
8			* @copyright 2010-2017 Mike van Riel<[email protected]>
9			* @license http://www.opensource.org/licenses/mit-license.php MIT
10			* @link http://phpdoc.org
11			*/
12
13			namespace phpDocumentor\Application\Stage;
14
15			use phpDocumentor\Descriptor\Cache\ProjectDescriptorMapper;
16			use phpDocumentor\Descriptor\ProjectDescriptor;
17			use phpDocumentor\Descriptor\ProjectDescriptorBuilder;
18			use phpDocumentor\DomainModel\Parser\FileCollector;
19			use phpDocumentor\Event\LogEvent;
20			use phpDocumentor\Parser\Parser as DocParser;
21			use phpDocumentor\Partials\Collection as PartialsCollection;
22			use phpDocumentor\Reflection\DocBlock\ExampleFinder;
23			use Psr\Log\LogLevel;
24			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
25			use Zend\Cache\Storage\StorageInterface;
26
27			/**
28			* Parses the given source code and creates a structure file.
29			*
30			* The parse task uses the source files defined either by -f or -d options and
31			* generates a structure file (structure.xml) at the target location (which is
32			* the folder 'output' unless the option -t is provided).
33			*/
34			final class Parser
35			{
36			/** @var ProjectDescriptorBuilder $builder */
37			private $builder;
38
39			/** @var DocParser $parser */
40			private $parser;
41
42			/** @var StorageInterface */
43			private $cache;
44
45			/**
46			* @var ExampleFinder
47			*/
48			private $exampleFinder;
49
50			/**
51			* @var PartialsCollection
52			*/
53			private $partials;
54
55			/**
56			* @var FileCollector
57			*/
58			private $fileCollector;
59
60			/**
61			* @var EventDispatcherInterface
62			*/
63			private $eventDispatcher;
64
65			/**
66			* ParseCommand constructor.
67			*/
68			public function __construct(
69			ProjectDescriptorBuilder $builder,
70			DocParser $parser,
71			FileCollector $fileCollector,
72			StorageInterface $cache,
73			ExampleFinder $exampleFinder,
74			PartialsCollection $partials,
75			EventDispatcherInterface $eventDispatcher
76			) {
77			$this->builder = $builder;
78			$this->parser = $parser;
79			$this->cache = $cache;
80			$this->exampleFinder = $exampleFinder;
81			$this->partials = $partials;
82			$this->fileCollector = $fileCollector;
83			$this->eventDispatcher = $eventDispatcher;
84			}
85
86			private function getBuilder(): ProjectDescriptorBuilder
87			{
88			return $this->builder;
89			}
90
91			private function getParser(): DocParser
92			{
93			return $this->parser;
94			}
95
96			/**
97			* Returns the Cache.
98			*
99			* @throws \InvalidArgumentException
100			*/
101			private function getCache(): StorageInterface
102			{
103			return $this->cache;
104			}
105
106			/**
107			* Executes the business logic involved with this command.
108			*
109			* @return array
110			* @throws \Exception if the target location is not a folder.
111			*/
112			public function __invoke(array $configuration)
113			{
114			//Grep only the first version for now. Multi version support will be added later
115			$version = current($configuration['phpdocumentor']['versions']);
116
117			//We are currently in the parser stage so grep the api config.
118			//And for now we support a single api definition. Could be more in the future.
119			$apiConfig = $version['api'][0];
120
121			$parser = $this->getParser();
122			$parser->setForced(!$configuration['phpdocumentor']['use-cache']);
123			$parser->setEncoding($apiConfig['encoding']);
124			$parser->setMarkers($apiConfig['markers']);
125			$parser->setIgnoredTags($apiConfig['ignore-tags']);
126			$parser->setValidate($apiConfig['validate']);
127			$parser->setDefaultPackageName($apiConfig['default-package-name']);
128
129			$builder = $this->getBuilder();
130			$builder->createProjectDescriptor();
131			$projectDescriptor = $builder->getProjectDescriptor();
132			$projectDescriptor->setName($configuration['phpdocumentor']['title']);
133			$projectDescriptor->setPartials($this->partials);
134
135			$visibility = $this->getVisibility($apiConfig);
			0 ignored issues – show Bug introduced 2018-04-29 12:48 UTC by Report Bug Copy Issue Report Show Similar Issues like this Are you sure the assignment to `$visibility` is correct as `$this->getVisibility($apiConfig)` (which targets `phpDocumentor\Applicatio...Parser::getVisibility()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
136			$projectDescriptor->getSettings()->setVisibility($visibility);
137
138			$mapper = new ProjectDescriptorMapper($this->getCache());
139
140			if ($configuration['phpdocumentor']['use-cache']) {
141			//TODO: Re-enable garbage collection here.
142			//$mapper->garbageCollect($files);
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-01-11 13:44 UTC by Report Bug Copy Issue Report Show Similar Issues like this `86%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
143			$mapper->populate($projectDescriptor);
144			}
145
146			//TODO: Should determine root based on filesystems. Could be an issue for multiple.
147			// Need some config update here.
148			$this->exampleFinder->setSourceDirectory(getcwd());
149			$this->exampleFinder->setExampleDirectories(['.']);
150
151			$this->log('PPCPP:LOG-COLLECTING');
152			$files = $this->getFileCollection($apiConfig);
153			$this->log('PPCPP:LOG-OK');
154			$this->log('PPCPP:LOG-INITIALIZING');
155
156			$this->log('PPCPP:LOG-OK');
157			$this->log('PPCPP:LOG-PARSING');
158
159			$parser->parse($builder, $files);
160
161			$this->log('PPCPP:LOG-STORECACHE', LogLevel::INFO);
162			$projectDescriptor->getSettings()->clearModifiedFlag();
163			$mapper->save($projectDescriptor);
164			$this->log('PPCPP:LOG-OK');
165
166			return $configuration;
167			}
168
169			/**
170			* Returns the collection of files based on the input and configuration.
171			*/
172			private function getFileCollection(array $apiConfig): array
173			{
174			$ignorePaths = array_map(
175			function ($value) {
176			if (substr($value, -1) === '*') {
177			return substr($value, 0, -1);
178			}
179
180			return $value;
181			},
182			$apiConfig['ignore']['paths']
183			);
184
185			return $this->fileCollector->getFiles(
186			$apiConfig['source']['dsn'],
187			$apiConfig['source']['paths'],
188			[
189			'paths' => $ignorePaths,
190			'hidden' => $apiConfig['ignore']['hidden'],
191			],
192			$apiConfig['extensions']
193			);
194			}
195
196			private function getVisibility(array $apiConfig): ?int
197			{
198			$visibilities = $apiConfig['visibility'];
199			$visibility = null;
200			foreach ($visibilities as $item) {
201			switch ($item) {
202			case 'public':
			0 ignored issues – show Coding Style introduced 2018-04-29 12:48 UTC by Report Bug Copy Issue Report Show Similar Issues like this `case` statements should be defined using a colon. As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next `break`. There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages. switch ($expr) { case "A": { //wrong doSomething(); break; } case "B"; //wrong doSomething(); break; case "C": //right doSomething(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
203			$visibility \|= ProjectDescriptor\Settings::VISIBILITY_PUBLIC;
204			break;
205			case 'protected':
206			$visibility \|= ProjectDescriptor\Settings::VISIBILITY_PROTECTED;
207			break;
208			case 'private':
209			$visibility \|= ProjectDescriptor\Settings::VISIBILITY_PRIVATE;
210			break;
211			}
212			}
213			return $visibility;
214			}
215
216			/**
217			* Dispatches a logging request.
218			*
219			* @param string $message The message to log.
220			* @param string $priority The logging priority as declared in the LogLevel PSR-3 class.
221			* @param string[] $parameters
222			*/
223			private function log($message, $priority = LogLevel::INFO, $parameters = [])
224			{
225			$this->eventDispatcher->dispatch(
226			'system.log',
227			LogEvent::createInstance($this)
228			->setContext($parameters)
229			->setMessage($message)
230			->setPriority($priority)
231			);
232			}
233			}
234

phpDocumentor / phpDocumentor

Push — develop ( a89061...54507c )

src/phpDocumentor/Application/Stage/Parser.php (3 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like