Merge branch '2.12' into 3869-phpdoc_no_empty_return-less-greedy

.circleci/config.yml

@@ -0,0 +1,23 @@
+version: 2
+
+jobs:
+    build:
+        macos:
+            xcode: '9.0'
+        steps:
+            - checkout
+
+            - save_cache:
+                key: dependency-cache
+                paths:
+                    - ~/.composer
+                    - ~/Library/Caches/Homebrew
+
+            - run: brew update
+            - run: brew install php72
+            - run: echo "memory_limit = 512M" > $(brew --prefix)/etc/php/7.2/conf.d/memory.ini
+            - run: curl -sS https://getcomposer.org/installer | php
+            - run: php composer.phar global show hirak/prestissimo -q || php composer.phar global require --no-interaction --no-progress --optimize-autoloader hirak/prestissimo
+            - run: php composer.phar install --optimize-autoloader --no-interaction --no-progress --no-suggest
+            - run: vendor/bin/phpunit
+            - run: PHP_CS_FIXER_FUTURE_MODE=1 php php-cs-fixer --diff --dry-run -v fix

.gitattributes

@@ -9,6 +9,7 @@ tests/Test/AbstractFixerWithAliasedOptionsTestCase.php export-ignore
 tests/Test/AbstractTransformerTestCase.php export-ignore
 
 .appveyor.yml export-ignore
+.circleci/ export-ignore
 .composer-require-checker.json export-ignore
 .editorconfig export-ignore
 .gitattributes export-ignore

src/Fixer/Import/FullyQualifiedStrictTypesFixer.php

@@ -70,6 +70,16 @@ public function doSomething(\Foo\Bar $foo): \Foo\Bar\Baz
         );
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getPriority()
+    {
+        // should run after PhpdocToReturnTypeFixer
+        // should run before NoSuperfluousPhpdocTagsFixer
+        return 7;
+    }
+
     /**
      * {@inheritdoc}
      */

src/Fixer/Phpdoc/NoSuperfluousPhpdocTagsFixer.php

@@ -139,7 +139,7 @@ private function findDocumentedFunction(Tokens $tokens, $index)
         do {
             $index = $tokens->getNextMeaningfulToken($index);
 
-            if ($tokens[$index]->isGivenKind(T_FUNCTION)) {
+            if (null === $index || $tokens[$index]->isGivenKind(T_FUNCTION)) {
                 return $index;
             }
         } while ($tokens[$index]->isGivenKind([T_ABSTRACT, T_FINAL, T_STATIC, T_PRIVATE, T_PROTECTED, T_PUBLIC]));

src/Fixer/Phpdoc/PhpdocAnnotationWithoutDotFixer.php

@@ -78,14 +78,14 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens)
                 $content = $annotation->getContent();
 
                 if (
-                    1 !== Preg::match('/[.。]$/u', $content)
-                    || 0 !== Preg::match('/[.。](?!$)/u', $content, $matches)
+                    1 !== Preg::match('/[.。]\h*$/u', $content)
+                    || 0 !== Preg::match('/[.。](?!\h*$)/u', $content, $matches)
                 ) {
                     continue;
                 }
 
                 $endLine = $doc->getLine($annotation->getEnd());
-                $endLine->setContent(Preg::replace('/(?<![.。])[.。](\s+)$/u', '\1', $endLine->getContent()));
+                $endLine->setContent(Preg::replace('/(?<![.。])[.。]\h*(\H+)$/u', '\1', $endLine->getContent()));
 
                 $startLine = $doc->getLine($annotation->getStart());
                 $optionalTypeRegEx = $annotation->supportTypes()

src/Fixer/Strict/StrictParamFixer.php

@@ -77,7 +77,7 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens)
 
             $previousIndex = $tokens->getPrevMeaningfulToken($index);
             if (null !== $previousIndex && $tokens[$previousIndex]->isGivenKind(CT::T_FUNCTION_IMPORT)) {
-                return;
+                continue;
             }
 
             $lowercaseContent = strtolower($token->getContent());

src/Fixer/StringNotation/ExplicitStringVariableFixer.php

@@ -95,6 +95,12 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens)
                 foreach ($variableTokens as $variablePartIndex => $variablePartToken) {
                     if ($variablePartToken->isGivenKind(T_NUM_STRING)) {
                         $tokens[$variablePartIndex] = new Token([T_LNUMBER, $variablePartToken->getContent()]);
+
+                        continue;
+                    }
+
+                    if ($variablePartToken->isGivenKind(T_STRING) && $tokens[$variablePartIndex + 1]->equals(']')) {
+                        $tokens[$variablePartIndex] = new Token([T_CONSTANT_ENCAPSED_STRING, "'".$variablePartToken->getContent()."'"]);
                     }
                 }
 

