minor #5008 Enhancement: Social justification applied (gbyrka-fingo)

This PR was squashed before being merged into the 2.15 branch.

Discussion
----------

Enhancement: Social justification applied

The time has come to rename functionalities that for some might sound racist.

Once this is approved I'll rename annotation-black-list and annotation-white-list in the master branch.

Commits
-------

9c4120b Enhancement: Social justification applied

Author: keradus

README.rst

@@ -193,14 +193,14 @@ apply (the rule names must be separated by a comma):
 
     $ php php-cs-fixer.phar fix /path/to/dir --rules=line_ending,full_opening_tag,indentation_type
 
-You can also blacklist the rules you don't want by placing a dash in front of the rule name, if this is more convenient,
+You can also exclude the rules you don't want by placing a dash in front of the rule name, if this is more convenient,
 using ``-name_of_fixer``:
 
 .. code-block:: bash
 
     $ php php-cs-fixer.phar fix /path/to/dir --rules=-full_opening_tag,-indentation_type
 
-When using combinations of exact and blacklist rules, applying exact rules along with above blacklisted results:
+When using combinations of exact and exclude rules, applying exact rules along with above excluded results:
 
 .. code-block:: bash
 
@@ -677,8 +677,8 @@ Choose from the list of available rules:
   Configuration options:
 
   - ``annotation-black-list`` (``array``): class level annotations tags that must be
-    omitted to fix the class, even if all of the white list ones are used
-    as well. (case insensitive); defaults to ``['@final', '@Entity',
+    omitted to fix the class, even if all of the excluded ones are used as
+    well. (case insensitive); defaults to ``['@final', '@Entity',
     '@ORM\\Entity', '@ORM\\Mapping\\Entity', '@Mapping\\Entity']``
   - ``annotation-white-list`` (``array``): class level annotations tags that must be
     set in order to fix the class. (case insensitive); defaults to
@@ -1972,7 +1972,7 @@ Both ``exclude`` and ``notPath`` methods accept only relative paths to the ones
 See `Symfony\\Finder <https://symfony.com/doc/current/components/finder.html>`_
 online documentation for other `Finder` methods.
 
-You may also use a blacklist for the rules instead of the above shown whitelist approach.
+You may also use an exclude list for the rules instead of the above shown include approach.
 The following example shows how to use all ``Symfony`` rules but the ``full_opening_tag`` rule.
 
 .. code-block:: php

src/Console/Command/HelpCommand.php

@@ -94,12 +94,12 @@ public static function getHelpCopy()
 
     <info>$ php %command.full_name% /path/to/dir --rules=line_ending,full_opening_tag,indentation_type</info>
 
-You can also blacklist the rules you don't want by placing a dash in front of the rule name, if this is more convenient,
+You can also exclude the rules you don't want by placing a dash in front of the rule name, if this is more convenient,
 using <comment>-name_of_fixer</comment>:
 
     <info>$ php %command.full_name% /path/to/dir --rules=-full_opening_tag,-indentation_type</info>
 
-When using combinations of exact and blacklist rules, applying exact rules along with above blacklisted results:
+When using combinations of exact and exclude rules, applying exact rules along with above excluded results:
 
     <info>$ php %command.full_name% /path/to/project --rules=@Symfony,-@PSR1,-blank_line_before_statement,strict_comparison</info>
 
@@ -203,7 +203,7 @@ public static function getHelpCopy()
 See `Symfony\Finder` (<url>https://symfony.com/doc/current/components/finder.html</url>)
 online documentation for other `Finder` methods.
 
-You may also use a blacklist for the rules instead of the above shown whitelist approach.
+You may also use an exclude list for the rules instead of the above shown include approach.
 The following example shows how to use all ``Symfony`` rules but the ``full_opening_tag`` rule.
 
     <?php

src/Fixer/ClassNotation/FinalInternalClassFixer.php

@@ -44,7 +44,7 @@ public function configure(array $configuration = null)
         );
 
         if (\count($intersect)) {
-            throw new InvalidFixerConfigurationException($this->getName(), sprintf('Annotation cannot be used in both the white- and black list, got duplicates: "%s".', implode('", "', array_keys($intersect))));
+            throw new InvalidFixerConfigurationException($this->getName(), sprintf('Annotation cannot be used in both the include and exclude list, got duplicates: "%s".', implode('", "', array_keys($intersect))));
         }
     }
 
@@ -152,7 +152,7 @@ protected function createConfigurationDefinition()
                 ->setDefault(['@internal'])
                 ->setNormalizer($annotationsNormalizer)
                 ->getOption(),
