Skip to content
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
2 changes: 2 additions & 0 deletions config/symfony-rules.neon
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ conditionalTags:
phpstan.rules.rule: %symplify.symfony%

services:
- Symplify\PHPStanRules\NodeAnalyzer\LaravelPresenceResolver

- Symplify\PHPStanRules\Rules\Symfony\SingleArgEventDispatchRule
- Symplify\PHPStanRules\Rules\Symfony\NoListenerWithoutContractRule
- Symplify\PHPStanRules\Rules\Symfony\NoStringInGetSubscribedEventsRule
Expand Down
25 changes: 25 additions & 0 deletions src/NodeAnalyzer/LaravelPresenceResolver.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?php

declare(strict_types=1);

namespace Symplify\PHPStanRules\NodeAnalyzer;

use PHPStan\Reflection\ReflectionProvider;

/**
* Detects a Laravel project, so Symfony-only rules can skip it.
*/
final readonly class LaravelPresenceResolver
{
private const string LARAVEL_APPLICATION_CLASS = 'Illuminate\Foundation\Application';

public function __construct(
private ReflectionProvider $reflectionProvider,
) {
}

public function isLaravelProject(): bool
{
return $this->reflectionProvider->hasClass(self::LARAVEL_APPLICATION_CLASS);
}
}
12 changes: 11 additions & 1 deletion src/Rules/Symfony/NoConstructorAndRequiredTogetherRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,22 @@
use PHPStan\Rules\RuleErrorBuilder;
use Symplify\PHPStanRules\Enum\MethodName;
use Symplify\PHPStanRules\Enum\RuleIdentifier\SymfonyRuleIdentifier;
use Symplify\PHPStanRules\NodeAnalyzer\LaravelPresenceResolver;

