Skip to content

Commit 087b1e7

Browse files
sebastianbergmannsebastianbergmann
committed
Redesign the HTML code coverage report.
1 parent 96e2892 commit 087b1e7

34 files changed

+736
-1659
lines changed

‎ChangeLog.markdown‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ This is the list of changes for the PHP_CodeCoverage 1.2 release series.
66
PHP_CodeCoverage 1.2.0
77
----------------------
88

9+
* The HTML report has been redesigned.
910
* The new `@coversDefaultClass` annotation enables short `@covers` annotations when working with long class names or namespaces.
1011
* The new `@coversNothing` annotation can be used so tests do not record any code coverage. Useful for integration testing.
1112
* When `processUncoveredFilesFromWhitelist=FALSE` is set then files that are whitelisted and uncovered are now included in the code coverage but with all lines, including those that are not executable, counted as not executed.

‎PHP/CodeCoverage/Report/HTML.php‎

Lines changed: 15 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -92,25 +92,19 @@ class PHP_CodeCoverage_Report_HTML
9292
*/
9393
protected $title;
9494

95-
/**
96-
* @var boolean
97-
*/
98-
protected $yui;
99-
10095
/**
10196
* Constructor.
10297
*
10398
* @param array $options
10499
*/
105-
public function __construct($title = '', $charset = 'UTF-8', $yui = TRUE, $highlight = FALSE, $lowUpperBound = 35, $highLowerBound = 70, $generator = '')
100+
public function __construct($title = '', $charset = 'UTF-8', $highlight = FALSE, $lowUpperBound = 35, $highLowerBound = 70, $generator = '')
106101
{
107102
$this->charset = $charset;
108103
$this->generator = $generator;
109104
$this->highLowerBound = $highLowerBound;
110105
$this->highlight = $highlight;
111106
$this->lowUpperBound = $lowUpperBound;
112107
$this->title = $title;
113-
$this->yui = $yui;
114108

115109
$this->templatePath = sprintf(
116110
'%s%sHTML%sRenderer%sTemplate%s',
@@ -164,8 +158,7 @@ public function process(PHP_CodeCoverage $coverage, $target)
164158
$date,
165159
$this->lowUpperBound,
166160
$this->highLowerBound,
167-
$this->highlight,
168-
$this->yui
161+
$this->highlight
169162
);
170163

171164
$dashboard->render(
@@ -193,22 +186,19 @@ public function process(PHP_CodeCoverage $coverage, $target)
193186
*/
194187
protected function copyFiles($target)
195188
{
196-
$files = array(
197-
'close12_1.gif',
198-
'container.css',
199-
'container-min.js',
200-
'directory.png',
201-
'file.png',
202-
'glass.png',
203-
'highcharts.js',
204-
'jquery.min.js',
205-
'style.css',
206-
'yahoo-dom-event.js'
207-
);
208-
209-
foreach ($files as $file) {
210-
copy($this->templatePath . $file, $target . $file);
211-
}
189+
$dir = $this->getDirectory($target . 'css');
190+
copy($this->templatePath . 'css/bootstrap.min.css', $dir . 'bootstrap.min.css');
191+
copy($this->templatePath . 'css/bootstrap-responsive.min.css', $dir . 'bootstrap-responsive.min.css');
192+
copy($this->templatePath . 'css/style.css', $dir . 'style.css');
193+
194+
$dir = $this->getDirectory($target . 'js');
195+
copy($this->templatePath . 'js/bootstrap.min.js', $dir . 'bootstrap.min.js');
196+
copy($this->templatePath . 'js/highcharts.js', $dir . 'highcharts.js');
197+
copy($this->templatePath . 'js/jquery.min.js', $dir . 'jquery.min.js');
198+
199+
$dir = $this->getDirectory($target . 'img');
200+
copy($this->templatePath . 'img/glyphicons-halflings.png', $dir . 'glyphicons-halflings.png');
201+
copy($this->templatePath . 'img/glyphicons-halflings-white.png', $dir . 'glyphicons-halflings-white.png');
212202
}
213203

214204
/**

‎PHP/CodeCoverage/Report/HTML/Renderer.php‎

Lines changed: 37 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -109,27 +109,22 @@ public function __construct($templatePath, $charset, $generator, $date, $lowUppe
109109

110110
/**
111111
* @param integer $percent
112-
* @return array
112+
* @return string
113113
*/
114114
protected function getColorLevel($percent)
115115
{
116116
if ($percent < $this->lowUpperBound) {
117-
$color = 'scarlet_red';
118-
$level = 'Lo';
117+
return 'error';
119118
}
120119

121120
else if ($percent >= $this->lowUpperBound &&
122121
$percent < $this->highLowerBound) {
123-
$color = 'butter';
124-
$level = 'Med';
122+
return 'warning';
125123
}
126124

127125
else {
128-
$color = 'chameleon';
129-
$level = 'Hi';
126+
return 'success';
130127
}
131-
132-
return array($color, $level);
133128
}
134129

135130
/**
@@ -139,78 +134,65 @@ protected function getColorLevel($percent)
139134
*/
140135
protected function renderItemTemplate(Text_Template $template, array $data)
141136
{
142-
$classesBar = '&nbsp;';
143-
$classesColor = 'snow';
137+
$classesBar = '&nbsp;';
144138
$classesLevel = 'None';
145139
$classesNumber = '&nbsp;';
146140

147141
if (isset($data['numClasses']) && $data['numClasses'] > 0) {
148-
list($classesColor, $classesLevel) = $this->getColorLevel(
149-
$data['testedClassesPercent']
150-
);
142+
$classesLevel = $this->getColorLevel($data['testedClassesPercent']);
151143

152144
$classesNumber = $data['numTestedClasses'] . ' / ' .
153145
$data['numClasses'];
154146

155147
$classesBar = $this->getCoverageBar(
156-
$classesColor, $data['testedClassesPercent']
148+
$data['testedClassesPercent']
157149
);
158150
}
159151

160152
$methodsBar = '&nbsp;';
161-
$methodsColor = 'snow';
162153
$methodsLevel = 'None';
163154
$methodsNumber = '&nbsp;';
164155

165156
if ($data['numMethods'] > 0) {
166-
list($methodsColor, $methodsLevel) = $this->getColorLevel(
167-
$data['testedMethodsPercent']
168-
);
157+
$methodsLevel = $this->getColorLevel($data['testedMethodsPercent']);
169158

170159
$methodsNumber = $data['numTestedMethods'] . ' / ' .
171160
$data['numMethods'];
172161

173162
$methodsBar = $this->getCoverageBar(
174-
$methodsColor, $data['testedMethodsPercent']
163+
$data['testedMethodsPercent']
175164
);
176165
}
177166

178167
$linesBar = '&nbsp;';
179-
$linesColor = 'snow';
180168
$linesLevel = 'None';
181169
$linesNumber = '&nbsp;';
182170

183171
if ($data['numExecutableLines'] > 0) {
184-
list($linesColor, $linesLevel) = $this->getColorLevel(
185-
$data['linesExecutedPercent']
186-
);
172+
$linesLevel = $this->getColorLevel($data['linesExecutedPercent']);
187173

188174
$linesNumber = $data['numExecutedLines'] . ' / ' .
189175
$data['numExecutableLines'];
190176

191177
$linesBar = $this->getCoverageBar(
192-
$linesColor, $data['linesExecutedPercent']
178+
$data['linesExecutedPercent']
193179
);
194180
}
195181

196182
$template->setVar(
197183
array(
198-
'itemClass' => isset($data['itemClass']) ? $data['itemClass'] : '',
199184
'icon' => isset($data['icon']) ? $data['icon'] : '',
200185
'crap' => isset($data['crap']) ? $data['crap'] : '',
201186
'name' => $data['name'],
202187
'lines_bar' => $linesBar,
203-
'lines_color' => $linesColor,
204188
'lines_executed_percent' => $data['linesExecutedPercentAsString'],
205189
'lines_level' => $linesLevel,
206190
'lines_number' => $linesNumber,
207191
'methods_bar' => $methodsBar,
208-
'methods_color' => $methodsColor,
209192
'methods_tested_percent' => $data['testedMethodsPercentAsString'],
210193
'methods_level' => $methodsLevel,
211194
'methods_number' => $methodsNumber,
212195
'classes_bar' => $classesBar,
213-
'classes_color' => $classesColor,
214196
'classes_tested_percent' => isset($data['testedClassesPercentAsString']) ? $data['testedClassesPercentAsString'] : '',
215197
'classes_level' => $classesLevel,
216198
'classes_number' => $classesNumber
@@ -225,17 +207,17 @@ protected function renderItemTemplate(Text_Template $template, array $data)
225207
* @param string $title
226208
* @param PHP_CodeCoverage_Report_Node $node
227209
*/
228-
protected function setCommonTemplateVariables(Text_Template $template, $title, PHP_CodeCoverage_Report_Node $node = NULL)
210+
protected function setCommonTemplateVariables(Text_Template $template, $title, PHP_CodeCoverage_Report_Node $node)
229211
{
230-
$link = '';
212+
$navigation = '';
231213

232214
if ($node !== NULL) {
233215
$path = $node->getPathAsArray();
234216

235217
foreach ($path as $step) {
236-
$link .= sprintf(
237-
'%s<a href="%s.html">%s</a>',
238-
!empty($link) ? '/' : '',
218+
$navigation .= sprintf(
219+
' <li%s><a href="%s.html">%s</a></li>' . "\n",
220+
$step === $node ? ' class="active"' : '',
239221
$step->getId(),
240222
$step->getName()
241223
);
@@ -245,7 +227,9 @@ protected function setCommonTemplateVariables(Text_Template $template, $title, P
245227
$template->setVar(
246228
array(
247229
'title' => $title,
248-
'link' => $link,
230+
'id' => $node->getId(),
231+
'full_path' => $node->getPath(),
232+
'navigation' => $navigation,
249233
'charset' => $this->charset,
250234
'date' => $this->date,
251235
'version' => '@package_version@',
@@ -257,11 +241,26 @@ protected function setCommonTemplateVariables(Text_Template $template, $title, P
257241
);
258242
}
259243

260-
protected function getCoverageBar($color, $percent)
244+
protected function getCoverageBar($percent)
261245
{
262-
$template = new Text_Template($this->templatePath . 'coverage_bar.html');
246+
if ($percent < $this->lowUpperBound) {
247+
$level = 'danger';
248+
}
249+
250+
else if ($percent >= $this->lowUpperBound &&
251+
$percent < $this->highLowerBound) {
252+
$level = 'warning';
253+
}
254+
255+
else {
256+
$level = 'success';
257+
}
258+
259+
$template = new Text_Template(
260+
$this->templatePath . 'coverage_bar.html'
261+
);
263262

264-
$template->setVar(array('color' => $color, 'percent' => $percent));
263+
$template->setVar(array('level' => $level, 'percent' => $percent));
265264

266265
return $template->render();
267266
}

‎PHP/CodeCoverage/Report/HTML/Renderer/Dashboard.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ public function render(PHP_CodeCoverage_Report_Node_Directory $node, $file, $tit
7373
$this->templatePath . 'dashboard.html'
7474
);
7575

76-
$this->setCommonTemplateVariables($template, $title);
76+
$this->setCommonTemplateVariables($template, $title, $node);
7777

7878
$template->setVar(
7979
array(

‎PHP/CodeCoverage/Report/HTML/Renderer/Directory.php‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,7 @@ protected function renderItem(PHP_CodeCoverage_Report_Node $item, $total = FALSE
115115
);
116116

117117
if ($total) {
118-
$data['itemClass'] = 'coverDirectory';
119-
$data['name'] = 'Total';
118+
$data['name'] = 'Total';
120119
} else {
121120
$data['name'] = sprintf(
122121
'<a href="%s.html">%s</a>',
@@ -125,11 +124,9 @@ protected function renderItem(PHP_CodeCoverage_Report_Node $item, $total = FALSE
125124
);
126125

127126
if ($item instanceof PHP_CodeCoverage_Report_Node_Directory) {
128-
$data['icon'] = '<img alt="directory" src="directory.png"/> ';
129-
$data['itemClass'] = 'coverDirectory';
127+
$data['icon'] = '<i class="icon-folder-open"></i> ';
130128
} else {
131-
$data['icon'] = '<img alt="file" src="file.png"/> ';
132-
$data['itemClass'] = 'coverFile';
129+
$data['icon'] = '<i class="icon-file"></i> ';
133130
}
134131
}
135132

0 commit comments

Comments
 (0)