minor #4844 Same requirements for descriptions (SpacePossum)

This PR was merged into the 2.15 branch.

Discussion
----------

Same requirements for descriptions

Commits
-------

4cbaf27 Same requirements for descriptions

Author: SpacePossum

README.rst

@@ -1806,7 +1806,7 @@ Choose from the list of available rules:
 
   Lambdas not (indirect) referencing ``$this`` must be declared ``static``.
 
-  *Risky rule: risky when using "->bindTo" on lambdas without referencing to ``$this``.*
+  *Risky rule: risky when using ``->bindTo`` on lambdas without referencing to ``$this``.*
 
 * **strict_comparison** [@PhpCsFixer:risky]
 

src/Fixer/Comment/CommentToPhpdocFixer.php

@@ -63,7 +63,7 @@ public function getDefinition()
             'Comments with annotation should be docblock when used on structural elements.',
             [new CodeSample("<?php /* header */ \$x = true; /* @var bool \$isFoo */ \$isFoo = true;\n")],
             null,
-            'Risky as new docblocks might mean more, e.g. a Doctrine entity might have a new column in database'
+            'Risky as new docblocks might mean more, e.g. a Doctrine entity might have a new column in database.'
         );
     }
 

src/Fixer/FunctionNotation/StaticLambdaFixer.php

@@ -34,7 +34,7 @@ public function getDefinition()
             'Lambdas not (indirect) referencing `$this` must be declared `static`.',
             [new CodeSample("<?php\n\$a = function () use (\$b)\n{   echo \$b;\n};\n")],
             null,
-            'Risky when using "->bindTo" on lambdas without referencing to `$this`.'
+            'Risky when using `->bindTo` on lambdas without referencing to `$this`.'
         );
     }
 

tests/AutoReview/FixerTest.php

@@ -18,6 +18,8 @@
 use PhpCsFixer\Fixer\DeprecatedFixerInterface;
 use PhpCsFixer\Fixer\FixerInterface;
 use PhpCsFixer\Fixer\Whitespace\SingleBlankLineAtEofFixer;
+use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
+use PhpCsFixer\FixerConfiguration\FixerOptionInterface;
 use PhpCsFixer\FixerDefinition\CodeSampleInterface;
 use PhpCsFixer\FixerDefinition\FileSpecificCodeSampleInterface;
 use PhpCsFixer\FixerDefinition\VersionSpecificCodeSampleInterface;
@@ -52,16 +54,13 @@ final class FixerTest extends TestCase
      */
     public function testFixerDefinitions(AbstractFixer $fixer)
     {
-        static::assertInstanceOf(\PhpCsFixer\Fixer\DefinedFixerInterface::class, $fixer);
+        static::assertInstanceOf(DefinedFixerInterface::class, $fixer);
 
         $fixerName = $fixer->getName();
         $definition = $fixer->getDefinition();
         $fixerIsConfigurable = $fixer instanceof ConfigurationDefinitionFixerInterface;
 
-        static::assertRegExp('/^[A-Z`].*\.$/', $definition->getSummary(), sprintf('[%s] Description must start with capital letter or a ` and end with dot.', $fixerName));
-        static::assertNotContains('phpdocs', $definition->getSummary(), sprintf('[%s] `PHPDoc` must not be in the plural in description.', $fixerName), true);
-        static::assertCorrectCasing($definition->getSummary(), 'PHPDoc', sprintf('[%s] `PHPDoc` must be in correct casing in description.', $fixerName));
-        static::assertCorrectCasing($definition->getSummary(), 'PHPUnit', sprintf('[%s] `PHPUnit` must be in correct casing in description.', $fixerName));
+        self::assertValidDescription($fixerName, 'summary', $definition->getSummary());
 
         $samples = $definition->getCodeSamples();
         static::assertNotEmpty($samples, sprintf('[%s] Code samples are required.', $fixerName));
@@ -169,10 +168,7 @@ public function testFixerDefinitions(AbstractFixer $fixer)
         }
 
         if ($fixer->isRisky()) {
-            static::assertStringIsNotEmpty($definition->getRiskyDescription(), sprintf('[%s] Risky reasoning is required.', $fixerName));
-            static::assertNotContains('phpdocs', $definition->getRiskyDescription(), sprintf('[%s] `PHPDoc` must not be in the plural in risky reasoning.', $fixerName), true);
-            static::assertCorrectCasing($definition->getRiskyDescription(), 'PHPDoc', sprintf('[%s] `PHPDoc` must be in correct casing in risky reasoning.', $fixerName));
-            static::assertCorrectCasing($definition->getRiskyDescription(), 'PHPUnit', sprintf('[%s] `PHPUnit` must be in correct casing in risky reasoning.', $fixerName));
+            self::assertValidDescription($fixerName, 'risky description', $definition->getRiskyDescription());
         } else {
             static::assertNull($definition->getRiskyDescription(), sprintf('[%s] Fixer is not risky so no description of it expected.', $fixerName));
         }
@@ -210,7 +206,7 @@ public function testFixersAreFinal(FixerInterface $fixer)
      */
     public function testFixersAreDefined(FixerInterface $fixer)
     {
-        static::assertInstanceOf(\PhpCsFixer\Fixer\DefinedFixerInterface::class, $fixer);
+        static::assertInstanceOf(DefinedFixerInterface::class, $fixer);
     }
 
     /**
@@ -248,10 +244,10 @@ public function testFixerConfigurationDefinitions(ConfigurationDefinitionFixerIn
     {
         $configurationDefinition = $fixer->getConfigurationDefinition();
 
-        static::assertInstanceOf(\PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface::class, $configurationDefinition);
+        static::assertInstanceOf(FixerConfigurationResolverInterface::class, $configurationDefinition);
 
         foreach ($configurationDefinition->getOptions() as $option) {
-            static::assertInstanceOf(\PhpCsFixer\FixerConfiguration\FixerOptionInterface::class, $option);
+            static::assertInstanceOf(FixerOptionInterface::class, $option);
             static::assertNotEmpty($option->getDescription());
 
             static::assertSame(
@@ -339,4 +335,19 @@ private static function assertCorrectCasing($needle, $haystack, $message)
     {
         static::assertSame(substr_count(strtolower($haystack), strtolower($needle)), substr_count($haystack, $needle), $message);
     }
+
+    /**
+     * @param string $fixerName
+     * @param string $descriptionType
+     * @param mixed  $description
+     */
+    private static function assertValidDescription($fixerName, $descriptionType, $description)
+    {
+        static::assertInternalType('string', $description);
+        static::assertRegExp('/^[A-Z`][^"]+\.$/', $description, sprintf('[%s] The %s must start with capital letter or a ` and end with dot.', $fixerName, $descriptionType));
+        static::assertNotContains('phpdocs', $description, sprintf('[%s] `PHPDoc` must not be in the plural in %s.', $fixerName, $descriptionType), true);
+        static::assertCorrectCasing($description, 'PHPDoc', sprintf('[%s] `PHPDoc` must be in correct casing in %s.', $fixerName, $descriptionType));
+        static::assertCorrectCasing($description, 'PHPUnit', sprintf('[%s] `PHPUnit` must be in correct casing in %s.', $fixerName, $descriptionType));
+        static::assertFalse(strpos($descriptionType, '``'), sprintf('[%s] The %s must no contain sequential backticks.', $fixerName, $descriptionType));
+    }
 }