Clover::process() - Code Metrics - Inspection of "WIP: first version of AlpineJS Dash Docset" - godbout/alpinejs-dash-docset - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#1)

by Guillaume

created 2020-08-05 15:15 UTC

Clover::process() F

↳ Parent: Project

Complexity

Conditions	28
Paths	> 20000

Size

Total Lines	228
Code Lines	146

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	28
eloc	146
nc	235938
nop	3
dl	0
loc	228
rs	0
c	0
b	0
f	0

How to fix Long Method Complexity

<?php declare(strict_types=1);
/*
 * This file is part of phpunit/php-code-coverage.
 *
 * (c) Sebastian Bergmann <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace SebastianBergmann\CodeCoverage\Report;

use SebastianBergmann\CodeCoverage\CodeCoverage;
use SebastianBergmann\CodeCoverage\Directory;
use SebastianBergmann\CodeCoverage\Node\File;
use SebastianBergmann\CodeCoverage\RuntimeException;

/**
 * Generates a Clover XML logfile from a code coverage object.
 */
final class Clover
{
    /**
     * @throws \RuntimeException
     */
    public function process(CodeCoverage $coverage, ?string $target = null, ?string $name = null): string
    {
        $time = (string) \time();

        $xmlDocument               = new \DOMDocument('1.0', 'UTF-8');
        $xmlDocument->formatOutput = true;

        $xmlCoverage = $xmlDocument->createElement('coverage');
        $xmlCoverage->setAttribute('generated', $time);
        $xmlDocument->appendChild($xmlCoverage);

        $xmlProject = $xmlDocument->createElement('project');
        $xmlProject->setAttribute('timestamp', $time);

        if (\is_string($name)) {
            $xmlProject->setAttribute('name', $name);
        }

        $xmlCoverage->appendChild($xmlProject);

        $packages = [];
        $report   = $coverage->getReport();

        foreach ($report as $item) {
            if (!$item instanceof File) {
                continue;
            }

            /* @var File $item */

            $xmlFile = $xmlDocument->createElement('file');
            $xmlFile->setAttribute('name', $item->getPath());

            $classes      = $item->getClassesAndTraits();
            $coverageData = $item->getCoverageData();
            $lines        = [];
            $namespace    = 'global';

            foreach ($classes as $className => $class) {
                $classStatements        = 0;
                $coveredClassStatements = 0;
                $coveredMethods         = 0;
                $classMethods           = 0;

                foreach ($class['methods'] as $methodName => $method) {
                    if ($method['executableLines'] == 0) {
                        continue;
                    }

                    $classMethods++;
                    $classStatements += $method['executableLines'];
                    $coveredClassStatements += $method['executedLines'];

                    if ($method['coverage'] == 100) {
                        $coveredMethods++;
                    }

                    $methodCount = 0;

                    foreach (\range($method['startLine'], $method['endLine']) as $line) {
                        if (isset($coverageData[$line]) && ($coverageData[$line] !== null)) {
                            $methodCount = \max($methodCount, \count($coverageData[$line]));
                        }
                    }

                    $lines[$method['startLine']] = [
                        'ccn'         => $method['ccn'],
                        'count'       => $methodCount,
                        'crap'        => $method['crap'],
                        'type'        => 'method',
                        'visibility'  => $method['visibility'],
                        'name'        => $methodName,
                    ];
                }

                if (!empty($class['package']['namespace'])) {
                    $namespace = $class['package']['namespace'];
                }

                $xmlClass = $xmlDocument->createElement('class');
                $xmlClass->setAttribute('name', $className);
                $xmlClass->setAttribute('namespace', $namespace);

                if (!empty($class['package']['fullPackage'])) {
                    $xmlClass->setAttribute(
                        'fullPackage',
                        $class['package']['fullPackage']
                    );
                }

                if (!empty($class['package']['category'])) {
                    $xmlClass->setAttribute(
                        'category',
                        $class['package']['category']
                    );
                }

                if (!empty($class['package']['package'])) {
                    $xmlClass->setAttribute(
                        'package',
                        $class['package']['package']
                    );
                }

                if (!empty($class['package']['subpackage'])) {
                    $xmlClass->setAttribute(
                        'subpackage',
                        $class['package']['subpackage']
                    );
                }

                $xmlFile->appendChild($xmlClass);

                $xmlMetrics = $xmlDocument->createElement('metrics');
                $xmlMetrics->setAttribute('complexity', (string) $class['ccn']);
                $xmlMetrics->setAttribute('methods', (string) $classMethods);
                $xmlMetrics->setAttribute('coveredmethods', (string) $coveredMethods);
                $xmlMetrics->setAttribute('conditionals', '0');
                $xmlMetrics->setAttribute('coveredconditionals', '0');
                $xmlMetrics->setAttribute('statements', (string) $classStatements);
                $xmlMetrics->setAttribute('coveredstatements', (string) $coveredClassStatements);
                $xmlMetrics->setAttribute('elements', (string) ($classMethods + $classStatements /* + conditionals */));
                $xmlMetrics->setAttribute('coveredelements', (string) ($coveredMethods + $coveredClassStatements /* + coveredconditionals */));
                $xmlClass->appendChild($xmlMetrics);
            }

            foreach ($coverageData as $line => $data) {
                if ($data === null || isset($lines[$line])) {
                    continue;
                }

                $lines[$line] = [
                    'count' => \count($data), 'type' => 'stmt',
                ];
            }

            \ksort($lines);

            foreach ($lines as $line => $data) {
                $xmlLine = $xmlDocument->createElement('line');
                $xmlLine->setAttribute('num', (string) $line);
                $xmlLine->setAttribute('type', $data['type']);

                if (isset($data['name'])) {
                    $xmlLine->setAttribute('name', $data['name']);
                }

                if (isset($data['visibility'])) {
                    $xmlLine->setAttribute('visibility', $data['visibility']);
                }

                if (isset($data['ccn'])) {
                    $xmlLine->setAttribute('complexity', (string) $data['ccn']);
                }

                if (isset($data['crap'])) {
                    $xmlLine->setAttribute('crap', (string) $data['crap']);
                }

                $xmlLine->setAttribute('count', (string) $data['count']);
                $xmlFile->appendChild($xmlLine);
            }

            $linesOfCode = $item->getLinesOfCode();

            $xmlMetrics = $xmlDocument->createElement('metrics');
            $xmlMetrics->setAttribute('loc', (string) $linesOfCode['loc']);
            $xmlMetrics->setAttribute('ncloc', (string) $linesOfCode['ncloc']);
            $xmlMetrics->setAttribute('classes', (string) $item->getNumClassesAndTraits());
            $xmlMetrics->setAttribute('methods', (string) $item->getNumMethods());
            $xmlMetrics->setAttribute('coveredmethods', (string) $item->getNumTestedMethods());
            $xmlMetrics->setAttribute('conditionals', '0');
            $xmlMetrics->setAttribute('coveredconditionals', '0');
            $xmlMetrics->setAttribute('statements', (string) $item->getNumExecutableLines());
            $xmlMetrics->setAttribute('coveredstatements', (string) $item->getNumExecutedLines());
            $xmlMetrics->setAttribute('elements', (string) ($item->getNumMethods() + $item->getNumExecutableLines() /* + conditionals */));
            $xmlMetrics->setAttribute('coveredelements', (string) ($item->getNumTestedMethods() + $item->getNumExecutedLines() /* + coveredconditionals */));
            $xmlFile->appendChild($xmlMetrics);

            if ($namespace === 'global') {
                $xmlProject->appendChild($xmlFile);
            } else {
                if (!isset($packages[$namespace])) {
                    $packages[$namespace] = $xmlDocument->createElement(
                        'package'
                    );

                    $packages[$namespace]->setAttribute('name', $namespace);
                    $xmlProject->appendChild($packages[$namespace]);
                }

                $packages[$namespace]->appendChild($xmlFile);
            }
        }

        $linesOfCode = $report->getLinesOfCode();

        $xmlMetrics = $xmlDocument->createElement('metrics');
        $xmlMetrics->setAttribute('files', (string) \count($report));
        $xmlMetrics->setAttribute('loc', (string) $linesOfCode['loc']);
        $xmlMetrics->setAttribute('ncloc', (string) $linesOfCode['ncloc']);
        $xmlMetrics->setAttribute('classes', (string) $report->getNumClassesAndTraits());
        $xmlMetrics->setAttribute('methods', (string) $report->getNumMethods());
        $xmlMetrics->setAttribute('coveredmethods', (string) $report->getNumTestedMethods());
        $xmlMetrics->setAttribute('conditionals', '0');
        $xmlMetrics->setAttribute('coveredconditionals', '0');
        $xmlMetrics->setAttribute('statements', (string) $report->getNumExecutableLines());
        $xmlMetrics->setAttribute('coveredstatements', (string) $report->getNumExecutedLines());
        $xmlMetrics->setAttribute('elements', (string) ($report->getNumMethods() + $report->getNumExecutableLines() /* + conditionals */));
        $xmlMetrics->setAttribute('coveredelements', (string) ($report->getNumTestedMethods() + $report->getNumExecutedLines() /* + coveredconditionals */));
        $xmlProject->appendChild($xmlMetrics);

        $buffer = $xmlDocument->saveXML();

        if ($target !== null) {
            Directory::create(\dirname($target));

            if (@\file_put_contents($target, $buffer) === false) {
                throw new RuntimeException(
                    \sprintf(
                        'Could not write to "%s',
                        $target
                    )
                );
            }
        }

        return $buffer;
    }
}


