SimpleToComplexStringVariableFixer - Introduction

Author: dmvdbrugge

README.rst

@@ -1696,6 +1696,11 @@ Choose from the list of available rules:
 
   *Risky rule: silencing of deprecation errors might cause changes to code behaviour.*
 
+* **simple_to_complex_string_variable** [@PhpCsFixer]
+
+  Converts explicit variables in double-quoted strings and heredoc syntax
+  from simple to complex format (``${`` to ``{$``).
+
 * **simplified_null_return**
 
   A return statement wishing to return ``void`` should not return ``null``.

src/Console/Output/ErrorOutput.php

@@ -65,7 +65,7 @@ public function listErrors($process, array $errors)
             $message = $e->getMessage();
             $code = $e->getCode();
             if (0 !== $code) {
-                $message .= " (${code})";
+                $message .= " ({$code})";
             }
 
             $length = max(\strlen($class), \strlen($message));

src/DocBlock/Tag.php

@@ -94,7 +94,7 @@ public function setName($name)
             throw new \RuntimeException('Cannot set name on unknown tag.');
         }
 
-        $this->line->setContent(Preg::replace("/@${current}/", "@${name}", $this->line->getContent(), 1));
+        $this->line->setContent(Preg::replace("/@{$current}/", "@{$name}", $this->line->getContent(), 1));
 
         $this->name = $name;
     }

src/Fixer/ControlStructure/NoBreakCommentFixer.php

@@ -184,7 +184,7 @@ private function isNoBreakComment(Token $token)
 
         $text = preg_quote($this->configuration['comment_text'], '~');
 
-        return 1 === Preg::match("~^((//|#)\\s*${text}\\s*)|(/\\*\\*?\\s*${text}\\s*\\*/)$~i", $token->getContent());
+        return 1 === Preg::match("~^((//|#)\\s*{$text}\\s*)|(/\\*\\*?\\s*{$text}\\s*\\*/)$~i", $token->getContent());
     }
 
     /**

src/Fixer/PhpUnit/PhpUnitInternalClassFixer.php

@@ -132,7 +132,7 @@ private function createDocBlock(Tokens $tokens, $docBlockIndex)
         $lineEnd = $this->whitespacesConfig->getLineEnding();
         $originalIndent = $this->detectIndent($tokens, $tokens->getNextNonWhitespace($docBlockIndex));
         $toInsert = [
-            new Token([T_DOC_COMMENT, '/**'.$lineEnd."${originalIndent} * @internal".$lineEnd."${originalIndent} */"]),
+            new Token([T_DOC_COMMENT, '/**'.$lineEnd."{$originalIndent} * @internal".$lineEnd."{$originalIndent} */"]),
             new Token([T_WHITESPACE, $lineEnd.$originalIndent]),
         ];
         $index = $tokens->getNextMeaningfulToken($docBlockIndex);

src/Fixer/PhpUnit/PhpUnitNoExpectationAnnotationFixer.php

