Merge branch '2.15'

* 2.15:
  Update symfony ruleset
  FunctionsAnalyzer: fix for comment in type

Author: SpacePossum

README.rst

@@ -264,7 +264,7 @@ Choose from the list of available rules:
 
   Each element of an array must be indented exactly once.
 
-* **array_syntax** [@PhpCsFixer]
+* **array_syntax** [@Symfony, @PhpCsFixer]
 
   PHP arrays should be declared using the configured syntax.
 
@@ -1283,7 +1283,7 @@ Choose from the list of available rules:
   - ``sortAlgorithm`` (``'alpha'``, ``'none'``): how multiple occurrences of same type
     statements should be sorted; defaults to ``'none'``
 
-* **ordered_imports** [@PhpCsFixer]
+* **ordered_imports** [@Symfony, @PhpCsFixer]
 
   Ordering ``use`` statements.
 
@@ -1562,7 +1562,7 @@ Choose from the list of available rules:
     ones; defaults to ``['property-read' => 'property', 'property-write' =>
     'property', 'type' => 'var', 'link' => 'see']``
 
-* **phpdoc_no_empty_return** [@Symfony, @PhpCsFixer]
+* **phpdoc_no_empty_return** [@PhpCsFixer]
 
   ``@return void`` and ``@return null`` annotations should be omitted from
   PHPDoc.
@@ -1639,7 +1639,7 @@ Choose from the list of available rules:
   PHPDoc should start and end with content, excluding the very first and
   last line of the docblocks.
 
-* **phpdoc_trim_consecutive_blank_line_separation** [@PhpCsFixer]
+* **phpdoc_trim_consecutive_blank_line_separation** [@Symfony, @PhpCsFixer]
 
   Removes extra blank lines after summary and after description in PHPDoc.
 
@@ -1684,7 +1684,7 @@ Choose from the list of available rules:
   Pre incrementation/decrementation should be used if possible.
   DEPRECATED: use ``increment_style`` instead.
 
-* **protected_to_private** [@Symfony, @PhpCsFixer]
+* **protected_to_private** [@PhpCsFixer]
 
   Converts ``protected`` variables and methods to ``private`` where possible.
 

src/RuleSet.php

@@ -58,6 +58,7 @@ final class RuleSet implements RuleSetInterface
         ],
         '@Symfony' => [
             '@PSR2' => true,
+            'array_syntax' => ['syntax' => 'short'],
             'binary_operator_spaces' => true,
             'blank_line_after_opening_tag' => true,
             'blank_line_before_statement' => [
@@ -112,6 +113,7 @@ final class RuleSet implements RuleSetInterface
             'no_whitespace_in_blank_line' => true,
             'normalize_index_brace' => true,
             'object_operator_without_whitespace' => true,
+            'ordered_imports' => true,
             'php_unit_fqcn_annotation' => true,
             'phpdoc_align' => [
                 // @TODO: on 3.0 switch whole rule to `=> true`, currently we use custom config that will be default on 3.0
@@ -130,7 +132,6 @@ final class RuleSet implements RuleSetInterface
             'phpdoc_inline_tag' => true,
             'phpdoc_no_access' => true,
             'phpdoc_no_alias_tag' => true,
-            'phpdoc_no_empty_return' => true,
             'phpdoc_no_package' => true,
             'phpdoc_no_useless_inheritdoc' => true,
             'phpdoc_return_self_reference' => true,
@@ -140,13 +141,13 @@ final class RuleSet implements RuleSetInterface
             'phpdoc_summary' => true,
             'phpdoc_to_comment' => true,
             'phpdoc_trim' => true,
+            'phpdoc_trim_consecutive_blank_line_separation' => true,
             'phpdoc_types' => true,
             'phpdoc_types_order' => [
                 'null_adjustment' => 'always_last',
                 'sort_algorithm' => 'none',
             ],
             'phpdoc_var_without_name' => true,
-            'protected_to_private' => true,
             'return_type_declaration' => true,
             'semicolon_after_instruction' => true,
             'short_scalar_cast' => true,
@@ -206,7 +207,6 @@ final class RuleSet implements RuleSetInterface
             '@Symfony' => true,
             'align_multiline_comment' => true,
             'array_indentation' => true,
-            'array_syntax' => ['syntax' => 'short'],
             'blank_line_before_statement' => true,
             'combine_consecutive_issets' => true,
             'combine_consecutive_unsets' => true,
@@ -242,16 +242,16 @@ final class RuleSet implements RuleSetInterface
             'no_useless_else' => true,
             'no_useless_return' => true,
             'ordered_class_elements' => true,
-            'ordered_imports' => true,
             'php_unit_internal_class' => true,
             'php_unit_method_casing' => true,
             'php_unit_ordered_covers' => true,
             'php_unit_test_class_requires_covers' => true,
             'phpdoc_add_missing_param_annotation' => true,
+            'phpdoc_no_empty_return' => true,
             'phpdoc_order' => true,
-            'phpdoc_trim_consecutive_blank_line_separation' => true,
             'phpdoc_types_order' => true,
             'phpdoc_var_annotation_correct_order' => true,
+            'protected_to_private' => true,
             'return_assignment' => true,
             'simple_to_complex_string_variable' => true,
             'single_line_comment_style' => true,

src/Tokenizer/Analyzer/FunctionsAnalyzer.php

@@ -82,11 +82,11 @@ public function getFunctionReturnType(Tokens $tokens, $methodIndex)
         }
 
         $type = '';
-        $typeStartIndex = $tokens->getNextNonWhitespace($typeColonIndex);
+        $typeStartIndex = $tokens->getNextMeaningfulToken($typeColonIndex);
         $typeEndIndex = $typeStartIndex;
         $functionBodyStart = $tokens->getNextTokenOfKind($typeColonIndex, ['{', ';']);
         for ($i = $typeStartIndex; $i < $functionBodyStart; ++$i) {
-            if ($tokens[$i]->isWhitespace()) {
+            if ($tokens[$i]->isWhitespace() || $tokens[$i]->isComment()) {
                 continue;
             }
 

tests/Fixtures/Integration/misc/PHP7.test

@@ -49,7 +49,7 @@ class Foo implements FooInterface
     const FOR = 1;
 
     // array const
-    const ARR = array(1, 2);
+    const ARR = [1, 2];
 
     // semi-reserved keyword as function name
     public function list($a, $b)
@@ -65,7 +65,7 @@ class Foo implements FooInterface
         echo mt_rand(0, 1);
 
         // uniform variable syntax
-        $a = array('b' => 'c');
+        $a = ['b' => 'c'];
         $c = 'Next step !';
         echo ${$a['b']};
 

tests/Fixtures/Integration/set/@Symfony.test-out.php

@@ -41,15 +41,15 @@ public function __construct($dummy)
      *
      * @throws \RuntimeException
      */
-    private function transformText($dummy, array $options = array(), $data = null)
+    private function transformText($dummy, array $options = [], $data = null)
     {
         $fnc = function () { return true; };
 
         $mergedOptions = array_merge(
-            array(
+            [
                 'some_default' => 'values',
                 'another_default' => 'more values',
-            ),
+            ],
             $options
         );
 

tests/Fixtures/Integration/set/@Symfony_whitespaces.test-out.php

@@ -41,15 +41,15 @@ public function __construct($dummy)
 	 *
 	 * @throws \RuntimeException
 	 */
-	private function transformText($dummy, array $options = array(), $data = null)
+	private function transformText($dummy, array $options = [], $data = null)
 	{
 		$fnc = function () { return true; };
 
 		$mergedOptions = array_merge(
-			array(
+			[
 				'some_default' => 'values',
 				'another_default' => 'more values',
-			),
+			],
 			$options
 		);
 

tests/Tokenizer/Analyzer/FunctionsAnalyzerTest.php

@@ -213,6 +213,30 @@ public function provideFunctionsWithArgumentsCases()
                     )
                 ),
             ]],
+            ['<?php function(\Foo\Bar $a){};', 1, [
+                '$a' => new ArgumentAnalysis(
+                    '$a',
+                    8,
+                    null,
+                    new TypeAnalysis(
+                        '\Foo\Bar',
+                        3,
+                        6
+                    )
+                ),
+            ]],
+            ['<?php function(\Foo/** TODO: change to something else */\Bar $a){};', 1, [
+                '$a' => new ArgumentAnalysis(
+                    '$a',
+                    9,
+                    null,
+                    new TypeAnalysis(
+                        '\Foo\Bar',
+                        3,
+                        7
+                    )
+                ),
+            ]],
         ];
     }
 
@@ -222,6 +246,8 @@ public function provideFunctionsWithReturnTypeCases()
             ['<?php function(){};', 1, null],
             ['<?php function($a): array {};', 1, new TypeAnalysis('array', 7, 7)],
             ['<?php function($a): \Foo\Bar {};', 1, new TypeAnalysis('\Foo\Bar', 7, 10)],
+            ['<?php function($a): /* not sure if really an array */array {};', 1, new TypeAnalysis('array', 8, 8)],
+            ['<?php function($a): \Foo/** TODO: change to something else */\Bar {};', 1, new TypeAnalysis('\Foo\Bar', 7, 11)],
         ];
     }
 }