minor PHP-CS-Fixer#2306 DeclareStrictTypesFixer - do not move tokens (SpacePossum)

This PR was merged into the 2.0-dev branch.

Discussion
----------

DeclareStrictTypesFixer - do not move tokens

This is step one to resolve the "file opening fixing" conflict we have with the current fixers.
With this PR the DeclareStrictTypesFixer will:
- insert the sequence if not found, and fix the white space around the new sequence
- fix the casing of 'strict_types=1' (as we have no other fixer for it, nor would it be useful ATM to split this functionality IMO)

It will no longer:
- move an existing sequence
- fix white around an existing sequence or within such sequence
- fix the code style of an existing sequence (with a small exception, see above)

So with a bit of pain in my heart.. here we go  ;)

Commits
-------

8ed737f DeclareStrictTypesFixer - do not move tokens

Author: keradus

src/Fixer/Strict/DeclareStrictTypesFixer.php

@@ -44,39 +44,15 @@ public function fix(\SplFileInfo $file, Tokens $tokens)
             return;
         }
 
-        // check if the declaration is at the right location
-        reset($sequenceLocation);
-        $sequenceStartIndex = key($sequenceLocation);
-
-        end($sequenceLocation);
-        $sequenceEndIndex = $tokens->getNextMeaningfulToken(key($sequenceLocation));
-
-        if (1 === $sequenceStartIndex) {
-            // declaration already at the correct location, fix spacing only
-            $this->fixWhiteSpaceAroundSequence($tokens, $sequenceEndIndex);
-
-            return;
-        }
-
-        // Handle end of statement of the sequence; i.e. semicolon vs. close tag. Remove a semicolon as well,
-        // but don't remove a close tag since comment placement might cause invalid code to be created.
-        if (!$tokens[$sequenceEndIndex]->isGivenKind(T_CLOSE_TAG)) {
-            $sequenceLocation[$sequenceEndIndex] = $tokens[$sequenceEndIndex];
-        }
-
-        foreach ($sequenceLocation as $index => $token) {
-            $tokens->clearTokenAndMergeSurroundingWhitespace($index);
-        }
-
-        $this->insertSequence($tokens);
+        $this->fixStrictTypesCasing($tokens, $sequenceLocation);
     }
 
     /**
      * {@inheritdoc}
      */
     public function getPriority()
     {
-        // must ran before SingleBlankLineBeforeNamespaceFixer, NoBlankLinesBeforeNamespaceFixer, NoExtraConsecutiveBlankLinesFixer, NoWhitespaceInBlankLinesFixer
+        // must ran before SingleBlankLineBeforeNamespaceFixer.
         return 1;
     }
 
@@ -104,38 +80,6 @@ protected function getDescription()
         return 'Force strict types declaration in all files.';
     }
 
-    /**
-     * @param Tokens $tokens
-     * @param int    $endIndex
-     */
-    private function fixWhiteSpaceAroundSequence(Tokens $tokens, $endIndex)
-    {
-        $lineEnding = $this->whitespacesConfig->getLineEnding();
-
-        // start index of the sequence is always 1 here, 0 is always open tag
-        // transform "<?php\n" to "<?php " if needed
-        if (false !== strpos($tokens[0]->getContent(), "\n")) {
-            $tokens[0]->setContent(trim($tokens[0]->getContent()).' ');
-        }
-
-        if ($endIndex === count($tokens) - 1) {
-            return; // no more tokens afters sequence, single_blank_line_at_eof might add a line
-        }
-
-        if (!$tokens[1 + $endIndex]->isWhitespace()) {
-            $tokens->insertAt(1 + $endIndex, new Token(array(T_WHITESPACE, $lineEnding)));
-
-            return;
-        }
-
-        $content = $tokens[1 + $endIndex]->getContent();
-        if (false !== strpos($content, "\n")) {
-            return;
-        }
-
-        $tokens[1 + $endIndex]->setContent($lineEnding.ltrim($content));
-    }
-
     /**
      * @return Token[]
      */
@@ -162,13 +106,52 @@ private function getDeclareStrictTypeSequence()
     }
 
     /**
-     * @param Tokens $tokens
+     * @param Tokens            $tokens
+     * @param array<int, Token> $sequence
      */
+    private function fixStrictTypesCasing(Tokens $tokens, array $sequence)
+    {
+        /** @var int $index */
+        /** @var Token $token */
+        foreach ($sequence as $index => $token) {
+            if ($token->isGivenKind(T_STRING)) {
+                $tokens[$index]->setContent(strtolower($token->getContent()));
+
+                break;
+            }
+        }
+    }
+
     private function insertSequence(Tokens $tokens)
     {
         $sequence = $this->getDeclareStrictTypeSequence();
         $sequence[] = new Token(';');
+        $endIndex = count($sequence);
+
         $tokens->insertAt(1, $sequence);
-        $this->fixWhiteSpaceAroundSequence($tokens, count($sequence));
+
+        // start index of the sequence is always 1 here, 0 is always open tag
+        // transform "<?php\n" to "<?php " if needed
+        if (false !== strpos($tokens[0]->getContent(), "\n")) {
+            $tokens[0]->setContent(trim($tokens[0]->getContent()).' ');
+        }
+
+        if ($endIndex === count($tokens) - 1) {
+            return; // no more tokens afters sequence, single_blank_line_at_eof might add a line
+        }
+
+        $lineEnding = $this->whitespacesConfig->getLineEnding();
+        if (!$tokens[1 + $endIndex]->isWhitespace()) {
+            $tokens->insertAt(1 + $endIndex, new Token(array(T_WHITESPACE, $lineEnding)));
+
+            return;
+        }
+
+        $content = $tokens[1 + $endIndex]->getContent();
+        if (false !== strpos($content, "\n")) {
+            return;
+        }
+
+        $tokens[1 + $endIndex]->setContent($lineEnding.ltrim($content));
     }
 }

