More work on removing the blacklist/whitelist terminology

sebastianbergmann · Jun 7, 2020 · 28e1d58 · 28e1d58
1 parent 7b3fdaf
commit 28e1d58
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 30 deletions.
diff --git a/src/TextUI/Configuration/Filter/Filter.php b/src/TextUI/Configuration/Filter/Filter.php
@@ -38,24 +38,24 @@ final class Filter
     /**
      * @var bool
      */
-    private $addUncoveredFilesFromWhitelist;
+    private $includeUncoveredFilesInCodeCoverageReport;
 
     /**
      * @var bool
      */
-    private $processUncoveredFilesFromWhitelist;
+    private $processUncoveredFilesForCodeCoverageReport;
 
-    public function __construct(FilterDirectoryCollection $directories, FilterFileCollection $files, FilterDirectoryCollection $excludeDirectories, FilterFileCollection $excludeFiles, bool $addUncoveredFilesFromWhitelist, bool $processUncoveredFilesFromWhitelist)
+    public function __construct(FilterDirectoryCollection $directories, FilterFileCollection $files, FilterDirectoryCollection $excludeDirectories, FilterFileCollection $excludeFiles, bool $includeUncoveredFilesInCodeCoverageReport, bool $processUncoveredFilesForCodeCoverageReport)
     {
-        $this->directories                        = $directories;
-        $this->files                              = $files;
-        $this->excludeDirectories                 = $excludeDirectories;
-        $this->excludeFiles                       = $excludeFiles;
-        $this->addUncoveredFilesFromWhitelist     = $addUncoveredFilesFromWhitelist;
-        $this->processUncoveredFilesFromWhitelist = $processUncoveredFilesFromWhitelist;
+        $this->directories                                = $directories;
+        $this->files                                      = $files;
+        $this->excludeDirectories                         = $excludeDirectories;
+        $this->excludeFiles                               = $excludeFiles;
+        $this->includeUncoveredFilesInCodeCoverageReport  = $includeUncoveredFilesInCodeCoverageReport;
+        $this->processUncoveredFilesForCodeCoverageReport = $processUncoveredFilesForCodeCoverageReport;
     }
 
-    public function hasNonEmptyWhitelist(): bool
+    public function hasNonEmptyListOfFilesToBeIncludedInCodeCoverageReport(): bool
     {
         return \count($this->directories) > 0 || \count($this->files) > 0;
     }
@@ -80,13 +80,13 @@ public function excludeFiles(): FilterFileCollection
         return $this->excludeFiles;
     }
 
-    public function addUncoveredFilesFromWhitelist(): bool
+    public function includeUncoveredFilesInCodeCoverageReport(): bool
     {
-        return $this->addUncoveredFilesFromWhitelist;
+        return $this->includeUncoveredFilesInCodeCoverageReport;
     }
 
-    public function processUncoveredFilesFromWhitelist(): bool
+    public function processUncoveredFilesForCodeCoverageReport(): bool
     {
-        return $this->processUncoveredFilesFromWhitelist;
+        return $this->processUncoveredFilesForCodeCoverageReport;
     }
 }
