Add option to disable the generation of the class-oriented HTML report

Author: sebastianbergmann

src/Report/Html/Facade.php

@@ -43,13 +43,15 @@
     private Colors $colors;
     private Thresholds $thresholds;
     private CustomCssFile $customCssFile;
+    private bool $classView;
 
-    public function __construct(string $generator = '', ?Colors $colors = null, ?Thresholds $thresholds = null, ?CustomCssFile $customCssFile = null)
+    public function __construct(string $generator = '', ?Colors $colors = null, ?Thresholds $thresholds = null, ?CustomCssFile $customCssFile = null, bool $classView = true)
     {
         $this->generator     = $generator;
         $this->colors        = $colors ?? Colors::default();
         $this->thresholds    = $thresholds ?? Thresholds::default();
         $this->customCssFile = $customCssFile ?? CustomCssFile::default();
+        $this->classView     = $classView;
         $this->templatePath  = __DIR__ . '/Renderer/Template/';
     }
 
@@ -60,12 +62,19 @@ public function process(DirectoryNode $report, string $target): void
         $hasBranchCoverage = $report->numberOfExecutableBranches() > 0;
         $hasPathCoverage   = $report->numberOfExecutablePaths() > 0;
 
-        $builder        = new Builder;
-        $rootNamespace  = $builder->build($report);
-        $fileToClassMap = $this->buildFileToClassMap($rootNamespace);
+        $fileToClassMap = [];
+
+        if ($this->classView) {
+            $rootNamespace  = new Builder()->build($report);
+            $fileToClassMap = $this->buildFileToClassMap($rootNamespace);
+        }
 
         $this->renderFileView($report, $target, $date, $hasBranchCoverage, $hasPathCoverage, $fileToClassMap);
-        $this->renderClassView($rootNamespace, $target, $date, $hasBranchCoverage, $hasPathCoverage);
+
+        if (isset($rootNamespace)) {
+            $this->renderClassView($rootNamespace, $target, $date, $hasBranchCoverage, $hasPathCoverage);
+        }
+
         $this->copyFiles($target);
         $this->renderCss($target);
     }
@@ -81,6 +90,12 @@ private function renderFileView(DirectoryNode $report, string $target, string $d
 
         $file->setFileToClassMap($fileToClassMap);
 
+        if (!$this->classView) {
+            $dashboard->disableClassView();
+            $directory->disableClassView();
+            $file->disableClassView();
+        }
+
         $directory->render($report, $target . 'index.html');
         $dashboard->render($report, $target . 'dashboard.html');
 

src/Report/Html/Renderer.php

@@ -77,6 +77,7 @@ abstract class Renderer
      * @var array<string, string>
      */
     private array $fileToClassMap = [];
+    private bool $classView       = true;
 
     public function __construct(string $templatePath, string $generator, string $date, Thresholds $thresholds, bool $hasBranchCoverage, bool $hasPathCoverage)
     {
@@ -98,6 +99,11 @@ public function setFileToClassMap(array $map): void
         $this->fileToClassMap = $map;
     }
 
+    public function disableClassView(): void
+    {
+        $this->classView = false;
+    }
+
     /**
      * @return non-empty-string
      */
@@ -263,7 +269,7 @@ protected function setCommonTemplateVariables(Template $template, AbstractNode $
                 'generator'        => $this->generator,
                 'low_upper_bound'  => (string) $this->thresholds->lowUpperBound(),
                 'high_lower_bound' => (string) $this->thresholds->highLowerBound(),
-                'view_switcher'    => $this->viewSwitcher($pathToRoot, 'files', 'index.html', $classesTarget),
+                'view_switcher'    => $this->classView ? $this->viewSwitcher($pathToRoot, 'files', 'index.html', $classesTarget) : '',
             ],
         );
     }

tests/tests/Report/Html/FacadeTest.php

@@ -64,6 +64,34 @@ public function testProcessRendersFilesInSubdirectoriesAndClassesInNestedNamespa
         $this->assertStringContainsString('_classes/App/Models/User.html', $fileHtml);
     }
 
+    public function testProcessCanSkipTheClassView(): void
+    {
+        $target = TEST_FILES_PATH . 'tmp' . DIRECTORY_SEPARATOR;
+        $report = $this->buildReportWithNestedNamespacesAndSubdirectory();
+
+        (new Facade('', null, null, null, false))->process($report, $target);
+
+        $this->assertDirectoryDoesNotExist($target . '_classes');
+
+        $index = file_get_contents($target . 'index.html');
+
+        $this->assertNotFalse($index);
+        $this->assertStringNotContainsString('_classes/', $index);
+        $this->assertStringNotContainsString('nav-tabs', $index);
+
+        $fileHtml = file_get_contents($target . 'sub/User.php.html');
+
+        $this->assertNotFalse($fileHtml);
+        $this->assertStringNotContainsString('_classes/', $fileHtml);
+        $this->assertStringNotContainsString('nav-tabs', $fileHtml);
+
+        $dashboard = file_get_contents($target . 'dashboard.html');
+
+        $this->assertNotFalse($dashboard);
+        $this->assertStringNotContainsString('_classes/', $dashboard);
+        $this->assertStringNotContainsString('nav-tabs', $dashboard);
+    }
+
     private function buildReportWithNestedNamespacesAndSubdirectory(): DirectoryNode
     {
         $rootPath = TEST_FILES_PATH . 'FacadeNested';