/**
* @implements Rule<Class_>
*
* @see \Symplify\PHPStanRules\Tests\Rules\Symfony\NoConstructorAndRequiredTogetherRule\NoConstructorAndRequiredTogetherRuleTest
*/
final class NoConstructorAndRequiredTogetherRule implements Rule
final readonly class NoConstructorAndRequiredTogetherRule implements Rule
{
public const string ERROR_MESSAGE = 'Avoid using __construct() and @required in the same class. Pick one to keep architecture clean';

public function __construct(
private LaravelPresenceResolver $laravelPresenceResolver,
) {
}

public function getNodeType(): string
{
return Class_::class;
Expand All @@ -34,6 +40,10 @@ public function getNodeType(): string
*/
public function processNode(Node $node, Scope $scope): array
{
if ($this->laravelPresenceResolver->isLaravelProject()) {
return [];
}

if ($node->isAnonymous()) {
return [];
}
Expand Down
12 changes: 11 additions & 1 deletion src/Rules/Symfony/NoListenerWithoutContractRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
use Symplify\PHPStanRules\Doctrine\DoctrineEventSubscriberAnalyzer;
use Symplify\PHPStanRules\Enum\RuleIdentifier\SymfonyRuleIdentifier;
use Symplify\PHPStanRules\Enum\SymfonyClass;
use Symplify\PHPStanRules\NodeAnalyzer\LaravelPresenceResolver;

/**
* Based on https://tomasvotruba.com/blog/2019/07/22/how-to-convert-listeners-to-subscribers-and-reduce-your-configs
Expand All @@ -24,10 +25,15 @@
*
* @see \Symplify\PHPStanRules\Tests\Rules\Symfony\NoListenerWithoutContractRule\NoListenerWithoutContractRuleTest
*/
final class NoListenerWithoutContractRule implements Rule
final readonly class NoListenerWithoutContractRule implements Rule
{
public const string ERROR_MESSAGE = 'There should be no listeners modified in config. Use EventSubscriberInterface contract or #[AsEventListener] attribute and native PHP instead';

public function __construct(
private LaravelPresenceResolver $laravelPresenceResolver,
) {
}

public function getNodeType(): string
{
return InClassNode::class;
Expand All @@ -38,6 +44,10 @@ public function getNodeType(): string
*/
public function processNode(Node $node, Scope $scope): array
{
if ($this->laravelPresenceResolver->isLaravelProject()) {
return [];
}

if (! $scope->isInClass()) {
return [];
}
Expand Down
6 changes: 6 additions & 0 deletions src/Rules/Symfony/NoNullableServiceInConstructorRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleErrorBuilder;
use Symplify\PHPStanRules\Enum\RuleIdentifier;
use Symplify\PHPStanRules\NodeAnalyzer\LaravelPresenceResolver;
use Throwable;

/**
Expand Down Expand Up @@ -63,6 +64,7 @@

public function __construct(
private ReflectionProvider $reflectionProvider,
private LaravelPresenceResolver $laravelPresenceResolver,
) {
}

Expand All @@ -78,6 +80,10 @@ public function getNodeType(): string
*/
public function processNode(Node $node, Scope $scope): array
{
if ($this->laravelPresenceResolver->isLaravelProject()) {
return [];
}

if ($node->name->toLowerString() !== '__construct') {
return [];
}
Expand Down
12 changes: 11 additions & 1 deletion src/Rules/Symfony/NoServiceJugglingRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
use PHPStan\Rules\RuleErrorBuilder;
use Symfony\Contracts\Service\Attribute\Required;
use Symplify\PHPStanRules\Enum\RuleIdentifier;
use Symplify\PHPStanRules\NodeAnalyzer\LaravelPresenceResolver;

/**
* A service injected in __construct() or an autowire*() method must not be handed over to another method call.
Expand All @@ -38,7 +39,7 @@
*
* @implements Rule<InClassNode>
*/
final class NoServiceJugglingRule implements Rule
final readonly class NoServiceJugglingRule implements Rule
{
public const string ERROR_MESSAGE = 'Service "$this->%s" is passed to "%s()" as an argument. Inject "%s" in the constructor of the class that uses it instead';

Expand All @@ -48,6 +49,11 @@ final class NoServiceJugglingRule implements Rule

private const string REQUIRED_ATTRIBUTE = Required::class;

public function __construct(
private LaravelPresenceResolver $laravelPresenceResolver,
) {
}

public function getNodeType(): string
{
return InClassNode::class;
Expand All @@ -60,6 +66,10 @@ public function getNodeType(): string
*/
public function processNode(Node $node, Scope $scope): array
{
if ($this->laravelPresenceResolver->isLaravelProject()) {
return [];
}

$classLike = $node->getOriginalNode();
if (! $classLike instanceof Class_) {
return [];
Expand Down
19 changes: 19 additions & 0 deletions tests/NodeAnalyzer/LaravelPresenceResolverTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?php

declare(strict_types=1);

namespace Symplify\PHPStanRules\Tests\NodeAnalyzer;

use PHPStan\Testing\PHPStanTestCase;
use Symplify\PHPStanRules\NodeAnalyzer\LaravelPresenceResolver;

final class LaravelPresenceResolverTest extends PHPStanTestCase
{
public function testNonLaravelProject(): void
{
$laravelPresenceResolver = new LaravelPresenceResolver($this->createReflectionProvider());

// Laravel is not installed here, so it must not be detected
$this->assertFalse($laravelPresenceResolver->isLaravelProject());
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
use PHPStan\Rules\Rule;
use PHPStan\Testing\RuleTestCase;
use PHPUnit\Framework\Attributes\DataProvider;
use Symplify\PHPStanRules\NodeAnalyzer\LaravelPresenceResolver;
use Symplify\PHPStanRules\Rules\Symfony\NoConstructorAndRequiredTogetherRule;

final class NoConstructorAndRequiredTogetherRuleTest extends RuleTestCase
Expand Down Expand Up @@ -39,6 +40,8 @@ public static function provideData(): Iterator

protected function getRule(): Rule
{
return new NoConstructorAndRequiredTogetherRule();
return new NoConstructorAndRequiredTogetherRule(
new LaravelPresenceResolver($this->createReflectionProvider())
);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
use PHPStan\Rules\Rule;
use PHPStan\Testing\RuleTestCase;
use PHPUnit\Framework\Attributes\DataProvider;
use Symplify\PHPStanRules\NodeAnalyzer\LaravelPresenceResolver;
use Symplify\PHPStanRules\Rules\Symfony\NoListenerWithoutContractRule;

final class NoListenerWithoutContractRuleTest extends RuleTestCase
Expand Down Expand Up @@ -46,6 +47,8 @@ public static function provideData(): Iterator

protected function getRule(): Rule
{
return new NoListenerWithoutContractRule();
return new NoListenerWithoutContractRule(
new LaravelPresenceResolver($this->createReflectionProvider())
);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
use PHPStan\Rules\Rule;
use PHPStan\Testing\RuleTestCase;
use PHPUnit\Framework\Attributes\DataProvider;
use Symplify\PHPStanRules\NodeAnalyzer\LaravelPresenceResolver;
use Symplify\PHPStanRules\Rules\Symfony\NoNullableServiceInConstructorRule;
use Symplify\PHPStanRules\Tests\Rules\Symfony\NoNullableServiceInConstructorRule\Source\AnotherService;
use Symplify\PHPStanRules\Tests\Rules\Symfony\NoNullableServiceInConstructorRule\Source\SomeService;
Expand Down Expand Up @@ -55,6 +56,9 @@ public static function provideData(): Iterator

protected function getRule(): Rule
{
return new NoNullableServiceInConstructorRule($this->createReflectionProvider());
return new NoNullableServiceInConstructorRule(
$this->createReflectionProvider(),
new LaravelPresenceResolver($this->createReflectionProvider())
);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
use PHPStan\Rules\Rule;
use PHPStan\Testing\RuleTestCase;
use PHPUnit\Framework\Attributes\DataProvider;
use Symplify\PHPStanRules\NodeAnalyzer\LaravelPresenceResolver;
use Symplify\PHPStanRules\Rules\Symfony\NoServiceJugglingRule;
use Symplify\PHPStanRules\Tests\Rules\Symfony\NoServiceJugglingRule\Source\SomeUserHelper;

Expand Down Expand Up @@ -48,6 +49,8 @@ public static function provideData(): Iterator

protected function getRule(): Rule
{
return new NoServiceJugglingRule();
return new NoServiceJugglingRule(
new LaravelPresenceResolver($this->createReflectionProvider())
);
}
}
Loading