-            (new FixerOptionBuilder('annotation-black-list', 'Class level annotations tags that must be omitted to fix the class, even if all of the white list ones are used as well. (case insensitive)'))
+            (new FixerOptionBuilder('annotation-black-list', 'Class level annotations tags that must be omitted to fix the class, even if all of the excluded ones are used as well. (case insensitive)'))
                 ->setAllowedTypes(['array'])
                 ->setAllowedValues($annotationsAsserts)
                 ->setDefault([
@@ -196,7 +196,7 @@ private function isClassCandidate(Tokens $tokens, $index)
             $tag = strtolower(substr(array_shift($matches), 1));
             foreach ($this->configuration['annotation-black-list'] as $tagStart => $true) {
                 if (0 === strpos($tag, $tagStart)) {
-                    return false; // ignore class: class-level PHPDoc contains tag that has been black listed through configuration
+                    return false; // ignore class: class-level PHPDoc contains tag that has been excluded through configuration
                 }
             }
 
@@ -205,7 +205,7 @@ private function isClassCandidate(Tokens $tokens, $index)
 
         foreach ($this->configuration['annotation-white-list'] as $tag => $true) {
             if (!isset($tags[$tag])) {
-                return false; // ignore class: class-level PHPDoc does not contain all tags that has been white listed through configuration
+                return false; // ignore class: class-level PHPDoc does not contain all tags that has been included through configuration
             }
         }
 

src/Fixer/ControlStructure/NoUnneededCurlyBracesFixer.php

@@ -131,9 +131,9 @@ private function findCurlyBraceOpen(Tokens $tokens)
      */
     private function isOverComplete(Tokens $tokens, $index)
     {
-        static $whiteList = ['{', '}', [T_OPEN_TAG], ':', ';'];
+        static $include = ['{', '}', [T_OPEN_TAG], ':', ';'];
 
-        return $tokens[$tokens->getPrevMeaningfulToken($index)]->equalsAny($whiteList);
+        return $tokens[$tokens->getPrevMeaningfulToken($index)]->equalsAny($include);
     }
 
     private function clearIfIsOverCompleteNamespaceBlock(Tokens $tokens)

src/Fixer/FunctionNotation/PhpdocToReturnTypeFixer.php

@@ -34,7 +34,7 @@ final class PhpdocToReturnTypeFixer extends AbstractFixer implements Configurati
     /**
      * @var array<int, array<int, int|string>>
      */
-    private $blacklistFuncNames = [
+    private $excludeFuncNames = [
         [T_STRING, '__construct'],
         [T_STRING, '__destruct'],
         [T_STRING, '__clone'],
@@ -179,7 +179,7 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens)
             }
 
             $funcName = $tokens->getNextMeaningfulToken($index);
-            if ($tokens[$funcName]->equalsAny($this->blacklistFuncNames, false)) {
+            if ($tokens[$funcName]->equalsAny($this->excludeFuncNames, false)) {
                 continue;
             }
 

src/Fixer/FunctionNotation/VoidReturnFixer.php

@@ -78,7 +78,7 @@ public function isRisky()
     protected function applyFix(\SplFileInfo $file, Tokens $tokens)
     {
         // These cause syntax errors.
-        static $blacklistFuncNames = [
+        static $excludeFuncNames = [
             [T_STRING, '__construct'],
             [T_STRING, '__destruct'],
             [T_STRING, '__clone'],
@@ -90,7 +90,7 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens)
             }
 
             $funcName = $tokens->getNextMeaningfulToken($index);
-            if ($tokens[$funcName]->equalsAny($blacklistFuncNames, false)) {
+            if ($tokens[$funcName]->equalsAny($excludeFuncNames, false)) {
                 continue;
             }
 

tests/Fixer/ClassNotation/FinalInternalClassFixerTest.php

@@ -289,7 +289,7 @@ public function testConfigureSameAnnotationInBothLists()
     {
         $this->expectException(\PhpCsFixer\ConfigurationException\InvalidFixerConfigurationException::class);
         $this->expectExceptionMessageRegExp(
-            sprintf('#^%s$#', preg_quote('[final_internal_class] Annotation cannot be used in both the white- and black list, got duplicates: "internal123".', '#'))
+            sprintf('#^%s$#', preg_quote('[final_internal_class] Annotation cannot be used in both the include and exclude list, got duplicates: "internal123".', '#'))
         );
 
         $this->fixer->configure([

tests/Fixer/FunctionNotation/PhpdocToReturnTypeFixerTest.php

@@ -69,7 +69,7 @@ public function provideFixCases()
             'invalid class 5' => [
                 '<?php /** @return I\Want\To\Break\Free */ function queen() {}',
             ],
-            'blacklisted class methods' => [
+            'excluded class methods' => [
                 '<?php
 
                     class Foo