@@ -280,7 +280,7 @@ private function annotationsToParamList(array $annotations)
         if ($this->configuration['use_class_const']) {
             $params[] = $exceptionClass.'::class';
         } else {
-            $params[] = "'${exceptionClass}'";
+            $params[] = "'{$exceptionClass}'";
         }
 
         if (isset($annotations['expectedExceptionMessage'])) {

src/Fixer/PhpUnit/PhpUnitTestAnnotationFixer.php

@@ -346,7 +346,7 @@ private function createDocBlock(Tokens $tokens, $docBlockIndex)
         $lineEnd = $this->whitespacesConfig->getLineEnding();
         $originalIndent = $this->detectIndent($tokens, $tokens->getNextNonWhitespace($docBlockIndex));
         $toInsert = [
-            new Token([T_DOC_COMMENT, '/**'.$lineEnd."${originalIndent} * @test".$lineEnd."${originalIndent} */"]),
+            new Token([T_DOC_COMMENT, '/**'.$lineEnd."{$originalIndent} * @test".$lineEnd."{$originalIndent} */"]),
             new Token([T_WHITESPACE, $lineEnd.$originalIndent]),
         ];
         $index = $tokens->getNextMeaningfulToken($docBlockIndex);

src/Fixer/StringNotation/SimpleToComplexStringVariableFixer.php

@@ -0,0 +1,103 @@
+<?php
+
+/*
+ * This file is part of PHP CS Fixer.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace PhpCsFixer\Fixer\StringNotation;
+
+use PhpCsFixer\AbstractFixer;
+use PhpCsFixer\FixerDefinition\CodeSample;
+use PhpCsFixer\FixerDefinition\FixerDefinition;
+use PhpCsFixer\Tokenizer\CT;
+use PhpCsFixer\Tokenizer\Token;
+use PhpCsFixer\Tokenizer\Tokens;
+
+/**
+ * @author Dave van der Brugge <dmvdbrugge@gmail.com>
+ */
+final class SimpleToComplexStringVariableFixer extends AbstractFixer
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function getDefinition()
+    {
+        return new FixerDefinition(
+            'Converts explicit variables in double-quoted strings and heredoc syntax from simple to complex format (`${` to `{$`).',
+            [
+                new CodeSample(
+                    <<<'EOT'
+<?php
+$name = 'World';
+echo "Hello ${name}!";
+
+EOT
+                ),
+                new CodeSample(
+                    <<<'EOT'
+<?php
+$name = 'World';
+echo <<<TEST
+Hello ${name}!
+TEST;
+
+EOT
+                ),
+            ],
+            "Doesn't touch implicit variables. Works together nicely with `explicit_string_variable`."
+        );
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getPriority()
+    {
+        // should run after ExplicitStringVariableFixer
+        return -10;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isCandidate(Tokens $tokens)
+    {
+        return $tokens->isTokenKindFound(T_DOLLAR_OPEN_CURLY_BRACES);
+    }
+
+    protected function applyFix(\SplFileInfo $file, Tokens $tokens)
+    {
+        for ($index = \count($tokens) - 3; $index > 0; --$index) {
+            $token = $tokens[$index];
+
+            if (!$token->isGivenKind(T_DOLLAR_OPEN_CURLY_BRACES)) {
+                continue;
+            }
+
+            $varnameToken = $tokens[$index + 1];
+
+            if (!$varnameToken->isGivenKind(T_STRING_VARNAME)) {
+                continue;
+            }
+
+            $dollarCloseToken = $tokens[$index + 2];
+
+            if (!$dollarCloseToken->isGivenKind(CT::T_DOLLAR_CLOSE_CURLY_BRACES)) {
+                continue;
+            }
+
+            $tokens->overrideRange($index, $index + 2, [
+                new Token([T_CURLY_OPEN, '{']),
+                new Token([T_VARIABLE, '$'.$varnameToken->getContent()]),
+                new Token([CT::T_CURLY_CLOSE, '}']),
+            ]);
+        }
+    }
+}

src/RuleSet.php

@@ -254,6 +254,7 @@ final class RuleSet implements RuleSetInterface
             'phpdoc_types_order' => true,
             'phpdoc_var_annotation_correct_order' => true,
             'return_assignment' => true,
+            'simple_to_complex_string_variable' => true,
             'single_line_comment_style' => true,
         ],
         '@PhpCsFixer:risky' => [

tests/AutoReview/FixerFactoryTest.php

@@ -88,6 +88,7 @@ public function provideFixersPriorityCases()
             [$fixers['elseif'], $fixers['braces']],
             [$fixers['escape_implicit_backslashes'], $fixers['heredoc_to_nowdoc']],
             [$fixers['escape_implicit_backslashes'], $fixers['single_quote']],
+            [$fixers['explicit_string_variable'], $fixers['simple_to_complex_string_variable']],
             [$fixers['fully_qualified_strict_types'], $fixers['no_superfluous_phpdoc_tags']],
             [$fixers['function_to_constant'], $fixers['native_function_casing']],
             [$fixers['function_to_constant'], $fixers['no_extra_blank_lines']],