HeaderCommentFixer - support monolithic files with shebang

[kubawerlos]

Such as dev-tools/composer-alias-update.php and dev-tools/info-extractor.php.

[coveralls]

Coverage increased (+0.001%) to 93.15% when pulling 6af55ed on werlos:HeaderCommentFixer_support_non_monolitic_files into 333f15e on FriendsOfPHP:master.

[keradus]

@kubawerlos , do I understand right that you don't want to support all non-monolithic files, but support monolithic scripts that are having a shebang?

[kubawerlos]

@kubawerlos , do I understand right that you don't want to support all non-monolithic files, but support monolithic scripts that are having a shebang?

@keradus well I might named the PR wrong, I meant to support what is changed in isCandidate here:

1 === $tokens->countTokenKind(T_OPEN_TAG);

and actually it could be exactly what Tokens::isMonolithicPhp is checking, which would mean removing this: $tokens[0]->isGivenKind(T_OPEN_TAG) part - that way with this PR all monolithic files would be supported, inclduding "monolithic scripts that are having a shebang".

[keradus]

let's change the name of PR then, as we are still not supporting all non-monolithic files (and we shouldn't)

Why not changing the implementation of isMonolithic then, instead of changing isCandidate of single rule?

[SpacePossum]

In theory, a file like the following is not monolithic:

some leading text that is echo'd and not a hash/shebang

<?php   // single PHP open tag
echo 123;

as such keeping the method to detect it stating it is not monolithic seems good to me.
For the header fixer to start fixing files like that is good to me (might be a nice test to add),
even though the intended candidate would be like:

#!/usr/bin/env php
<?php

echo 1;

I think it was HHVM that would tokenize a hashbang to a different type than an T_INLINE_HTML, but PHP doesn't.

Since for us here we only care about this for the header fixer I'm +1 as PHP templates are rare and templates not starting an open tag even more rare.

[keradus]

I believe we should:

fix regular files

<?php

echo 1;

fix scripts with shebang:

#!/usr/bin/env php
<?php

echo 1;

NOT fix non-monolithic and non-script files, eg

foo bar
<?PHP
echo "baz"

<?PHP
echo "foo bar"
?>
baz

[keradus]

let's update isMonolithic instead?
#6199 (comment)

[kubawerlos]

Let's merge this cleanup first: #6229 and then have a discussion how to update isMonolithic properly - I've already pushed the changes, but it seems a bit naive solution: https://github.com/werlos/PHP-CS-Fixer/compare/simplify_Tokens_isMonolithicPhp_tests...werlos:update_Tokens_isMonolithicPhp and I believe deserves separate PR.

Then we will continue this one.

[keradus]

let's force-squash during merging

[SpacePossum]

Thank you @kubawerlos.