1			<?php declare(strict_types=1);
2			/*
3			* This file is part of phpunit/php-code-coverage.
4			*
5			* (c) Sebastian Bergmann <[email protected]>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10			namespace SebastianBergmann\CodeCoverage\Report;
11
12			use SebastianBergmann\CodeCoverage\CodeCoverage;
13			use SebastianBergmann\CodeCoverage\Directory;
14			use SebastianBergmann\CodeCoverage\Node\File;
15			use SebastianBergmann\CodeCoverage\RuntimeException;
16
17			/**
18			* Generates a Clover XML logfile from a code coverage object.
19			*/
20			final class Clover
21			{
22			/**
23			* @throws \RuntimeException
24			*/
25			public function process(CodeCoverage $coverage, ?string $target = null, ?string $name = null): string
26			{
27			$time = (string) \time();
28
29			$xmlDocument = new \DOMDocument('1.0', 'UTF-8');
30			$xmlDocument->formatOutput = true;
31
32			$xmlCoverage = $xmlDocument->createElement('coverage');
33			$xmlCoverage->setAttribute('generated', $time);
34			$xmlDocument->appendChild($xmlCoverage);
35
36			$xmlProject = $xmlDocument->createElement('project');
37			$xmlProject->setAttribute('timestamp', $time);
38
39			if (\is_string($name)) {
40			$xmlProject->setAttribute('name', $name);
41			}
42
43			$xmlCoverage->appendChild($xmlProject);
44
45			$packages = [];
46			$report = $coverage->getReport();
47
48			foreach ($report as $item) {
49			if (!$item instanceof File) {
50			continue;
51			}
52
53			/* @var File $item */
54
55			$xmlFile = $xmlDocument->createElement('file');
56			$xmlFile->setAttribute('name', $item->getPath());
57
58			$classes = $item->getClassesAndTraits();
59			$coverageData = $item->getCoverageData();
60			$lines = [];
61			$namespace = 'global';
62
63			foreach ($classes as $className => $class) {
64			$classStatements = 0;
65			$coveredClassStatements = 0;
66			$coveredMethods = 0;
67			$classMethods = 0;
68
69			foreach ($class['methods'] as $methodName => $method) {
70			if ($method['executableLines'] == 0) {
71			continue;
72			}
73
74			$classMethods++;
75			$classStatements += $method['executableLines'];
76			$coveredClassStatements += $method['executedLines'];
77
78			if ($method['coverage'] == 100) {
79			$coveredMethods++;
80			}
81
82			$methodCount = 0;
83
84			foreach (\range($method['startLine'], $method['endLine']) as $line) {
85			if (isset($coverageData[$line]) && ($coverageData[$line] !== null)) {
86			$methodCount = \max($methodCount, \count($coverageData[$line]));
87			}
88			}
89
90			$lines[$method['startLine']] = [
91			'ccn' => $method['ccn'],
92			'count' => $methodCount,
93			'crap' => $method['crap'],
94			'type' => 'method',
95			'visibility' => $method['visibility'],
96			'name' => $methodName,
97			];
98			}
99
100			if (!empty($class['package']['namespace'])) {
101			$namespace = $class['package']['namespace'];
102			}
103
104			$xmlClass = $xmlDocument->createElement('class');
105			$xmlClass->setAttribute('name', $className);
106			$xmlClass->setAttribute('namespace', $namespace);
107
108			if (!empty($class['package']['fullPackage'])) {
109			$xmlClass->setAttribute(
110			'fullPackage',
111			$class['package']['fullPackage']
112			);
113			}
114
115			if (!empty($class['package']['category'])) {
116			$xmlClass->setAttribute(
117			'category',
118			$class['package']['category']
119			);
120			}
121
122			if (!empty($class['package']['package'])) {
123			$xmlClass->setAttribute(
124			'package',
125			$class['package']['package']
126			);
127			}
128
129			if (!empty($class['package']['subpackage'])) {
130			$xmlClass->setAttribute(
131			'subpackage',
132			$class['package']['subpackage']
133			);
134			}
135
136			$xmlFile->appendChild($xmlClass);
137
138			$xmlMetrics = $xmlDocument->createElement('metrics');
139			$xmlMetrics->setAttribute('complexity', (string) $class['ccn']);
140			$xmlMetrics->setAttribute('methods', (string) $classMethods);
141			$xmlMetrics->setAttribute('coveredmethods', (string) $coveredMethods);
142			$xmlMetrics->setAttribute('conditionals', '0');
143			$xmlMetrics->setAttribute('coveredconditionals', '0');
144			$xmlMetrics->setAttribute('statements', (string) $classStatements);
145			$xmlMetrics->setAttribute('coveredstatements', (string) $coveredClassStatements);
146			$xmlMetrics->setAttribute('elements', (string) ($classMethods + $classStatements /* + conditionals */));
147			$xmlMetrics->setAttribute('coveredelements', (string) ($coveredMethods + $coveredClassStatements /* + coveredconditionals */));
148			$xmlClass->appendChild($xmlMetrics);
149			}
150
151			foreach ($coverageData as $line => $data) {
152			if ($data === null \|\| isset($lines[$line])) {
153			continue;
154			}
155
156			$lines[$line] = [
157			'count' => \count($data), 'type' => 'stmt',
158			];
159			}
160
161			\ksort($lines);
162
163			foreach ($lines as $line => $data) {
164			$xmlLine = $xmlDocument->createElement('line');
165			$xmlLine->setAttribute('num', (string) $line);
166			$xmlLine->setAttribute('type', $data['type']);
167
168			if (isset($data['name'])) {
169			$xmlLine->setAttribute('name', $data['name']);
170			}
171
172			if (isset($data['visibility'])) {
173			$xmlLine->setAttribute('visibility', $data['visibility']);
174			}
175
176			if (isset($data['ccn'])) {
177			$xmlLine->setAttribute('complexity', (string) $data['ccn']);
178			}
179
180			if (isset($data['crap'])) {
181			$xmlLine->setAttribute('crap', (string) $data['crap']);
182			}
183
184			$xmlLine->setAttribute('count', (string) $data['count']);
185			$xmlFile->appendChild($xmlLine);
186			}
187
188			$linesOfCode = $item->getLinesOfCode();
189
190			$xmlMetrics = $xmlDocument->createElement('metrics');
191			$xmlMetrics->setAttribute('loc', (string) $linesOfCode['loc']);
192			$xmlMetrics->setAttribute('ncloc', (string) $linesOfCode['ncloc']);
193			$xmlMetrics->setAttribute('classes', (string) $item->getNumClassesAndTraits());
194			$xmlMetrics->setAttribute('methods', (string) $item->getNumMethods());
195			$xmlMetrics->setAttribute('coveredmethods', (string) $item->getNumTestedMethods());
196			$xmlMetrics->setAttribute('conditionals', '0');
197			$xmlMetrics->setAttribute('coveredconditionals', '0');
198			$xmlMetrics->setAttribute('statements', (string) $item->getNumExecutableLines());
199			$xmlMetrics->setAttribute('coveredstatements', (string) $item->getNumExecutedLines());
200			$xmlMetrics->setAttribute('elements', (string) ($item->getNumMethods() + $item->getNumExecutableLines() /* + conditionals */));
201			$xmlMetrics->setAttribute('coveredelements', (string) ($item->getNumTestedMethods() + $item->getNumExecutedLines() /* + coveredconditionals */));
202			$xmlFile->appendChild($xmlMetrics);
203
204			if ($namespace === 'global') {
205			$xmlProject->appendChild($xmlFile);
206			} else {
207			if (!isset($packages[$namespace])) {
208			$packages[$namespace] = $xmlDocument->createElement(
209			'package'
210			);
211
212			$packages[$namespace]->setAttribute('name', $namespace);
213			$xmlProject->appendChild($packages[$namespace]);
214			}
215
216			$packages[$namespace]->appendChild($xmlFile);
217			}
218			}
219
220			$linesOfCode = $report->getLinesOfCode();
221
222			$xmlMetrics = $xmlDocument->createElement('metrics');
223			$xmlMetrics->setAttribute('files', (string) \count($report));
224			$xmlMetrics->setAttribute('loc', (string) $linesOfCode['loc']);
225			$xmlMetrics->setAttribute('ncloc', (string) $linesOfCode['ncloc']);
226			$xmlMetrics->setAttribute('classes', (string) $report->getNumClassesAndTraits());
227			$xmlMetrics->setAttribute('methods', (string) $report->getNumMethods());
228			$xmlMetrics->setAttribute('coveredmethods', (string) $report->getNumTestedMethods());
229			$xmlMetrics->setAttribute('conditionals', '0');
230			$xmlMetrics->setAttribute('coveredconditionals', '0');
231			$xmlMetrics->setAttribute('statements', (string) $report->getNumExecutableLines());
232			$xmlMetrics->setAttribute('coveredstatements', (string) $report->getNumExecutedLines());
233			$xmlMetrics->setAttribute('elements', (string) ($report->getNumMethods() + $report->getNumExecutableLines() /* + conditionals */));
234			$xmlMetrics->setAttribute('coveredelements', (string) ($report->getNumTestedMethods() + $report->getNumExecutedLines() /* + coveredconditionals */));
235			$xmlProject->appendChild($xmlMetrics);
236
237			$buffer = $xmlDocument->saveXML();
238
239			if ($target !== null) {
240			Directory::create(\dirname($target));
241
242			if (@\file_put_contents($target, $buffer) === false) {
243			throw new RuntimeException(
244			\sprintf(
245			'Could not write to "%s',
246			$target
247			)
248			);
249			}
250			}
251
252			return $buffer;
253			}
254			}
255

godbout / alpinejs-dash-docset

Pull Request — master (#1)

Clover::process() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like