Implement tab-based navigation between line coverage, branch coverage, and path coverage

Author: sebastianbergmann

src/Report/Html/Renderer/File.php

@@ -218,6 +218,12 @@ public function render(FileNode $node, string $file): void
             ],
         );
 
+        if ($this->hasBranchCoverage) {
+            $template->setVar(
+                ['tabs' => $this->renderViewTabs($node->name(), 'line')],
+            );
+        }
+
         try {
             $template->renderTo($file . '.html');
         } catch (Exception $e) {
@@ -231,6 +237,7 @@ public function render(FileNode $node, string $file): void
         if ($this->hasBranchCoverage) {
             $template->setVar(
                 [
+                    'tabs'      => $this->renderViewTabs($node->name(), 'branch'),
                     'items'     => $this->renderItems($node),
                     'lines'     => $this->renderSourceWithBranchCoverage($node),
                     'legend'    => '<p><span class="success"><strong>Fully covered</strong></span><span class="warning"><strong>Partially covered</strong></span><span class="danger"><strong>Not covered</strong></span></p>',
@@ -250,6 +257,7 @@ public function render(FileNode $node, string $file): void
 
             $template->setVar(
                 [
+                    'tabs'      => $this->renderViewTabs($node->name(), 'path'),
                     'items'     => $this->renderItems($node),
                     'lines'     => $this->renderSourceWithPathCoverage($node),
                     'legend'    => '<p><span class="success"><strong>Fully covered</strong></span><span class="warning"><strong>Partially covered</strong></span><span class="danger"><strong>Not covered</strong></span></p>',
@@ -589,6 +597,34 @@ private function renderSourceWithLineCoverage(FileNode $node): string
         return $linesTemplate->render();
     }
 
+    private function renderViewTabs(string $fileName, string $activeView): string
+    {
+        $tabs = [
+            'line'   => ['href' => $fileName . '.html', 'label' => 'Line Coverage'],
+            'branch' => ['href' => $fileName . '_branch.html', 'label' => 'Branch Coverage'],
+            'path'   => ['href' => $fileName . '_path.html', 'label' => 'Path Coverage'],
+        ];
+
+        $html = '   <ul class="nav nav-tabs mb-3">' . "\n";
+
+        foreach ($tabs as $view => $tab) {
+            $active = $view === $activeView ? ' active' : '';
+            $aria   = $view === $activeView ? ' aria-current="page"' : '';
+
+            $html .= sprintf(
+                '    <li class="nav-item"><a class="nav-link%s" href="%s"%s>%s</a></li>' . "\n",
+                $active,
+                $tab['href'],
+                $aria,
+                $tab['label'],
+            );
+        }
+
+        $html .= '   </ul>';
+
+        return $html;
+    }
+
     private function renderSourceWithBranchCoverage(FileNode $node): string
     {
         $linesTemplate      = new Template($this->templatePath . 'lines.html.dist', '{{', '}}');

src/Report/Html/Renderer/Template/file_branch.html.dist

@@ -24,6 +24,7 @@
    </div>
   </header>
   <div class="container-fluid">
+{{tabs}}
    <div class="table-responsive">
     <table class="table table-bordered">
      <thead>

tests/_files/Report/HTML/PathCoverageForBankAccount/BankAccount.php.html

@@ -26,6 +26,11 @@
    </div>
   </header>
   <div class="container-fluid">
+   <ul class="nav nav-tabs mb-3">
+    <li class="nav-item"><a class="nav-link active" href="BankAccount.php.html" aria-current="page">Line Coverage</a></li>
+    <li class="nav-item"><a class="nav-link" href="BankAccount.php_branch.html">Branch Coverage</a></li>
+    <li class="nav-item"><a class="nav-link" href="BankAccount.php_path.html">Path Coverage</a></li>
+   </ul>
    <div class="table-responsive">
     <table class="table table-bordered">
      <thead>

tests/_files/Report/HTML/PathCoverageForBankAccount/BankAccount.php_branch.html

@@ -26,6 +26,11 @@
    </div>
   </header>
   <div class="container-fluid">
+   <ul class="nav nav-tabs mb-3">
+    <li class="nav-item"><a class="nav-link" href="BankAccount.php.html">Line Coverage</a></li>
+    <li class="nav-item"><a class="nav-link active" href="BankAccount.php_branch.html" aria-current="page">Branch Coverage</a></li>
+    <li class="nav-item"><a class="nav-link" href="BankAccount.php_path.html">Path Coverage</a></li>
+   </ul>
    <div class="table-responsive">
     <table class="table table-bordered">
      <thead>

tests/_files/Report/HTML/PathCoverageForBankAccount/BankAccount.php_path.html

@@ -26,6 +26,11 @@
    </div>
   </header>
   <div class="container-fluid">
+   <ul class="nav nav-tabs mb-3">
+    <li class="nav-item"><a class="nav-link" href="BankAccount.php.html">Line Coverage</a></li>
+    <li class="nav-item"><a class="nav-link" href="BankAccount.php_branch.html">Branch Coverage</a></li>
+    <li class="nav-item"><a class="nav-link active" href="BankAccount.php_path.html" aria-current="page">Path Coverage</a></li>
+   </ul>
    <div class="table-responsive">
     <table class="table table-bordered">
      <thead>

tests/_files/Report/HTML/PathCoverageForSourceWithoutNamespace/source_without_namespace.php.html

@@ -26,6 +26,11 @@
    </div>
   </header>
   <div class="container-fluid">
+   <ul class="nav nav-tabs mb-3">
+    <li class="nav-item"><a class="nav-link active" href="source_without_namespace.php.html" aria-current="page">Line Coverage</a></li>
+    <li class="nav-item"><a class="nav-link" href="source_without_namespace.php_branch.html">Branch Coverage</a></li>
+    <li class="nav-item"><a class="nav-link" href="source_without_namespace.php_path.html">Path Coverage</a></li>
+   </ul>
    <div class="table-responsive">
     <table class="table table-bordered">
      <thead>

tests/_files/Report/HTML/PathCoverageForSourceWithoutNamespace/source_without_namespace.php_branch.html

@@ -26,6 +26,11 @@
    </div>
   </header>
   <div class="container-fluid">
+   <ul class="nav nav-tabs mb-3">
+    <li class="nav-item"><a class="nav-link" href="source_without_namespace.php.html">Line Coverage</a></li>
+    <li class="nav-item"><a class="nav-link active" href="source_without_namespace.php_branch.html" aria-current="page">Branch Coverage</a></li>
+    <li class="nav-item"><a class="nav-link" href="source_without_namespace.php_path.html">Path Coverage</a></li>
+   </ul>
    <div class="table-responsive">
     <table class="table table-bordered">
      <thead>

tests/_files/Report/HTML/PathCoverageForSourceWithoutNamespace/source_without_namespace.php_path.html

@@ -26,6 +26,11 @@
    </div>
   </header>
   <div class="container-fluid">
+   <ul class="nav nav-tabs mb-3">
+    <li class="nav-item"><a class="nav-link" href="source_without_namespace.php.html">Line Coverage</a></li>
+    <li class="nav-item"><a class="nav-link" href="source_without_namespace.php_branch.html">Branch Coverage</a></li>
+    <li class="nav-item"><a class="nav-link active" href="source_without_namespace.php_path.html" aria-current="page">Path Coverage</a></li>
+   </ul>
    <div class="table-responsive">
     <table class="table table-bordered">
      <thead>