tests/Fixer/Strict/DeclareStrictTypesFixerTest.php

@@ -17,6 +17,8 @@
 
 /**
  * @internal
+ *
+ * @author SpacePossum
  */
 final class DeclareStrictTypesFixerTest extends AbstractFixerTestCase
 {
@@ -36,14 +38,6 @@ public function provideFixCases()
     {
         return array(
             array(
-                '<?php declare(strict_types=1);
-declare(ticks=1);
-//
-
-
-namespace A\B\C;
-class A {
-}',
                 '<?php
 declare(ticks=1);
 //
@@ -53,42 +47,23 @@ class A {
 class A {
 }',
             ),
-            array(
-                '<?php DECLARE/* A b C*/(strict_types=1);
-//abc',
-                '<?php DECLARE/* A b C*/(strict_types=1);      //abc',
-            ),
             array(
                 '<?php declare/* A b C*/(strict_types=1);',
             ),
             array(
-                '<?php declare(strict_types=1);
-/**/ /**/       ?>Test',
+                '<?php /**/ /**/ deClarE  (strict_types=1)    ?>Test',
                 '<?php /**/ /**/ deClarE  (STRICT_TYPES=1)    ?>Test',
             ),
             array(
-                '<?php declare(strict_types=1);
-',
                 '<?php            DECLARE  (    strict_types=1   )   ;',
             ),
             array(
-                '<?php declare(strict_types=1);
-/**/
-                ',
                 '<?php
                 /**/
                 declare(strict_types=1);',
             ),
             array(
                 '<?php declare(strict_types=1);
-/**/ /**/ /**/
-                 /* abc */ ',
-                '<?php
-                /**/ /**/ /**/
-                declare /* abc */ (strict_types=1);',
-            ),
-            array(
-                '<?php declare(strict_types=1);
                 phpinfo();',
                 '<?php
 
@@ -105,21 +80,6 @@ class A {
 /**
  * Foo
  */
-phpinfo();',
-            ),
-            array(
-                '<?php declare(strict_types=1);
-/*
- * Foo
- */
-
-phpinfo();',
-                '<?php
-
-/*
- * Foo
- */
-
 phpinfo();',
             ),
             array(
@@ -129,11 +89,6 @@ class A {
             ),
             array(
                 '<?php declare(strict_types=1);
-$a = 1;',
-                '<?php declare(strict_types=1);  $a = 1;',
-            ),
-            array(
-                '<?php declare(strict_types=1);
 $a = 456;
 ',
                 '<?php

tests/FixerFactoryTest.php

@@ -282,9 +282,6 @@ public function getFixersPriorityCases()
             array($fixers['no_useless_else'], $fixers['no_useless_return']), // tested also in: no_useless_else,no_useless_return.test
             array($fixers['no_useless_else'], $fixers['no_trailing_whitespace']), // tested also in: no_useless_else,no_trailing_whitespace.test
             array($fixers['no_useless_else'], $fixers['no_whitespace_in_blank_line']), // tested also in: no_useless_else,no_whitespace_in_blank_line.test
-            array($fixers['declare_strict_types'], $fixers['no_blank_lines_before_namespace']), // tested also in: declare_strict_types,no_blank_lines_before_namespace.test
-            array($fixers['declare_strict_types'], $fixers['no_extra_consecutive_blank_lines']), // tested also in: declare_strict_types,no_extra_consecutive_blank_lines.test
-            array($fixers['declare_strict_types'], $fixers['no_whitespace_in_blank_line']), // tested also in: declare_strict_types,no_whitespace_in_blank_line.test
             array($fixers['declare_strict_types'], $fixers['single_blank_line_before_namespace']), // tested also in: declare_strict_types,single_blank_line_before_namespace.test
             array($fixers['array_syntax'], $fixers['binary_operator_spaces']), // tested also in: array_syntax,binary_operator_spaces.test
             array($fixers['array_syntax'], $fixers['ternary_operator_spaces']), // tested also in: array_syntax,ternary_operator_spaces.test

tests/Fixtures/Integration/priority/declare_strict_types,no_blank_lines_before_namespace.test

@@ -6,17 +6,12 @@ Integration of fixers: declare_strict_types,single_blank_line_before_namespace.
 {"php": 70000}
 --EXPECT--
 <?php declare(strict_types=1);
-declare(ticks=1);
 
 namespace A\B\C;
 class A {
 }
 
 --INPUT--
-<?php
-declare(ticks=1);
-declare(strict_types=1);
-
-namespace A\B\C;
+<?php namespace A\B\C;
 class A {
 }