← Back to branch summary

~ballot/wordpress/openstack-objectstorage-breaking-insight

« back to all changes in this revision

Viewing changes to vendor/phpunit/php-code-coverage/src/CodeCoverage/Report/HTML/Renderer.php

  • Committer: Jacek Nykis
  • Date: 2015-02-11 15:35:31 UTC
  • Revision ID: jacek.nykis@canonical.com-20150211153531-hmy6zi0ov2qfkl0b
Initial commit

Show diffs side-by-side

added added

removed removed

Lines of Context:
vendor/phpunit/php-code-coverage/src/CodeCoverage/Report/HTML/Renderer.php
 
1
<?php
 
2
/*
 
3
 * This file is part of the PHP_CodeCoverage package.
 
4
 *
 
5
 * (c) Sebastian Bergmann <sebastian@phpunit.de>
 
6
 *
 
7
 * For the full copyright and license information, please view the LICENSE
 
8
 * file that was distributed with this source code.
 
9
 */
 
10
 
 
11
use SebastianBergmann\Environment\Runtime;
 
12
 
 
13
/**
 
14
 * Base class for PHP_CodeCoverage_Report_Node renderers.
 
15
 *
 
16
 * @category   PHP
 
17
 * @package    CodeCoverage
 
18
 * @author     Sebastian Bergmann <sebastian@phpunit.de>
 
19
 * @copyright  Sebastian Bergmann <sebastian@phpunit.de>
 
20
 * @license    http://www.opensource.org/licenses/BSD-3-Clause  The BSD 3-Clause License
 
21
 * @link       http://github.com/sebastianbergmann/php-code-coverage
 
22
 * @since      Class available since Release 1.1.0
 
23
 */
 
24
abstract class PHP_CodeCoverage_Report_HTML_Renderer
 
