Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Detect constants only used in tests #80

Merged
merged 3 commits into from
Jul 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions src/Collectors/ClassConstFetchCollector.php
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use PHPStan\Analyser\Scope;
use PHPStan\Collectors\Collector;
use PHPStan\Reflection\ClassReflection;
use TomasVotruba\UnusedPublic\ClassTypeDetector;
use TomasVotruba\UnusedPublic\Configuration;

/**
Expand All @@ -19,7 +20,8 @@
final class ClassConstFetchCollector implements Collector
{
public function __construct(
private readonly Configuration $configuration
private readonly Configuration $configuration,
private readonly ClassTypeDetector $classTypeDetector,
) {
}

Expand Down Expand Up @@ -50,14 +52,20 @@ public function processNode(Node $node, Scope $scope): ?array
$constantName = $node->name->toString();

$classReflection = $scope->getClassReflection();
if ($classReflection instanceof ClassReflection && $classReflection->hasConstant($constantName)) {
$constantReflection = $classReflection->getConstant($constantName);
$declaringClass = $constantReflection->getDeclaringClass();
if ($declaringClass->getFileName() !== $classReflection->getFileName()) {
return [$declaringClass->getName() . '::' . $constantName];
if ($classReflection instanceof ClassReflection) {
if ($this->classTypeDetector->isTestClass($classReflection)) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the added case

return null;
}

return null;
if ($classReflection->hasConstant($constantName)) {
$constantReflection = $classReflection->getConstant($constantName);
$declaringClass = $constantReflection->getDeclaringClass();
if ($declaringClass->getFileName() !== $classReflection->getFileName()) {
return [$declaringClass->getName() . '::' . $constantName];
}

return null;
}
}

return [$className . '::' . $constantName];
Expand Down
2 changes: 2 additions & 0 deletions src/Rules/LocalOnlyPublicClassMethodRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ final class LocalOnlyPublicClassMethodRule implements Rule
{
/**
* @var string
*
* @api
*/
public const ERROR_MESSAGE = 'Public method "%s::%s()" is used only locally and should be turned protected/private';

Expand Down
2 changes: 2 additions & 0 deletions src/Rules/UnusedPublicClassConstRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ final class UnusedPublicClassConstRule implements Rule
{
/**
* @var string
*
* @api
*/
public const ERROR_MESSAGE = 'Public constant "%s::%s" is never used';

Expand Down
2 changes: 2 additions & 0 deletions src/Rules/UnusedPublicClassMethodRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ final class UnusedPublicClassMethodRule implements Rule
{
/**
* @var string
*
* @api
*/
public const ERROR_MESSAGE = 'Public method "%s::%s()" is never used';

Expand Down
2 changes: 2 additions & 0 deletions src/Rules/UnusedPublicPropertyRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ final class UnusedPublicPropertyRule implements Rule
{
/**
* @var string
*
* @api
*/
public const ERROR_MESSAGE = 'Public property "%s::$%s" is never used';

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?php

declare(strict_types=1);

namespace TomasVotruba\UnusedPublic\Tests\Rules\UnusedPublicClassConstRule\Fixture;

final class UsedInTestCaseOnly
{
public const USE_ME = 'not here';
}
15 changes: 15 additions & 0 deletions tests/Rules/UnusedPublicClassConstRule/Source/TestCaseUser.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<?php

declare(strict_types=1);

namespace TomasVotruba\UnusedPublic\Tests\Rules\UnusedPublicClassConstRule\Fixture;

use PHPUnit\Framework\TestCase;

final class TestCaseUser extends TestCase
{
private function go()
{
$used = UsedInTestCaseOnly::USE_ME;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,12 @@
use TomasVotruba\UnusedPublic\Collectors\PublicClassLikeConstCollector;
use TomasVotruba\UnusedPublic\Enum\RuleTips;
use TomasVotruba\UnusedPublic\Rules\UnusedPublicClassConstRule;
use TomasVotruba\UnusedPublic\Rules\UnusedPublicClassMethodRule;
use TomasVotruba\UnusedPublic\Tests\Rules\UnusedPublicClassConstRule\Fixture\LocallyUsedPublicConstant;
use TomasVotruba\UnusedPublic\Tests\Rules\UnusedPublicClassConstRule\Fixture\LocallyUsedPublicConstantByName;
use TomasVotruba\UnusedPublic\Tests\Rules\UnusedPublicClassConstRule\Fixture\UnusedPublicConstant;
use TomasVotruba\UnusedPublic\Tests\Rules\UnusedPublicClassConstRule\Fixture\UnusedPublicConstantFromInterface;
use TomasVotruba\UnusedPublic\Tests\Rules\UnusedPublicClassMethodRule\Fixture\UsedInTestCaseOnly;

final class UnusedPublicClassConstRuleTest extends RuleTestCase
{
Expand Down Expand Up @@ -74,6 +76,13 @@ public static function provideData(): Iterator
];

yield [[__DIR__ . '/Fixture/SkipInterfaceConstantUsed.php', __DIR__ . '/Source/InterfaceConstantUser.php'], []];

$errorMessage = sprintf(UnusedPublicClassConstRule::ERROR_MESSAGE, Fixture\UsedInTestCaseOnly::class, 'USE_ME');
yield [[
__DIR__ . '/Fixture/UsedInTestCaseOnly.php',
__DIR__ . '/Source/TestCaseUser.php',
], [[$errorMessage, 9, RuleTips::SOLUTION_MESSAGE]]];

}

/**
Expand Down
Loading