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

Add new rule to add explicit public scope to unscoped class methods #2022

Merged
merged 3 commits into from
Apr 7, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?php

declare(strict_types=1);

namespace Rector\Tests\Visibility\Rector\ClassMethod\ExplicitPublicClassMethodRector;

use Iterator;
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
use Symplify\SmartFileSystem\SmartFileInfo;

final class ExplicitPublicClassMethodRectorTest extends AbstractRectorTestCase
{
/**
* @dataProvider provideData()
*/
public function test(SmartFileInfo $fileInfo): void
{
$this->doTestFileInfo($fileInfo);
}

/**
* @return Iterator<SmartFileInfo>
*/
public function provideData(): Iterator
{
return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
}

public function provideConfigFilePath(): string
{
return __DIR__ . '/config/configured_rule.php';
}
}

Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<?php

class SomeClass
{
function noExplicitVis()
{
$a = 3;
$closure = function ($b) use ($a) {
return $a + $b;
};
return $closure;
}

public function publicVis()
{
}

protected function protectedVis()
{
}

private function privateVis()
{
}
}

function notInScope()
{
}

?>
-----
<?php

class SomeClass
{
public function noExplicitVis()
{
$a = 3;
$closure = function ($b) use ($a) {
return $a + $b;
};
return $closure;
}

public function publicVis()
{
}

protected function protectedVis()
{
}

private function privateVis()
{
}
}

function notInScope()
{
}

?>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

declare(strict_types=1);

use Rector\Core\ValueObject\Visibility;
use Rector\Visibility\Rector\ClassMethod\ExplicitPublicClassMethodRector;
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;

return static function (ContainerConfigurator $containerConfigurator): void {
$services = $containerConfigurator->services();
$services->set(ExplicitPublicClassMethodRector::class);
};

Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<?php

declare(strict_types=1);

namespace Rector\Visibility\Rector\ClassMethod;

use PhpParser\Node;
use PhpParser\Node\Stmt\ClassMethod;
use Rector\Core\Rector\AbstractRector;
use Rector\Core\ValueObject\PhpVersionFeature;
use Rector\Privatization\NodeManipulator\VisibilityManipulator;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
* @see \Rector\Tests\Visibility\Rector\ClassMethod\ExplicitPublicClassMethodRector\ExplicitPublicClassMethodRectorTest
*/
final class ExplicitPublicClassMethodRector extends AbstractRector
{
public function __construct(
private readonly VisibilityManipulator $visibilityManipulator,
) {
}

public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition(
'Add explicit public method visibility.',
[
new CodeSample(
<<<'CODE_SAMPLE'
class SomeClass
{
function foo()
{
}
}
CODE_SAMPLE
,
<<<'CODE_SAMPLE'
class SomeClass
{
public function foo()
{
}
}
CODE_SAMPLE
),
]
);
}

/**
* @return array<class-string<Node>>
*/
public function getNodeTypes(): array
{
return [ClassMethod::class];
}

/**
* @param ClassConst $node
samsonasik marked this conversation as resolved.
Show resolved Hide resolved
*/
public function refactor(Node $node): ?Node
{
// already non-public
if (! $node->isPublic()) {
return null;
}

// explicitly public
if ($node->flags !== 0) {
Firehed marked this conversation as resolved.
Show resolved Hide resolved
return null;
}

$this->visibilityManipulator->makePublic($node);

return $node;
}
}