25
{
 
26
    /**
 
27
     * @var string
 
28
     */
 
29
    protected $templatePath;
 
30
 
 
31
    /**
 
32
     * @var string
 
33
     */
 
34
    protected $generator;
 
35
 
 
36
    /**
 
37
     * @var string
 
38
     */
 
39
    protected $date;
 
40
 
 
41
    /**
 
42
     * @var integer
 
43
     */
 
44
    protected $lowUpperBound;
 
45
 
 
46
    /**
 
47
     * @var integer
 
48
     */
 
49
    protected $highLowerBound;
 
50
 
 
51
    /**
 
52
     * @var string
 
53
     */
 
54
    protected $version;
 
55
 
 
56
    /**
 
57
     * Constructor.
 
58
     *
 
59
     * @param string  $templatePath
 
60
     * @param string  $generator
 
61
     * @param string  $date
 
62
     * @param integer $lowUpperBound
 
63
     * @param integer $highLowerBound
 
64
     */
 
65
    public function __construct($templatePath, $generator, $date, $lowUpperBound, $highLowerBound)
 
66
    {
 
67
        $version = new SebastianBergmann\Version('2.0.15', dirname(dirname(dirname(dirname(__DIR__)))));
 
68
 
 
69
        $this->templatePath   = $templatePath;
 
70
        $this->generator      = $generator;
 
71
        $this->date           = $date;
 
72
        $this->lowUpperBound  = $lowUpperBound;
 
73
        $this->highLowerBound = $highLowerBound;
 
74
        $this->version        = $version->getVersion();
 
75
    }
 
76
 
 
77
    /**
 
78
     * @param  Text_Template $template
 
79
     * @param  array         $data
 
80
     * @return string
 
81
     */
 
82
    protected function renderItemTemplate(Text_Template $template, array $data)
 
83
    {
 
84
        $numSeperator = '&nbsp;/&nbsp;';
 
85
        $classesBar    = '&nbsp;';
 
86
        $classesLevel  = 'None';
 
87
        $classesNumber = '&nbsp;';
 
88
 
 
89
        if (isset($data['numClasses']) && $data['numClasses'] > 0) {
 
90
            $classesLevel = $this->getColorLevel($data['testedClassesPercent']);
 
91
 
 
92
            $classesNumber = $data['numTestedClasses'] . $numSeperator .
 
93
                $data['numClasses'];
 
94
 
 
95
            $classesBar = $this->getCoverageBar(
 
96
                $data['testedClassesPercent']
 
97
            );
 
98
        }
 
99
 
 
100
        $methodsBar    = '&nbsp;';
 
101
        $methodsLevel  = 'None';
 
102
        $methodsNumber = '&nbsp;';
 
103
 
 
104
        if ($data['numMethods'] > 0) {
 
105
            $methodsLevel = $this->getColorLevel($data['testedMethodsPercent']);
 
106
 
 
107
            $methodsNumber = $data['numTestedMethods'] . $numSeperator .
 
108
                $data['numMethods'];
 
109
 
 
110
            $methodsBar = $this->getCoverageBar(
 
111
                $data['testedMethodsPercent']
 
112
            );
 
113
        }
 
114
 
 
115
        $linesBar    = '&nbsp;';
 
116
        $linesLevel  = 'None';
 
117
        $linesNumber = '&nbsp;';
 
118
 
 
119
        if ($data['numExecutableLines'] > 0) {
 
120
            $linesLevel = $this->getColorLevel($data['linesExecutedPercent']);
 
121
 
 
122
            $linesNumber = $data['numExecutedLines'] . $numSeperator .
 
123
                $data['numExecutableLines'];
 
124
 
 
125
            $linesBar = $this->getCoverageBar(
 
126
                $data['linesExecutedPercent']
 
127
            );
 
128
        }
 
129
 
 
130
        $template->setVar(
 
131
            array(
 
132
                'icon' => isset($data['icon']) ? $data['icon'] : '',
 
133
                'crap' => isset($data['crap']) ? $data['crap'] : '',
 
134
                'name' => $data['name'],
 
135
                'lines_bar' => $linesBar,
 
136
                'lines_executed_percent' => $data['linesExecutedPercentAsString'],
 
137
                'lines_level' => $linesLevel,
 
138
                'lines_number' => $linesNumber,
 
139
                'methods_bar' => $methodsBar,
 
140
                'methods_tested_percent' => $data['testedMethodsPercentAsString'],
 
141
                'methods_level' => $methodsLevel,
 
142
                'methods_number' => $methodsNumber,
 
143
                'classes_bar' => $classesBar,
 
144
                'classes_tested_percent' => isset($data['testedClassesPercentAsString']) ? $data['testedClassesPercentAsString'] : '',
 
145
                'classes_level' => $classesLevel,
 
146
                'classes_number' => $classesNumber
 
147
            )
 
148
        );
 
149
 
 
150
        return $template->render();
 
151
    }
 
152
 
 
153
    /**
 
154
     * @param Text_Template                $template
 
155
     * @param PHP_CodeCoverage_Report_Node $node
 
156
     */
 
157
    protected function setCommonTemplateVariables(Text_Template $template, PHP_CodeCoverage_Report_Node $node)
 
158
    {
 
159
        $runtime = new Runtime;
 
160
 
 
161
        $template->setVar(
 
162
            array(
 
163
                'id'               => $node->getId(),
 
164
                'full_path'        => $node->getPath(),
 
165
                'path_to_root'     => $this->getPathToRoot($node),
 
166
                'breadcrumbs'      => $this->getBreadcrumbs($node),
 
167
                'date'             => $this->date,
 
168
                'version'          => $this->version,
 
169
                'runtime_name'     => $runtime->getName(),
 
170
                'runtime_version'  => $runtime->getVersion(),
 
171
                'runtime_link'     => $runtime->getVendorUrl(),
 
172
                'generator'        => $this->generator,
 
173
                'low_upper_bound'  => $this->lowUpperBound,
 
174
                'high_lower_bound' => $this->highLowerBound
 
175
            )
 
176
        );
 
177
    }
 
178
 
 
179
    protected function getBreadcrumbs(PHP_CodeCoverage_Report_Node $node)
 
180
    {
 
181
        $breadcrumbs = '';
 
182
        $path        = $node->getPathAsArray();
 
183
        $pathToRoot  = array();
 
184
        $max         = count($path);
 
185
 
 
186
        if ($node instanceof PHP_CodeCoverage_Report_Node_File) {
 
187
            $max--;
 
188
        }
 
189
 
 
190
        for ($i = 0; $i < $max; $i++) {
 
191
            $pathToRoot[] = str_repeat('../', $i);
 
192
        }
 
193
 
 
194
        foreach ($path as $step) {
 
195
            if ($step !== $node) {
 
196
                $breadcrumbs .= $this->getInactiveBreadcrumb(
 
197
                    $step, array_pop($pathToRoot)
 
198
                );
 
199
            } else {
 
200
                $breadcrumbs .= $this->getActiveBreadcrumb($step);
 
201
            }
 
202
        }
 
203
 
 
204
        return $breadcrumbs;
 
205
    }
 
206
 
 
207
    protected function getActiveBreadcrumb(PHP_CodeCoverage_Report_Node $node)
 
208
    {
 
209
        $buffer = sprintf(
 
210
            '        <li class="active">%s</li>' . "\n",
 
211
            $node->getName()
 
212
        );
 
213
 
 
214
        if ($node instanceof PHP_CodeCoverage_Report_Node_Directory) {
 
215
            $buffer .= '        <li>(<a href="dashboard.html">Dashboard</a>)</li>' . "\n";
 
216
        }
 
217
 
 
218
        return $buffer;
 
219
    }
 
220
 
 
221
    protected function getInactiveBreadcrumb(PHP_CodeCoverage_Report_Node $node, $pathToRoot)
 
222
    {
 
223
        return sprintf(
 
224
            '        <li><a href="%sindex.html">%s</a></li>' . "\n",
 
225
            $pathToRoot,
 
226
            $node->getName()
 
227
        );
 
228
    }
 
229
 
 
230
    protected function getPathToRoot(PHP_CodeCoverage_Report_Node $node)
 
231
    {
 
232
        $id    = $node->getId();
 
233
        $depth = substr_count($id, '/');
 
234
 
 
235
        if ($id != 'index' &&
 
236
            $node instanceof PHP_CodeCoverage_Report_Node_Directory) {
 
237
            $depth++;
 
238
        }
 
239
 
 
240
        return str_repeat('../', $depth);
 
241
    }
 
242
 
 
243
    protected function getCoverageBar($percent)
 
244
    {
 
245
        $level = $this->getColorLevel($percent);
 
246
 
 
247
        $template = new Text_Template(
 
248
            $this->templatePath . 'coverage_bar.html', '{{', '}}'
 
249
        );
 
250
 
 
251
        $template->setVar(array('level' => $level, 'percent' => sprintf("%.2F", $percent)));
 
252
 
 
253
        return $template->render();
 
254
    }
 
255
 
 
256
    /**
 
257
     * @param  integer $percent
 
258
     * @return string
 
259
     */
 
260
    protected function getColorLevel($percent)
 
261
    {
 
262
        if ($percent < $this->lowUpperBound) {
 
263
            return 'danger';
 
264
        } elseif ($percent >= $this->lowUpperBound &&
 
265
            $percent <  $this->highLowerBound) {
 
266
            return 'warning';
 
267
        } else {
 
268
            return 'success';
 
269
        }
 
270
    }
 
271
}