diff --git a/src/TextUI/Configuration/Loader.php b/src/TextUI/Configuration/Loader.php
@@ -323,8 +323,8 @@ private function getConfigurationArguments(string $filename, \DOMNodeList $nodes
 
     private function filter(string $filename, \DOMXPath $xpath): Filter
     {
-        $addUncoveredFilesFromWhitelist     = true;
-        $processUncoveredFilesFromWhitelist = false;
+        $includeUncoveredFilesInCodeCoverageReport  = true;
+        $processUncoveredFilesForCodeCoverageReport = false;
 
         $nodes = $xpath->query('filter/whitelist');
 
@@ -334,14 +334,14 @@ private function filter(string $filename, \DOMXPath $xpath): Filter
             \assert($node instanceof \DOMElement);
 
             if ($node->hasAttribute('addUncoveredFilesFromWhitelist')) {
-                $addUncoveredFilesFromWhitelist = (bool) $this->getBoolean(
+                $includeUncoveredFilesInCodeCoverageReport = (bool) $this->getBoolean(
                     (string) $node->getAttribute('addUncoveredFilesFromWhitelist'),
                     true
                 );
             }
 
             if ($node->hasAttribute('processUncoveredFilesFromWhitelist')) {
-                $processUncoveredFilesFromWhitelist = (bool) $this->getBoolean(
+                $processUncoveredFilesForCodeCoverageReport = (bool) $this->getBoolean(
                     (string) $node->getAttribute('processUncoveredFilesFromWhitelist'),
                     false
                 );
@@ -353,8 +353,8 @@ private function filter(string $filename, \DOMXPath $xpath): Filter
             $this->readFilterFiles($filename, $xpath, 'filter/whitelist/file'),
             $this->readFilterDirectories($filename, $xpath, 'filter/whitelist/exclude/directory'),
             $this->readFilterFiles($filename, $xpath, 'filter/whitelist/exclude/file'),
-            $addUncoveredFilesFromWhitelist,
-            $processUncoveredFilesFromWhitelist
+            $includeUncoveredFilesInCodeCoverageReport,
+            $processUncoveredFilesForCodeCoverageReport
         );
     }
 

diff --git a/src/TextUI/TestRunner.php b/src/TextUI/TestRunner.php
@@ -493,7 +493,7 @@ public function run(TestSuite $suite, array $arguments = [], array $warnings = [
 
                 $filterConfiguration = $arguments['configuration']->filter();
 
-                if ($filterConfiguration->hasNonEmptyWhitelist()) {
+                if ($filterConfiguration->hasNonEmptyListOfFilesToBeIncludedInCodeCoverageReport()) {
                     $whitelistFromConfigurationFile = true;
 
                     foreach ($filterConfiguration->directories() as $directory) {
@@ -555,13 +555,13 @@ public function run(TestSuite $suite, array $arguments = [], array $warnings = [
 
                 $filterConfiguration = $arguments['configuration']->filter();
 
-                if ($filterConfiguration->hasNonEmptyWhitelist()) {
+                if ($filterConfiguration->hasNonEmptyListOfFilesToBeIncludedInCodeCoverageReport()) {
                     $codeCoverage->setAddUncoveredFilesFromWhitelist(
-                        $filterConfiguration->addUncoveredFilesFromWhitelist()
+                        $filterConfiguration->includeUncoveredFilesInCodeCoverageReport()
                     );
 
                     $codeCoverage->setProcessUncoveredFilesFromWhitelist(
-                        $filterConfiguration->processUncoveredFilesFromWhitelist()
+                        $filterConfiguration->processUncoveredFilesForCodeCoverageReport()
                     );
                 }
             }
@@ -1041,7 +1041,6 @@ private function handleConfiguration(array &$arguments): void
 
         unset($extensionHandler);
 
-        $arguments['addUncoveredFilesFromWhitelist']                  = $arguments['addUncoveredFilesFromWhitelist'] ?? true;
         $arguments['backupGlobals']                                   = $arguments['backupGlobals'] ?? null;
         $arguments['backupStaticAttributes']                          = $arguments['backupStaticAttributes'] ?? null;
         $arguments['beStrictAboutChangesToGlobalState']               = $arguments['beStrictAboutChangesToGlobalState'] ?? null;
@@ -1067,9 +1066,10 @@ private function handleConfiguration(array &$arguments): void
         $arguments['failOnSkipped']                                   = $arguments['failOnSkipped'] ?? false;
         $arguments['failOnWarning']                                   = $arguments['failOnWarning'] ?? false;
         $arguments['groups']                                          = $arguments['groups'] ?? [];
+        $arguments['includeUncoveredFilesInCodeCoverageReport']       = $arguments['includeUncoveredFilesInCodeCoverageReport'] ?? true;
         $arguments['noInteraction']                                   = $arguments['noInteraction'] ?? false;
         $arguments['processIsolation']                                = $arguments['processIsolation'] ?? false;
-        $arguments['processUncoveredFilesFromWhitelist']              = $arguments['processUncoveredFilesFromWhitelist'] ?? false;
+        $arguments['processUncoveredFilesForCodeCoverageReport']      = $arguments['processUncoveredFilesForCodeCoverageReport'] ?? false;
         $arguments['randomOrderSeed']                                 = $arguments['randomOrderSeed'] ?? \time();
         $arguments['registerMockObjectsFromTestArgumentsRecursively'] = $arguments['registerMockObjectsFromTestArgumentsRecursively'] ?? false;
         $arguments['repeat']                                          = $arguments['repeat'] ?? false;

diff --git a/src/Util/XdebugFilterScriptGenerator.php b/src/Util/XdebugFilterScriptGenerator.php
@@ -25,7 +25,7 @@ static function ($item) {
                     $item
                 );
             },
-            $this->getWhitelistItems($filter)
+            $this->getItems($filter)
         );
 
         $files = \implode(",\n", $files);
@@ -47,7 +47,7 @@ static function ($item) {
 EOF;
     }
 
-    private function getWhitelistItems(FilterConfiguration $filter): array
+    private function getItems(FilterConfiguration $filter): array
     {
         $files = [];
 

diff --git a/tests/unit/Util/ConfigurationTest.php b/tests/unit/Util/ConfigurationTest.php
@@ -162,8 +162,8 @@ public function testFilterConfigurationIsReadCorrectly(): void
     {
         $filter = $this->configuration->filter();
 
-        $this->assertTrue($filter->addUncoveredFilesFromWhitelist());
-        $this->assertFalse($filter->processUncoveredFilesFromWhitelist());
+        $this->assertTrue($filter->includeUncoveredFilesInCodeCoverageReport());
+        $this->assertFalse($filter->processUncoveredFilesForCodeCoverageReport());
 
         /** @var FilterDirectory $directory */
         $directory = \iterator_to_array($filter->directories(), false)[0];