-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add ShouldHaveOnlyOnePublicMethod rule
- Loading branch information
1 parent
8732c57
commit cf8fac1
Showing
9 changed files
with
207 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 10 additions & 0 deletions
10
src/Rule/Assertion/Declaration/ShouldHaveOnlyOnePublicMethod/HasOnlyOnePublicMethodRule.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
<?php | ||
|
||
namespace PHPat\Rule\Assertion\Declaration\ShouldHaveOnlyOnePublicMethod; | ||
|
||
use PHPat\Rule\Extractor\Declaration\OnePublicMethodExtractor; | ||
|
||
class HasOnlyOnePublicMethodRule extends ShouldHaveOnlyOnePublicMethod | ||
Check failure on line 7 in src/Rule/Assertion/Declaration/ShouldHaveOnlyOnePublicMethod/HasOnlyOnePublicMethodRule.php GitHub Actions / Architecture analysis (7.4, highest)
Check failure on line 7 in src/Rule/Assertion/Declaration/ShouldHaveOnlyOnePublicMethod/HasOnlyOnePublicMethodRule.php GitHub Actions / Architecture analysis (8.0, highest)
|
||
{ | ||
use OnePublicMethodExtractor; | ||
} |
41 changes: 41 additions & 0 deletions
41
...ule/Assertion/Declaration/ShouldHaveOnlyOnePublicMethod/ShouldHaveOnlyOnePublicMethod.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
<?php | ||
|
||
namespace PHPat\Rule\Assertion\Declaration\ShouldHaveOnlyOnePublicMethod; | ||
|
||
use PHPat\Configuration; | ||
use PHPat\Rule\Assertion\Declaration\DeclarationAssertion; | ||
use PHPat\Rule\Assertion\Declaration\ValidationTrait; | ||
use PHPat\Statement\Builder\StatementBuilderFactory; | ||
use PHPStan\Reflection\ClassReflection; | ||
use PHPStan\Reflection\ReflectionProvider; | ||
use PHPStan\Type\FileTypeMapper; | ||
|
||
abstract class ShouldHaveOnlyOnePublicMethod extends DeclarationAssertion | ||
{ | ||
use ValidationTrait; | ||
|
||
public function __construct( | ||
StatementBuilderFactory $statementBuilderFactory, | ||
Configuration $configuration, | ||
ReflectionProvider $reflectionProvider, | ||
FileTypeMapper $fileTypeMapper | ||
) { | ||
parent::__construct( | ||
__CLASS__, | ||
$statementBuilderFactory, | ||
$configuration, | ||
$reflectionProvider, | ||
$fileTypeMapper | ||
); | ||
} | ||
|
||
protected function applyValidation(string $ruleName, ClassReflection $subject, bool $meetsDeclaration, array $tips): array | ||
{ | ||
return $this->applyShould($ruleName, $subject, $meetsDeclaration, $tips); | ||
} | ||
|
||
protected function getMessage(string $ruleName, string $subject): string | ||
{ | ||
return $this->prepareMessage($ruleName, sprintf('%s should have only one public method', $subject)); | ||
} | ||
} |
29 changes: 29 additions & 0 deletions
29
src/Rule/Extractor/Declaration/OnePublicMethodExtractor.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
<?php declare(strict_types=1); | ||
|
||
namespace PHPat\Rule\Extractor\Declaration; | ||
|
||
use PhpParser\Node; | ||
use PHPStan\Analyser\Scope; | ||
use PHPStan\Node\InClassNode; | ||
use PHPStan\Reflection\MethodReflection; | ||
use ReflectionClass; | ||
use ReflectionMethod; | ||
|
||
trait OnePublicMethodExtractor | ||
{ | ||
public function getNodeType(): string | ||
{ | ||
return InClassNode::class; | ||
} | ||
|
||
/** | ||
* @param InClassNode $node | ||
*/ | ||
protected function meetsDeclaration(Node $node, Scope $scope): bool | ||
{ | ||
$reflectionClass = new ReflectionClass($node->getClassReflection()->getName()); | ||
$methods = $reflectionClass->getMethods(ReflectionMethod::IS_PUBLIC); | ||
|
||
return count($methods) === 1; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<?php declare(strict_types=1); | ||
|
||
namespace Tests\PHPat\fixtures\Special; | ||
|
||
class ClassWithOnePublicMethod | ||
{ | ||
public const CONSTANT = 'constant'; | ||
public string $property = 'property'; | ||
|
||
public function publicMethod(): bool { | ||
return true; | ||
} | ||
} |
49 changes: 49 additions & 0 deletions
49
tests/unit/rules/ShouldHaveOnlyOnePublicMethod/ClassWithOnlyOnePublicMethodTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
<?php | ||
|
||
namespace Tests\PHPat\unit\rules\ShouldHaveOnlyOnePublicMethod; | ||
|
||
use PHPat\Configuration; | ||
use PHPat\Rule\Assertion\Declaration\ShouldHaveOnlyOnePublicMethod\HasOnlyOnePublicMethodRule; | ||
use PHPat\Rule\Assertion\Declaration\ShouldHaveOnlyOnePublicMethod\ShouldHaveOnlyOnePublicMethod; | ||
use PHPat\Selector\Classname; | ||
use PHPat\Statement\Builder\StatementBuilderFactory; | ||
use PHPStan\Rules\Rule; | ||
use PHPStan\Testing\RuleTestCase; | ||
use PHPStan\Type\FileTypeMapper; | ||
use Tests\PHPat\fixtures\FixtureClass; | ||
use Tests\PHPat\unit\FakeTestParser; | ||
|
||
/** | ||
* @extends RuleTestCase<HasOnlyOnePublicMethodRule> | ||
* @internal | ||
* @coversNothing | ||
*/ | ||
class ClassWithOnlyOnePublicMethodTest extends RuleTestCase | ||
{ | ||
public const RULE_NAME = 'test_FixtureClassShouldHaveOnlyOnePublicMethod'; | ||
|
||
public function testRule(): void | ||
{ | ||
$this->analyse(['tests/fixtures/FixtureClass.php'], [ | ||
[sprintf('%s should have only one public method', FixtureClass::class), 29], | ||
]); | ||
} | ||
|
||
protected function getRule(): Rule | ||
{ | ||
$testParser = FakeTestParser::create( | ||
self::RULE_NAME, | ||
ShouldHaveOnlyOnePublicMethod::class, | ||
[new Classname(FixtureClass::class, false)], | ||
[] | ||
); | ||
|
||
return new HasOnlyOnePublicMethodRule( | ||
new StatementBuilderFactory($testParser), | ||
new Configuration(false, true, false), | ||
$this->createReflectionProvider(), | ||
self::getContainer()->getByType(FileTypeMapper::class) | ||
); | ||
} | ||
|
||
} |
48 changes: 48 additions & 0 deletions
48
...ules/ShouldHaveOnlyOnePublicMethod/GoodImplementationClassWithOnlyOnePublicMethodTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
<?php | ||
|
||
namespace Tests\PHPat\unit\rules\ShouldHaveOnlyOnePublicMethod; | ||
|
||
use PHPat\Configuration; | ||
use PHPat\Rule\Assertion\Declaration\ShouldHaveOnlyOnePublicMethod\HasOnlyOnePublicMethodRule; | ||
use PHPat\Rule\Assertion\Declaration\ShouldHaveOnlyOnePublicMethod\ShouldHaveOnlyOnePublicMethod; | ||
use PHPat\Selector\Classname; | ||
use PHPat\Statement\Builder\StatementBuilderFactory; | ||
use PHPStan\Rules\Rule; | ||
use PHPStan\Testing\RuleTestCase; | ||
use PHPStan\Type\FileTypeMapper; | ||
use Tests\PHPat\fixtures\FixtureClass; | ||
use Tests\PHPat\fixtures\Special\ClassWithOnePublicMethod; | ||
use Tests\PHPat\unit\FakeTestParser; | ||
|
||
/** | ||
* @extends RuleTestCase<HasOnlyOnePublicMethodRule> | ||
* @internal | ||
* @coversNothing | ||
*/ | ||
class GoodImplementationClassWithOnlyOnePublicMethodTest extends RuleTestCase | ||
{ | ||
public const RULE_NAME = 'test_FixtureClassShouldHaveOnlyOnePublicMethod'; | ||
|
||
public function testRule(): void | ||
{ | ||
$this->analyse(['tests/fixtures/Special/ClassWithOnePublicMethod.php'], []); | ||
} | ||
|
||
protected function getRule(): Rule | ||
{ | ||
$testParser = FakeTestParser::create( | ||
self::RULE_NAME, | ||
ShouldHaveOnlyOnePublicMethod::class, | ||
[new Classname(ClassWithOnePublicMethod::class, false)], | ||
[] | ||
); | ||
|
||
return new HasOnlyOnePublicMethodRule( | ||
new StatementBuilderFactory($testParser), | ||
new Configuration(false, true, false), | ||
$this->createReflectionProvider(), | ||
self::getContainer()->getByType(FileTypeMapper::class) | ||
); | ||
} | ||
|
||
} |