src/Fixer/Whitespace/NoTrailingWhitespaceFixer.php

@@ -62,17 +62,37 @@ public function isCandidate(Tokens $tokens)
      */
     protected function applyFix(\SplFileInfo $file, Tokens $tokens)
     {
-        foreach ($tokens as $index => $token) {
+        for ($index = count($tokens) - 1; $index >= 0; --$index) {
+            $token = $tokens[$index];
+            if (
+                $token->isGivenKind(T_OPEN_TAG)
+                && $tokens->offsetExists($index + 1)
+                && $tokens[$index + 1]->isWhitespace()
+                && 1 === Preg::match('/(.*)\h$/', $token->getContent(), $openTagMatches)
+                && 1 === Preg::match('/^(\R)(.*)$/s', $tokens[$index + 1]->getContent(), $whitespaceMatches)
+            ) {
+                $tokens[$index] = new Token([T_OPEN_TAG, $openTagMatches[1].$whitespaceMatches[1]]);
+                if ('' === $whitespaceMatches[2]) {
+                    $tokens->clearAt($index + 1);
+                } else {
+                    $tokens[$index + 1] = new Token([T_WHITESPACE, $whitespaceMatches[2]]);
+                }
+
+                continue;
+            }
+
             if (!$token->isWhitespace()) {
                 continue;
             }
 
-            $lines = Preg::split("/([\r\n]+)/", $token->getContent(), -1, PREG_SPLIT_DELIM_CAPTURE);
+            $lines = Preg::split('/(\\R+)/', $token->getContent(), -1, PREG_SPLIT_DELIM_CAPTURE);
             $linesSize = count($lines);
 
             // fix only multiline whitespaces or singleline whitespaces at the end of file
             if ($linesSize > 1 || !isset($tokens[$index + 1])) {
-                $lines[0] = rtrim($lines[0], " \t");
+                if (!$tokens[$index - 1]->isGivenKind(T_OPEN_TAG) || 1 !== Preg::match('/(.*)\R$/', $tokens[$index - 1]->getContent())) {
+                    $lines[0] = rtrim($lines[0], " \t");
+                }
 
                 for ($i = 1; $i < $linesSize; ++$i) {
                     $trimmedLine = rtrim($lines[$i], " \t");

src/Tokenizer/Analyzer/ArgumentsAnalyzer.php

@@ -107,7 +107,7 @@ public function getArgumentInfo(Tokens $tokens, $argumentStart, $argumentEnd)
         $sawName = false;
         for ($index = $argumentStart; $index <= $argumentEnd; ++$index) {
             $token = $tokens[$index];
-            if ($token->isComment() || $token->isWhitespace() || $token->isGivenKind(T_ELLIPSIS)) {
+            if ($token->isComment() || $token->isWhitespace() || $token->isGivenKind(T_ELLIPSIS) || $token->equals('&')) {
                 continue;
             }
             if ($token->isGivenKind(T_VARIABLE)) {

tests/AutoReview/FixerFactoryTest.php

@@ -83,6 +83,7 @@ public function provideFixersPriorityCases()
             [$fixers['elseif'], $fixers['braces']],
             [$fixers['escape_implicit_backslashes'], $fixers['heredoc_to_nowdoc']],
             [$fixers['escape_implicit_backslashes'], $fixers['single_quote']],
+            [$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']],
             [$fixers['function_to_constant'], $fixers['no_singleline_whitespace_before_semicolons']],

tests/Fixer/Import/FullyQualifiedStrictTypesFixerTest.php

@@ -371,6 +371,13 @@ public function doSomething(
     ){}
 }',
             ],
+            // Test reference
+            [
+                '<?php
+function withReference(Exception &$e) {}',
+                '<?php
+function withReference(\Exception &$e) {}',
+            ],
         ];
     }
 }

tests/Fixer/Phpdoc/NoSuperfluousPhpdocTagsFixerTest.php

@@ -264,6 +264,12 @@ class Foo {
     public function doFoo(array $bar, callable $baz) {}
 }',
             ],
+            'PHPDoc at the end of file' => [
+                '<?php
+/**
+ * Foo
+ */',
+            ],
         ];
     }
 

tests/Fixer/Phpdoc/PhpdocAnnotationWithoutDotFixerTest.php

@@ -137,6 +137,26 @@ public function provideFixCases()
     /**
      * @return bool|null Returns `true` if the class has a single-column ID
      *                   and Returns `false` otherwise.
+     */',
+            ],
+            [
+                '<?php
+    /**
+     * @throws \Exception having whitespaces after dot, yet I am fixed
+     */',
+                '<?php
+    /**
+     * @throws \Exception having whitespaces after dot, yet I am fixed.   '.'
+     */',
+            ],
+            [
+                '<?php
+    /**
+     * @throws \Exception having tabs after dot, yet I am fixed
+     */',
+                '<?php
+    /**
+     * @throws \Exception having tabs after dot, yet I am fixed.		'.'
      */',
             ],
         ];

