Merge branch '2.2' into 2.3

keradus · keradus · commit 30e31622d08a · 2017-06-20T17:42:34.000+02:00
# Conflicts:
#	src/Fixer/Basic/Psr0Fixer.php
#	tests/AutoReview/ProjectCodeTest.php
diff --git a/README.rst b/README.rst
@@ -964,7 +964,8 @@ Choose from the list of available rules:
 
   Configuration options:
 
-  - ``dir`` (``string``): the directory where the project code is placed; required
+  - ``dir`` (``string``): the directory where the project code is placed; defaults
+    to ``''``
 
 * **psr4** [@Symfony:risky]
 
diff --git a/src/AbstractFixer.php b/src/AbstractFixer.php
@@ -63,6 +63,10 @@ public function __construct()
 
     final public function fix(\SplFileInfo $file, Tokens $tokens)
     {
+        if ($this instanceof ConfigurableFixerInterface && null === $this->configuration) {
+            throw new RequiredFixerConfigurationException($this->getName(), 'Configuration is required.');
+        }
+
         if (0 < $tokens->count() && $this->isCandidate($tokens) && $this->supports($file)) {
             $this->applyFix($file, $tokens);
         }
diff --git a/src/Fixer/Basic/Psr0Fixer.php b/src/Fixer/Basic/Psr0Fixer.php
@@ -41,6 +41,13 @@ public function getDefinition()
                     '<?php
 namespace PhpCsFixer\FIXER\Basic;
 class InvalidName {}
+',
+                    new \SplFileInfo(__FILE__)
+                ),
+                new FileSpecificCodeSample(
+                    '<?php
+namespace PhpCsFixer\FIXER\Basic;
+class InvalidName {}
 ',
                     new \SplFileInfo(__FILE__),
                     ['dir' => realpath(__DIR__.'/../..')]
@@ -92,7 +99,7 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens)
             $path = str_replace('\\', '/', $file->getRealPath());
             $dir = dirname($path);
 
