3 * This file is part of the PHP_CodeCoverage package.
5 * (c) Sebastian Bergmann <sebastian@phpunit.de>
7 * For the full copyright and license information, please view the LICENSE
8 * file that was distributed with this source code.
11 use SebastianBergmann\Environment\Runtime;
14 * Base class for PHP_CodeCoverage_Report_Node renderers.
16 * @since Class available since Release 1.1.0
18 abstract class PHP_CodeCoverage_Report_HTML_Renderer
23 protected $templatePath;
38 protected $lowUpperBound;
43 protected $highLowerBound;
53 * @param string $templatePath
54 * @param string $generator
56 * @param int $lowUpperBound
57 * @param int $highLowerBound
59 public function __construct($templatePath, $generator, $date, $lowUpperBound, $highLowerBound)
61 $version = new SebastianBergmann\Version('2.2.4', dirname(dirname(dirname(dirname(__DIR__)))));
63 $this->templatePath = $templatePath;
64 $this->generator = $generator;
66 $this->lowUpperBound = $lowUpperBound;
67 $this->highLowerBound = $highLowerBound;
68 $this->version = $version->getVersion();
72 * @param Text_Template $template
76 protected function renderItemTemplate(Text_Template $template, array $data)
78 $numSeparator = ' / ';
80 if (isset($data['numClasses']) && $data['numClasses'] > 0) {
81 $classesLevel = $this->getColorLevel($data['testedClassesPercent']);
83 $classesNumber = $data['numTestedClasses'] . $numSeparator .
86 $classesBar = $this->getCoverageBar(
87 $data['testedClassesPercent']
90 $classesLevel = 'success';
91 $classesNumber = '0' . $numSeparator . '0';
92 $classesBar = $this->getCoverageBar(100);
95 if ($data['numMethods'] > 0) {
96 $methodsLevel = $this->getColorLevel($data['testedMethodsPercent']);
98 $methodsNumber = $data['numTestedMethods'] . $numSeparator .
101 $methodsBar = $this->getCoverageBar(
102 $data['testedMethodsPercent']
105 $methodsLevel = 'success';
106 $methodsNumber = '0' . $numSeparator . '0';
107 $methodsBar = $this->getCoverageBar(100);
108 $data['testedMethodsPercentAsString'] = '100.00%';
111 if ($data['numExecutableLines'] > 0) {
112 $linesLevel = $this->getColorLevel($data['linesExecutedPercent']);
114 $linesNumber = $data['numExecutedLines'] . $numSeparator .
115 $data['numExecutableLines'];
117 $linesBar = $this->getCoverageBar(
118 $data['linesExecutedPercent']
121 $linesLevel = 'success';
122 $linesNumber = '0' . $numSeparator . '0';
123 $linesBar = $this->getCoverageBar(100);
124 $data['linesExecutedPercentAsString'] = '100.00%';
129 'icon' => isset($data['icon']) ? $data['icon'] : '',
130 'crap' => isset($data['crap']) ? $data['crap'] : '',
131 'name' => $data['name'],
132 'lines_bar' => $linesBar,
133 'lines_executed_percent' => $data['linesExecutedPercentAsString'],
134 'lines_level' => $linesLevel,
135 'lines_number' => $linesNumber,
136 'methods_bar' => $methodsBar,
137 'methods_tested_percent' => $data['testedMethodsPercentAsString'],
138 'methods_level' => $methodsLevel,
139 'methods_number' => $methodsNumber,
140 'classes_bar' => $classesBar,
141 'classes_tested_percent' => isset($data['testedClassesPercentAsString']) ? $data['testedClassesPercentAsString'] : '',
142 'classes_level' => $classesLevel,
143 'classes_number' => $classesNumber
147 return $template->render();
151 * @param Text_Template $template
152 * @param PHP_CodeCoverage_Report_Node $node
154 protected function setCommonTemplateVariables(Text_Template $template, PHP_CodeCoverage_Report_Node $node)
156 $runtime = new Runtime;
160 'id' => $node->getId(),
161 'full_path' => $node->getPath(),
162 'path_to_root' => $this->getPathToRoot($node),
163 'breadcrumbs' => $this->getBreadcrumbs($node),
164 'date' => $this->date,
165 'version' => $this->version,
166 'runtime_name' => $runtime->getName(),
167 'runtime_version' => $runtime->getVersion(),
168 'runtime_link' => $runtime->getVendorUrl(),
169 'generator' => $this->generator,
170 'low_upper_bound' => $this->lowUpperBound,
171 'high_lower_bound' => $this->highLowerBound
176 protected function getBreadcrumbs(PHP_CodeCoverage_Report_Node $node)
179 $path = $node->getPathAsArray();
180 $pathToRoot = array();
183 if ($node instanceof PHP_CodeCoverage_Report_Node_File) {
187 for ($i = 0; $i < $max; $i++) {
188 $pathToRoot[] = str_repeat('../', $i);
191 foreach ($path as $step) {
192 if ($step !== $node) {
193 $breadcrumbs .= $this->getInactiveBreadcrumb(
195 array_pop($pathToRoot)
198 $breadcrumbs .= $this->getActiveBreadcrumb($step);
205 protected function getActiveBreadcrumb(PHP_CodeCoverage_Report_Node $node)
208 ' <li class="active">%s</li>' . "\n",
212 if ($node instanceof PHP_CodeCoverage_Report_Node_Directory) {
213 $buffer .= ' <li>(<a href="dashboard.html">Dashboard</a>)</li>' . "\n";
219 protected function getInactiveBreadcrumb(PHP_CodeCoverage_Report_Node $node, $pathToRoot)
222 ' <li><a href="%sindex.html">%s</a></li>' . "\n",
228 protected function getPathToRoot(PHP_CodeCoverage_Report_Node $node)
230 $id = $node->getId();
231 $depth = substr_count($id, '/');
233 if ($id != 'index' &&
234 $node instanceof PHP_CodeCoverage_Report_Node_Directory) {
238 return str_repeat('../', $depth);
241 protected function getCoverageBar($percent)
243 $level = $this->getColorLevel($percent);
245 $template = new Text_Template(
246 $this->templatePath . 'coverage_bar.html',
251 $template->setVar(array('level' => $level, 'percent' => sprintf('%.2F', $percent)));
253 return $template->render();
257 * @param int $percent
260 protected function getColorLevel($percent)
262 if ($percent <= $this->lowUpperBound) {
264 } elseif ($percent > $this->lowUpperBound &&
265 $percent < $this->highLowerBound) {