tests/Fixer/Strict/StrictParamFixerTest.php

@@ -135,6 +135,24 @@ public function provideFixCases()
     class Foo
     {
         public function __construct($foo, $bar) {}
+    }',
+            ],
+            [
+                '<?php
+    namespace Foo {
+        array_keys($foo, $bar, true);
+    }
+    namespace Bar {
+        use function Foo\LoremIpsum;
+        array_keys($foo, $bar, true);
+    }',
+                '<?php
+    namespace Foo {
+        array_keys($foo, $bar);
+    }
+    namespace Bar {
+        use function Foo\LoremIpsum;
+        array_keys($foo, $bar);
     }',
             ],
         ];

tests/Fixer/StringNotation/ExplicitStringVariableFixerTest.php

@@ -114,8 +114,8 @@ public function provideTestFixCases()
                 '<?php $a = "My name is $array[1] !";',
             ],
             [
-                '<?php $a = "My name is {$array[MY_CONSTANT]} !";',
-                '<?php $a = "My name is $array[MY_CONSTANT] !";',
+                '<?php $a = "My name is {$array[\'foo\']} !";',
+                '<?php $a = "My name is $array[foo] !";',
             ],
             [
                 '<?php $a = "Closure not allowed ${closure}() text";',

tests/Fixer/Whitespace/NoTrailingWhitespaceFixerTest.php

@@ -96,6 +96,44 @@ public function provideFixCases()
             [
                 "<?php\necho <<<'EOT'\nInline Il y eut un   \r\nrire éclatant    \n     \n   \r\nEOT;\n\n",
             ],
+            [
+                "<?php\necho 'Hello World';",
+                "<?php \necho 'Hello World';",
+            ],
+            [
+                "<?php\n\necho 'Hello World';",
+                "<?php \n\necho 'Hello World';",
+            ],
+            [
+                "<?php\r\necho 'Hello World';",
+                "<?php \r\necho 'Hello World';",
+            ],
+            [
+                "<?php\necho 'Hello World';",
+                "<?php  \necho 'Hello World';",
+            ],
+            [
+                "<?php\necho 'Hello World';",
+                "<?php	\necho 'Hello World';",
+            ],
+            [
+                '<?php ',
+                '<?php  ',
+            ],
+            [
+                "<?php\t",
+                "<?php\t\t",
+            ],
+            [
+                '<?php ', // do not trim this as "<?php" is not valid PHP
+            ],
+            [
+                "<?php\n      \n   \n    ",
+            ],
+            [
+                "<?php\n   \n    ",
+                "<?php      \n   \n    ",
+            ],
         ];
     }
 }

tests/Fixtures/Integration/priority/fully_qualified_strict_types,no_superfluous_phpdoc_tags.test

@@ -0,0 +1,20 @@
+--TEST--
+Integration of fixers: fully_qualified_strict_types,no_superfluous_phpdoc_tags.
+--RULESET--
+{"fully_qualified_strict_types": true, "no_superfluous_phpdoc_tags": true}
+--EXPECT--
+<?php
+// No namespace
+/**
+ * @param bool $expected
+ */
+function testSomething(Foo $foo, $expected) {}
+
+--INPUT--
+<?php
+// No namespace
+/**
+ * @param Foo  $foo
+ * @param bool $expected
+ */
+function testSomething(\Foo $foo, $expected) {}

tests/Tokenizer/Analyzer/ArgumentsAnalyzerTest.php

@@ -116,6 +116,16 @@ public function provideArgumentsInfoCases()
                     3
                 )
             )],
+            ['<?php function(array &$a = array()){};', 3, 12, new ArgumentAnalysis(
+                '$a',
+                6,
+                'array()',
+                new TypeAnalysis(
+                    'array',
+                    3,
+                    3
+                )
+            )],
             ['<?php function(array ... $a){};', 3, 7, new ArgumentAnalysis(
                 '$a',
                 7,