-            if (isset($this->configuration['dir'])) {
+            if ('' !== $this->configuration['dir']) {
                 $dir = substr($dir, strlen(realpath($this->configuration['dir'])) + 1);
 
                 if (false === $dir) {
@@ -150,6 +157,7 @@ protected function createConfigurationDefinition()
         return new FixerConfigurationResolver([
             (new FixerOptionBuilder('dir', 'The directory where the project code is placed.'))
                 ->setAllowedTypes(['string'])
+                ->setDefault('')
                 ->getOption(),
         ]);
     }
diff --git a/src/Fixer/Comment/HeaderCommentFixer.php b/src/Fixer/Comment/HeaderCommentFixer.php
@@ -13,7 +13,6 @@
 namespace PhpCsFixer\Fixer\Comment;
 
 use PhpCsFixer\AbstractFixer;
-use PhpCsFixer\ConfigurationException\RequiredFixerConfigurationException;
 use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface;
 use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;
 use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
@@ -113,10 +112,6 @@ public function isCandidate(Tokens $tokens)
      */
     protected function applyFix(\SplFileInfo $file, Tokens $tokens)
     {
-        if (null === $this->configuration['header']) {
-            throw new RequiredFixerConfigurationException($this->getName(), 'Configuration is required.');
-        }
-
         // figure out where the comment should be placed
         $headerNewIndex = $this->findHeaderCommentInsertionIndex($tokens);
 
diff --git a/src/Fixer/Phpdoc/PhpdocSeparationFixer.php b/src/Fixer/Phpdoc/PhpdocSeparationFixer.php
@@ -16,7 +16,6 @@
 use PhpCsFixer\DocBlock\Annotation;
 use PhpCsFixer\DocBlock\DocBlock;
 use PhpCsFixer\DocBlock\TagComparator;
-use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;
 use PhpCsFixer\FixerDefinition\CodeSample;
 use PhpCsFixer\FixerDefinition\FixerDefinition;
 use PhpCsFixer\Tokenizer\Token;
@@ -25,7 +24,7 @@
 /**
  * @author Graham Campbell <graham@alt-three.com>
  */
-final class PhpdocSeparationFixer extends AbstractFixer implements WhitespacesAwareFixerInterface
+final class PhpdocSeparationFixer extends AbstractFixer
 {
     /**
      * {@inheritdoc}
diff --git a/src/Tokenizer/Transformer/SquareBraceTransformer.php b/src/Tokenizer/Transformer/SquareBraceTransformer.php
@@ -50,7 +50,7 @@ public function getCustomTokens()
     public function getRequiredPhpVersionId()
     {
         // Short array syntax was introduced in PHP 5.4, but the fixer is smart
-        // enough to handel it even before 5.4.
+        // enough to handle it even before 5.4.
         // Same for array destructing syntax sugar `[` introduced in PHP 7.1.
         return 50000;
     }
diff --git a/tests/AutoReview/FixerTest.php b/tests/AutoReview/FixerTest.php
@@ -146,12 +146,29 @@ public function provideFixerDefinitionsCases()
      */
     public function testFixerConfigurationDefinitions(ConfigurationDefinitionFixerInterface $fixer)
     {
+        // do not modify this structure without prior discussion
+        static $allowedRequiredOptions = [
+            'header_comment' => ['header' => true],
+        ];
+
         $configurationDefinition = $fixer->getConfigurationDefinition();
 
         $this->assertInstanceOf(\PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface::class, $configurationDefinition);
 
         foreach ($configurationDefinition->getOptions() as $option) {
             $this->assertNotEmpty($option->getDescription());
+
+            $this->assertSame(
+                !isset($allowedRequiredOptions[$fixer->getName()][$option->getName()]),
+                $option->hasDefault(),
+                sprintf(
+                    $option->hasDefault()
+                        ? 'Option `%s` of fixer `%s` is wrongly listed in `$allowedRequiredOptions` structure, as it is not required. If you just changed that option to not be required anymore, please adjust mentioned structure.'
+                        : 'Option `%s` of fixer `%s` shall not be required. If you want to introduce new required option please adjust `$allowedRequiredOptions` structure.',
+                    $option->getName(),
+                    $fixer->getName()
+                )
+            );
         }
     }
 
diff --git a/tests/AutoReview/ProjectCodeTest.php b/tests/AutoReview/ProjectCodeTest.php
@@ -41,7 +41,6 @@ final class ProjectCodeTest extends TestCase
         \PhpCsFixer\Doctrine\Annotation\Tokens::class,
         \PhpCsFixer\FileRemoval::class,
         \PhpCsFixer\FixerConfiguration\FixerOptionValidatorGenerator::class,
-        \PhpCsFixer\FixerDefinition\FileSpecificCodeSample::class,
         \PhpCsFixer\FixerFileProcessedEvent::class,
         \PhpCsFixer\Fixer\Operator\AlignDoubleArrowFixerHelper::class,
         \PhpCsFixer\Fixer\Operator\AlignEqualsFixerHelper::class,
@@ -136,7 +135,6 @@ function (\ReflectionClass $interface) {
         $exceptionMethodsPerClass = [
             \PhpCsFixer\Config::class => ['create'],
             \PhpCsFixer\Fixer\FunctionNotation\MethodArgumentSpaceFixer::class => ['fixSpace'],
-            \PhpCsFixer\Fixer\Import\OrderedImportsFixer::class => ['sortingCallBack'],
         ];
 
         $definedMethods = $this->getPublicMethodNames($rc);
@@ -172,7 +170,10 @@ public function testThatSrcClassesNotExposeProperties($className)
         $rc = new \ReflectionClass($className);
 
         if (\PhpCsFixer\Fixer\Alias\NoMixedEchoPrintFixer::class === $className) {
-            $this->markTestIncomplete('Public properties of fixer \'PhpCsFixer\Fixer\Alias\NoMixedEchoPrintFixer\' will be remove on 3.0.');
+            $this->markTestIncomplete(sprintf(
+                'Public properties of fixer `%s` will be remove on 3.0.',
+                \PhpCsFixer\Fixer\Alias\NoMixedEchoPrintFixer::class
+            ));
         }
 
         $this->assertEmpty(
diff --git a/tests/ConfigurationException/InvalidConfigurationExceptionTest.php b/tests/ConfigurationException/InvalidConfigurationExceptionTest.php
@@ -32,7 +32,7 @@ public function testIsInvalidConfigurationException()
             'I cannot do that, Dave.'
         );
 
-        $this->assertInstanceOf('PhpCsFixer\ConfigurationException\InvalidConfigurationException', $exception);
+        $this->assertInstanceOf(\PhpCsFixer\ConfigurationException\InvalidConfigurationException::class, $exception);
     }
 
     public function testDefaults()
diff --git a/tests/ConfigurationException/RequiredFixerConfigurationExceptionTest.php b/tests/ConfigurationException/RequiredFixerConfigurationExceptionTest.php
@@ -32,7 +32,7 @@ public function testIsInvalidFixerConfigurationException()
             'I cannot do that, Dave.'
         );
 
-        $this->assertInstanceOf('PhpCsFixer\ConfigurationException\InvalidFixerConfigurationException', $exception);
+        $this->assertInstanceOf(\PhpCsFixer\ConfigurationException\InvalidFixerConfigurationException::class, $exception);
     }
 
     public function testDefaults()
diff --git a/tests/Differ/AbstractDifferTestCase.php b/tests/Differ/AbstractDifferTestCase.php
@@ -35,7 +35,7 @@ final public function testIsDiffer()
 
         $differ = new $className();
 
-        $this->assertInstanceOf('PhpCsFixer\Differ\DifferInterface', $differ);
+        $this->assertInstanceOf(\PhpCsFixer\Differ\DifferInterface::class, $differ);
     }
 
     final protected function oldCode()
diff --git a/tests/Fixer/Phpdoc/PhpdocSeparationFixerTest.php b/tests/Fixer/Phpdoc/PhpdocSeparationFixerTest.php
@@ -13,7 +13,6 @@
 namespace PhpCsFixer\Tests\Fixer\Phpdoc;
 
 use PhpCsFixer\Test\AbstractFixerTestCase;
-use PhpCsFixer\WhitespacesFixerConfig;
 
 /**
  * @author Graham Campbell <graham@alt-three.com>
@@ -584,8 +583,6 @@ public function testMessyWhitespaces()
         $expected = "<?php\t/**\r\n\t * @param string \$text\r\n\t *\r\n\t * @return string\r\n\t */";
         $input = "<?php\t/**\r\n\t * @param string \$text\r\n\t * @return string\r\n\t */";
 
-        $this->fixer->setWhitespacesConfig(new WhitespacesFixerConfig("\t", "\r\n"));
-
         $this->doTest($expected, $input);
     }
 }
