Skip to content

[TypeDeclaration] Handle skipped by file path on DeclareStrictTypesRector due to use beforeTraverse() #5191

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.

Sign up for GitHub

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

Merged
TomasVotruba merged 4 commits into from
Oct 23, 2023
Merged

[TypeDeclaration] Handle skipped by file path on DeclareStrictTypesRector due to use beforeTraverse() #5191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6bc7356
[TypeDeclaration] Handle skipped by file path on DeclareStrictTypesRe…
samsonasik Oct 22, 2023
d841512
use .inc
samsonasik Oct 22, 2023
0b70440
use realpath
samsonasik Oct 22, 2023
e9d670e
Fixed :tada:
samsonasik Oct 22, 2023
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
7 changes: 7 additions & 0 deletions ...ation/Rector/StmtsAwareInterface/DeclareStrictTypesRector/Fixture/skipped_by_path.php.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?php

namespace Rector\Tests\TypeDeclaration\Rector\StmtsAwareInterface\DeclareStrictTypesRector\Fixture;

function skipped_by_path()
{
}
6 changes: 6 additions & 0 deletions ...eclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector/config/configured_rule.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,10 @@

return static function (RectorConfig $rectorConfig): void {
$rectorConfig->rule(DeclareStrictTypesRector::class);
$rectorConfig->skip([
DeclareStrictTypesRector::class => [
// .php.inc changed .php during running test
realpath(__DIR__ . '/../Fixture') . '/skipped_by_path.php',
],
]);
};
5 changes: 5 additions & 0 deletions rules/TypeDeclaration/Rector/StmtsAwareInterface/DeclareStrictTypesRector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ public function beforeTraverse(array $nodes): ?array
{
parent::beforeTraverse($nodes);

$filePath = $this->file->getFilePath();
if ($this->skipper->shouldSkipElementAndFilePath(self::class, $filePath)) {
return null;
}
Comment on lines 54 to +59
Copy link
Copy Markdown
Member

@TomasVotruba TomasVotruba Oct 23, 2023

Choose a reason for hiding this comment

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

This should be moved to AbstractRector::beforeTraverse() or similar, as rector rule itself should not decide about the sip.

Copy link
Copy Markdown
Member Author

@samsonasik samsonasik Oct 23, 2023

Choose a reason for hiding this comment

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

It can't, as AbstractRector::beforeTraverse() on setup File object, and re-called early in current parent::beforeTraverse(), moving to AbstractRector will require parent::beforeTraverse() to not called early, but after.

Copy link
Copy Markdown
Member

@TomasVotruba TomasVotruba Oct 23, 2023

Choose a reason for hiding this comment

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

I see. Let's go for it now then.
Bbut in case more rules will need the skip fix, we'll have to move it to single place outside specific rules.


$newStmts = $this->file->getNewStmts();

if ($newStmts === []) {
Expand Down
2 changes: 1 addition & 1 deletion src/Rector/AbstractRector.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ abstract class AbstractRector extends NodeVisitorAbstract implements RectorInter

private SimpleCallableNodeTraverser $simpleCallableNodeTraverser;

private Skipper $skipper;
protected Skipper $skipper;

private CurrentFileProvider $currentFileProvider;

Expand Down