2022-03-22 10:24:31 +01:00
|
|
|
<?php declare(strict_types=1);
|
|
|
|
/*
|
|
|
|
* This file is part of phpunit/php-code-coverage.
|
|
|
|
*
|
|
|
|
* (c) Sebastian Bergmann <sebastian@phpunit.de>
|
|
|
|
*
|
|
|
|
* For the full copyright and license information, please view the LICENSE
|
|
|
|
* file that was distributed with this source code.
|
|
|
|
*/
|
|
|
|
namespace SebastianBergmann\CodeCoverage\StaticAnalysis;
|
|
|
|
|
|
|
|
use function array_merge;
|
2023-12-02 15:45:25 +01:00
|
|
|
use function assert;
|
2022-03-22 10:24:31 +01:00
|
|
|
use function range;
|
|
|
|
use function strpos;
|
|
|
|
use PhpParser\Node;
|
2023-12-02 15:45:25 +01:00
|
|
|
use PhpParser\Node\Attribute;
|
2022-03-22 10:24:31 +01:00
|
|
|
use PhpParser\Node\Stmt\Class_;
|
|
|
|
use PhpParser\Node\Stmt\ClassMethod;
|
|
|
|
use PhpParser\Node\Stmt\Function_;
|
|
|
|
use PhpParser\Node\Stmt\Interface_;
|
|
|
|
use PhpParser\Node\Stmt\Trait_;
|
|
|
|
use PhpParser\NodeVisitorAbstract;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage
|
|
|
|
*/
|
|
|
|
final class IgnoredLinesFindingVisitor extends NodeVisitorAbstract
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* @psalm-var list<int>
|
|
|
|
*/
|
|
|
|
private $ignoredLines = [];
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
private $useAnnotationsForIgnoringCode;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var bool
|
|
|
|
*/
|
|
|
|
private $ignoreDeprecated;
|
|
|
|
|
|
|
|
public function __construct(bool $useAnnotationsForIgnoringCode, bool $ignoreDeprecated)
|
|
|
|
{
|
|
|
|
$this->useAnnotationsForIgnoringCode = $useAnnotationsForIgnoringCode;
|
|
|
|
$this->ignoreDeprecated = $ignoreDeprecated;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function enterNode(Node $node): void
|
|
|
|
{
|
|
|
|
if (!$node instanceof Class_ &&
|
|
|
|
!$node instanceof Trait_ &&
|
|
|
|
!$node instanceof Interface_ &&
|
|
|
|
!$node instanceof ClassMethod &&
|
2023-12-02 15:45:25 +01:00
|
|
|
!$node instanceof Function_ &&
|
|
|
|
!$node instanceof Attribute) {
|
2022-03-22 10:24:31 +01:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($node instanceof Class_ && $node->isAnonymous()) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($node instanceof Class_ ||
|
|
|
|
$node instanceof Trait_ ||
|
2023-12-02 15:45:25 +01:00
|
|
|
$node instanceof Interface_ ||
|
|
|
|
$node instanceof Attribute) {
|
2022-03-22 10:24:31 +01:00
|
|
|
$this->ignoredLines[] = $node->getStartLine();
|
2023-12-02 15:45:25 +01:00
|
|
|
|
|
|
|
assert($node->name !== null);
|
|
|
|
|
|
|
|
// Workaround for https://github.com/nikic/PHP-Parser/issues/886
|
|
|
|
$this->ignoredLines[] = $node->name->getStartLine();
|
2022-03-22 10:24:31 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
if (!$this->useAnnotationsForIgnoringCode) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($node instanceof Interface_) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2023-12-02 15:45:25 +01:00
|
|
|
$this->processDocComment($node);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @psalm-return list<int>
|
|
|
|
*/
|
|
|
|
public function ignoredLines(): array
|
|
|
|
{
|
|
|
|
return $this->ignoredLines;
|
|
|
|
}
|
|
|
|
|
|
|
|
private function processDocComment(Node $node): void
|
|
|
|
{
|
2022-03-22 10:24:31 +01:00
|
|
|
$docComment = $node->getDocComment();
|
|
|
|
|
|
|
|
if ($docComment === null) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (strpos($docComment->getText(), '@codeCoverageIgnore') !== false) {
|
|
|
|
$this->ignoredLines = array_merge(
|
|
|
|
$this->ignoredLines,
|
|
|
|
range($node->getStartLine(), $node->getEndLine())
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($this->ignoreDeprecated && strpos($docComment->getText(), '@deprecated') !== false) {
|
|
|
|
$this->ignoredLines = array_merge(
|
|
|
|
$this->ignoredLines,
|
|
|
|
range($node->getStartLine(), $node->getEndLine())
|
|
|
|
);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|