Psr0Fixer - Ignore filenames that are a reserved keyword or predefined constant #1541

SpacePossum · 2015-11-25T09:51:03Z

The PSR0 fixer should not try to fix files that are named a predefined constant or keyword,
like interface.php

SpacePossum · 2015-11-25T09:51:59Z

Symfony/CS/Fixer/PSR0/Psr0Fixer.php

@@ -161,6 +160,12 @@ public function supports(\SplFileInfo $file)
            return false;
        }

+        $tokens = token_get_all(sprintf('<?php %s', $filenameParts[0]));


if anyone knows a better way to check if a string is predefined constant or keyword in PHP, I'm happy to update :)

https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/1.11/Symfony/CS/Tokenizer/Token.php#L241 may be helpful

hmm afraid not so, it provides the [int] type/kind - [int] value, but I need to check against the string as used in the code itself.

In tests you have list of 65 keywords. but there is 66 keywords. They are listed in method I referred to.
Create similar method to check if token is predefined constant.

Then, leave here that tokenizer call (just change it to Tokens::fromCode and in if below check $tokens[1]->isKeyword() and your new method $tokens[1]->isPredefinedConstant()

👍
should these be added to the list of predefined constants or do you want those on PHP7 only http://php.net/manual/en/reserved.other-reserved-words.php ?
btw. the same checks added to the class should be done for (parts of) the namespace.

i think they should

SpacePossum · 2015-11-25T14:15:45Z

lets see what Travis thinks, http://php.net/manual/en/reserved.other-reserved-words.php is still a TODO

keradus · 2015-11-25T14:18:20Z

Symfony/CS/Tokenizer/Transformer/ArrayTypehint.php

@@ -28,8 +28,11 @@ public function process(Tokens $tokens)
    {
        foreach ($tokens->findGivenKind(T_ARRAY) as $index => $token) {
            $nextIndex = $tokens->getNextMeaningfulToken($index);
-            $nextToken = $tokens[$nextIndex];
+            if (null === $nextIndex) {
+                return;


when does this happen? new test is needed.

The PSR0 fixer generates <?php class array and ask the tokenizer for tokens of that code, then this will break down.

Can be tested by adding;

array( '<?php class array', array() ),

on line https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/1.11/Symfony/CS/Tests/Tokenizer/Transformer/ArrayTypehintTest.php#L38

how it behaves after https://github.com/FriendsOfPHP/PHP-CS-Fixer/pull/1541/files#r45877095 ?

kind of works, however 'CT_ARRAY_TYPEHINT' is not in https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/1.11/Symfony/CS/Tokenizer/Token.php#L247 so the psr0 test fails. Should the custom token not be in that list?

GrahamCampbell · 2015-11-25T16:02:02Z

I'd prefer to ignore all these cases on all PHP versions since we should be able to fix code that will run ok on later PHP versions.

SpacePossum · 2015-11-25T16:10:08Z

I'd prefer to ignore all these cases on all PHP versions since we should be able to fix code that will run ok on later PHP versions.

I prefer that as well, however since we don't know have the tokens kind constants on newer versions we cannot filter on those.

keradus · 2015-11-26T21:14:51Z

Please fix Travis

SpacePossum · 2015-11-27T10:56:38Z

all green now :)

keradus · 2015-11-27T11:07:37Z

Symfony/CS/Tokenizer/Token.php

@@ -367,6 +395,13 @@ public function isNativeConstant()
        return $this->isArray && in_array(strtolower($this->content), $nativeConstantStrings, true);
    }

+    public function isMagicConstant()


need to be tested

and documented

please see SpacePossum@6812475

Please add test for __class__. Should work, but I want to be sure. ;)

sure thing :)
SpacePossum@8573283
this way both lower and upper case for all magic constants are tested.. lets see what travis thinks..

keradus · 2015-11-27T16:33:44Z

👍

gharlan · 2015-11-27T17:33:47Z

Symfony/CS/Tests/Tokenizer/TokenTest.php

+    {
+        $this->assertFalse($this->getBraceToken()->isMagicConstant());
+        $token = new Token(array(T_CLASS_C, '__CLASS__'));
+        $this->assertTrue($token->isMagicConstant());


I would like to have the lowercase variant here, too.

Once that's done, 👍 from me.

added in SpacePossum@96a7ac9 with some more test cases.

keradus · 2015-11-29T16:30:22Z

Thank you @SpacePossum.

… predefined constant (SpacePossum) This PR was squashed before being merged into the 1.10 branch (closes #1541). Discussion ---------- Psr0Fixer - Ignore filenames that are a reserved keyword or predefined constant The PSR0 fixer should not try to fix files that are named a predefined constant or keyword, like `interface.php` Commits ------- 09777a8 Psr0Fixer - Ignore filenames that are a reserved keyword or predefined constant

SpacePossum reviewed Nov 25, 2015
View reviewed changes

keradus reviewed Nov 25, 2015
View reviewed changes

keradus added the kind/bug label Nov 27, 2015

keradus added this to the v1.10.3 milestone Nov 27, 2015

keradus reviewed Nov 27, 2015
View reviewed changes

gharlan reviewed Nov 27, 2015
View reviewed changes

SpacePossum added 2 commits November 28, 2015 21:59

Ignore filenames that are a reserved keyword or predefined constant.

5947c53

Add more tests, move private static method in class.

f528b73

GrahamCampbell mentioned this pull request Nov 28, 2015

Tag for Symfony@^3.0 #1553

Closed

keradus changed the title ~~Ignore filenames that are a reserved keyword or predefined constant.~~ Psr0Fixer - Ignore filenames that are a reserved keyword or predefined constant Nov 29, 2015

keradus closed this Nov 29, 2015

SpacePossum deleted the 1_10_bug_PR0_class_name_check branch January 25, 2016 16:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Psr0Fixer - Ignore filenames that are a reserved keyword or predefined constant #1541

Psr0Fixer - Ignore filenames that are a reserved keyword or predefined constant #1541

SpacePossum commented Nov 25, 2015

SpacePossum Nov 25, 2015

keradus Nov 25, 2015

SpacePossum Nov 25, 2015

keradus Nov 25, 2015

SpacePossum Nov 25, 2015

keradus Nov 25, 2015

SpacePossum commented Nov 25, 2015

keradus Nov 25, 2015

SpacePossum Nov 25, 2015

keradus Nov 25, 2015

SpacePossum Nov 25, 2015

keradus Nov 25, 2015

GrahamCampbell commented Nov 25, 2015

SpacePossum commented Nov 25, 2015

keradus commented Nov 26, 2015

SpacePossum commented Nov 27, 2015

keradus Nov 27, 2015

keradus Nov 27, 2015

SpacePossum Nov 27, 2015

gharlan Nov 27, 2015

SpacePossum Nov 27, 2015

keradus commented Nov 27, 2015

gharlan Nov 27, 2015

GrahamCampbell Nov 27, 2015

SpacePossum Nov 28, 2015

keradus commented Nov 29, 2015

Psr0Fixer - Ignore filenames that are a reserved keyword or predefined constant #1541

Psr0Fixer - Ignore filenames that are a reserved keyword or predefined constant #1541

Conversation

SpacePossum commented Nov 25, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SpacePossum commented Nov 25, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GrahamCampbell commented Nov 25, 2015

SpacePossum commented Nov 25, 2015

keradus commented Nov 26, 2015

SpacePossum commented Nov 27, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

keradus commented Nov 27, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

keradus commented Nov 29, 2015