systemsdk / phpcpd / #12

Committed 13 Apr 2025 04:42PM UTC coverage: 75.711%. Remained the same

Build # #12

Build Type

push

Committed by DKravtsov

Commit Message

phpcpd 8.1.1 release. Available installation via composer.

Run Details

692 of 914 relevant lines covered (75.71%)

3.7 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

74.42

/src/Log/PMD.php

<?php

declare(strict_types=1);

namespace Systemsdk\PhpCPD\Log;

use DOMElement;
use DOMException;
use DOMNode;
use Systemsdk\PhpCPD\CodeCloneMap;
use Systemsdk\PhpCPD\Exceptions\LoggerException;

use function is_object;
use function sprintf;

final class PMD extends AbstractXmlLogger
{
    private const string CPD_ELEMENT_NAME = 'pmd-cpd';
    private const string DUPLICATION_ELEMENT_NAME = 'duplication';
    private const string FILE_ELEMENT_NAME = 'file';
    private const string CODE_FRAGMENT_ELEMENT_NAME = 'codefragment';
    private const string ATTRIBUTE_LINES_NAME = 'lines';
    private const string ATTRIBUTE_TOKENS_NAME = 'tokens';
    private const string ATTRIBUTE_PATH_NAME = 'path';
    private const string ATTRIBUTE_LINE_NAME = 'line';
    private const string ACTION_CREATE_ELEMENT = 'create-element';
    private const string ACTION_APPEND_CHILD = 'append-child';
    private const string ACTION_SET_ATTRIBUTE = 'set-attribute';

    /**
     * @throws LoggerException
     */
    public function processClones(CodeCloneMap $clones): void
    {
        try {
            $cpd = $this->document->createElement(self::CPD_ELEMENT_NAME);
            $this->checkResult($cpd, self::CPD_ELEMENT_NAME, self::ACTION_CREATE_ELEMENT);

            $result = $this->document->appendChild($cpd);
            $this->checkResult($result, self::CPD_ELEMENT_NAME, self::ACTION_APPEND_CHILD);

            foreach ($clones as $clone) {
                $duplicationEl = $this->document->createElement(self::DUPLICATION_ELEMENT_NAME);
                $this->checkResult($duplicationEl, self::DUPLICATION_ELEMENT_NAME, self::ACTION_CREATE_ELEMENT);

                $duplication = $cpd->appendChild($duplicationEl);
                $this->checkResult($duplication, self::DUPLICATION_ELEMENT_NAME, self::ACTION_APPEND_CHILD);

                /** @var DOMElement $duplication */
                $result1 = $duplication->setAttribute(self::ATTRIBUTE_LINES_NAME, (string)$clone->numberOfLines());
                $this->checkResult($result1, self::ATTRIBUTE_LINES_NAME, self::ACTION_SET_ATTRIBUTE);

                $result2 = $duplication->setAttribute(self::ATTRIBUTE_TOKENS_NAME, (string)$clone->numberOfTokens());
                $this->checkResult($result2, self::ATTRIBUTE_TOKENS_NAME, self::ACTION_SET_ATTRIBUTE);

                foreach ($clone->files() as $codeCloneFile) {
                    $fileEl = $this->document->createElement(self::FILE_ELEMENT_NAME);
                    $this->checkResult($fileEl, self::FILE_ELEMENT_NAME, self::ACTION_CREATE_ELEMENT);

                    $file = $duplication->appendChild($fileEl);
                    $this->checkResult($file, self::FILE_ELEMENT_NAME, self::ACTION_APPEND_CHILD);

                    /** @var DOMElement $file */
                    $result1 = $file->setAttribute(self::ATTRIBUTE_PATH_NAME, $codeCloneFile->name());
                    $this->checkResult($result1, self::ATTRIBUTE_PATH_NAME, self::ACTION_SET_ATTRIBUTE);

                    $result2 = $file->setAttribute(self::ATTRIBUTE_LINE_NAME, (string)$codeCloneFile->startLine());
                    $this->checkResult($result2, self::ATTRIBUTE_LINE_NAME, self::ACTION_SET_ATTRIBUTE);
                }

                $codeFragmentEl = $this->document->createElement(
                    self::CODE_FRAGMENT_ELEMENT_NAME,
                    $this->escapeForXml($clone->lines())
                );
                $this->checkResult($codeFragmentEl, self::CODE_FRAGMENT_ELEMENT_NAME, self::ACTION_CREATE_ELEMENT);

                $codeFragment = $duplication->appendChild($codeFragmentEl);
                $this->checkResult($codeFragment, self::CODE_FRAGMENT_ELEMENT_NAME, self::ACTION_APPEND_CHILD);
            }

            $this->flush();
        } catch (DOMException $exception) {
            throw new LoggerException($exception->getMessage());
        }
    }

    /**
     * @throws LoggerException
     */
    private function checkResult(DOMNode|false $result, string $name, string $type): void
    {
        if (is_object($result)) {
            return;
        }

        $error = 'Unknown action: %s';

        if ($type === self::ACTION_CREATE_ELEMENT) {
            $error = 'Can not create element: %s';
        } elseif ($type === self::ACTION_APPEND_CHILD) {
            $error = 'Can not add new child at the end: %s';
        } elseif ($type === self::ACTION_SET_ATTRIBUTE) {
            $error = 'Can not set attribute: %s';
        }

        $this->generateException($error, $name);
    }