diff --git a/tests/FixerDefinition/FileSpecificCodeSampleTest.php b/tests/FixerDefinition/FileSpecificCodeSampleTest.php
@@ -0,0 +1,71 @@
+<?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\Tests\FixerDefinition;
+
+use PhpCsFixer\FixerDefinition\FileSpecificCodeSample;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @author Andreas Möller <am@localheinz.com>
+ *
+ * @internal
+ *
+ * @covers \PhpCsFixer\FixerDefinition\FileSpecificCodeSample
+ */
+final class FileSpecificCodeSampleTest extends TestCase
+{
+    public function testImplementsFileSpecificCodeSampleInterface()
+    {
+        $sample = new FileSpecificCodeSample(
+            file_get_contents(__FILE__),
+            new \SplFileInfo(__FILE__)
+        );
+
+        $this->assertInstanceOf(\PhpCsFixer\FixerDefinition\FileSpecificCodeSampleInterface::class, $sample);
+    }
+
+    public function testDefaults()
+    {
+        $code = file_get_contents(__FILE__);
+        $splFileInfo = new \SplFileInfo(__FILE__);
+
+        $sample = new FileSpecificCodeSample(
+            $code,
+            $splFileInfo
+        );
+
+        $this->assertSame($code, $sample->getCode());
+        $this->assertSame($splFileInfo, $sample->getSplFileInfo());
+        $this->assertNull($sample->getConfiguration());
+    }
+
+    public function testConstructorSetsValues()
+    {
+        $code = file_get_contents(__FILE__);
+        $splFileInfo = new \SplFileInfo(__FILE__);
+        $configuration = [
+            'foo' => 'bar',
+            'bar' => 'baz',
+        ];
+
+        $sample = new FileSpecificCodeSample(
+            $code,
+            $splFileInfo,
+            $configuration
+        );
+
+        $this->assertSame($code, $sample->getCode());
+        $this->assertSame($splFileInfo, $sample->getSplFileInfo());
+        $this->assertSame($configuration, $sample->getConfiguration());
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,10 @@ public function __construct()`
`63`	`63`
`64`	`64`	`final public function fix(\SplFileInfo $file, Tokens $tokens)`
`65`	`65`	`{`
	`66`	`+ if ($this instanceof ConfigurableFixerInterface && null === $this->configuration) {`
	`67`	`+ throw new RequiredFixerConfigurationException($this->getName(), 'Configuration is required.');`
	`68`	`+ }`
	`69`	`+`
`66`	`70`	`if (0 < $tokens->count() && $this->isCandidate($tokens) && $this->supports($file)) {`
`67`	`71`	`$this->applyFix($file, $tokens);`
`68`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ public function getCustomTokens()`
`50`	`50`	`public function getRequiredPhpVersionId()`
`51`	`51`	`{`
`52`	`52`	`// Short array syntax was introduced in PHP 5.4, but the fixer is smart`
`53`		`- // enough to handel it even before 5.4.`
	`53`	`+ // enough to handle it even before 5.4.`
`54`	`54`	// Same for array destructing syntax sugar `[` introduced in PHP 7.1.
`55`	`55`	`return 50000;`
`56`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public function testIsInvalidConfigurationException()`
`32`	`32`	`'I cannot do that, Dave.'`
`33`	`33`	`);`
`34`	`34`
`35`		`- $this->assertInstanceOf('PhpCsFixer\ConfigurationException\InvalidConfigurationException', $exception);`
	`35`	`+ $this->assertInstanceOf(\PhpCsFixer\ConfigurationException\InvalidConfigurationException::class, $exception);`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`public function testDefaults()`