    /**
     * @throws LoggerException
     */
    private function generateException(string $error, string $name): void
    {
        throw new LoggerException(sprintf($error, $name));
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	namespace Systemsdk\PhpCPD\Log;
6
7	use DOMElement;
8	use DOMException;
9	use DOMNode;
10	use Systemsdk\PhpCPD\CodeCloneMap;
11	use Systemsdk\PhpCPD\Exceptions\LoggerException;
12
13	use function is_object;
14	use function sprintf;
15
16	final class PMD extends AbstractXmlLogger
17	{
18	private const string CPD_ELEMENT_NAME = 'pmd-cpd';
19	private const string DUPLICATION_ELEMENT_NAME = 'duplication';
20	private const string FILE_ELEMENT_NAME = 'file';
21	private const string CODE_FRAGMENT_ELEMENT_NAME = 'codefragment';
22	private const string ATTRIBUTE_LINES_NAME = 'lines';
23	private const string ATTRIBUTE_TOKENS_NAME = 'tokens';
24	private const string ATTRIBUTE_PATH_NAME = 'path';
25	private const string ATTRIBUTE_LINE_NAME = 'line';
26	private const string ACTION_CREATE_ELEMENT = 'create-element';
27	private const string ACTION_APPEND_CHILD = 'append-child';
28	private const string ACTION_SET_ATTRIBUTE = 'set-attribute';
29
30	/**
31	* @throws LoggerException
32	*/
33	public function processClones(CodeCloneMap $clones): void
34	{
35	try {
36	$cpd = $this->document->createElement(self::CPD_ELEMENT_NAME);	1✔
37	$this->checkResult($cpd, self::CPD_ELEMENT_NAME, self::ACTION_CREATE_ELEMENT);	1✔
38
39	$result = $this->document->appendChild($cpd);	1✔
40	$this->checkResult($result, self::CPD_ELEMENT_NAME, self::ACTION_APPEND_CHILD);	1✔
41
42	foreach ($clones as $clone) {	1✔
43	$duplicationEl = $this->document->createElement(self::DUPLICATION_ELEMENT_NAME);	1✔
44	$this->checkResult($duplicationEl, self::DUPLICATION_ELEMENT_NAME, self::ACTION_CREATE_ELEMENT);	1✔
45
46	$duplication = $cpd->appendChild($duplicationEl);	1✔
47	$this->checkResult($duplication, self::DUPLICATION_ELEMENT_NAME, self::ACTION_APPEND_CHILD);	1✔
48
49	/** @var DOMElement $duplication */
50	$result1 = $duplication->setAttribute(self::ATTRIBUTE_LINES_NAME, (string)$clone->numberOfLines());	1✔
51	$this->checkResult($result1, self::ATTRIBUTE_LINES_NAME, self::ACTION_SET_ATTRIBUTE);	1✔
52
53	$result2 = $duplication->setAttribute(self::ATTRIBUTE_TOKENS_NAME, (string)$clone->numberOfTokens());	1✔
54	$this->checkResult($result2, self::ATTRIBUTE_TOKENS_NAME, self::ACTION_SET_ATTRIBUTE);	1✔
55
56	foreach ($clone->files() as $codeCloneFile) {	1✔
57	$fileEl = $this->document->createElement(self::FILE_ELEMENT_NAME);	1✔
58	$this->checkResult($fileEl, self::FILE_ELEMENT_NAME, self::ACTION_CREATE_ELEMENT);	1✔
59
60	$file = $duplication->appendChild($fileEl);	1✔
61	$this->checkResult($file, self::FILE_ELEMENT_NAME, self::ACTION_APPEND_CHILD);	1✔
62
63	/** @var DOMElement $file */
64	$result1 = $file->setAttribute(self::ATTRIBUTE_PATH_NAME, $codeCloneFile->name());	1✔
65	$this->checkResult($result1, self::ATTRIBUTE_PATH_NAME, self::ACTION_SET_ATTRIBUTE);	1✔
66
67	$result2 = $file->setAttribute(self::ATTRIBUTE_LINE_NAME, (string)$codeCloneFile->startLine());	1✔
68	$this->checkResult($result2, self::ATTRIBUTE_LINE_NAME, self::ACTION_SET_ATTRIBUTE);	1✔
69	}
70
71	$codeFragmentEl = $this->document->createElement(	1✔
72	self::CODE_FRAGMENT_ELEMENT_NAME,	1✔
73	$this->escapeForXml($clone->lines())	1✔
74	);	1✔
75	$this->checkResult($codeFragmentEl, self::CODE_FRAGMENT_ELEMENT_NAME, self::ACTION_CREATE_ELEMENT);	1✔
76
77	$codeFragment = $duplication->appendChild($codeFragmentEl);	1✔
78	$this->checkResult($codeFragment, self::CODE_FRAGMENT_ELEMENT_NAME, self::ACTION_APPEND_CHILD);	1✔
79	}
80
81	$this->flush();	1✔
82	} catch (DOMException $exception) {	×
83	throw new LoggerException($exception->getMessage());	×
84	}
85	}
86
87	/**
88	* @throws LoggerException
89	*/
90	private function checkResult(DOMNode\|false $result, string $name, string $type): void
91	{
92	if (is_object($result)) {	1✔
93	return;	1✔
94	}
95
96	$error = 'Unknown action: %s';	×
97
98	if ($type === self::ACTION_CREATE_ELEMENT) {	×
99	$error = 'Can not create element: %s';	×
100	} elseif ($type === self::ACTION_APPEND_CHILD) {	×
101	$error = 'Can not add new child at the end: %s';	×
102	} elseif ($type === self::ACTION_SET_ATTRIBUTE) {	×
103	$error = 'Can not set attribute: %s';	×
104	}
105
106	$this->generateException($error, $name);	×
107	}
108
109	/**
110	* @throws LoggerException
111	*/
112	private function generateException(string $error, string $name): void
113	{
114	throw new LoggerException(sprintf($error, $name));	×
115	}
116	}

systemsdk / phpcpd / #12

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous