Element::setFinalMarkdown() - Code Metrics - Inspection of "Update Scrutinizer CI settings" - thephpleague/html-to-markdown - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 44d65f...3ad102 )

by Colin

created 2021-03-29 01:12 UTC

Element::setFinalMarkdown() A

↳ Parent: Element

Complexity

Conditions	3
Paths	3

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	3.072

Importance

Changes

Metric	Value
cc	3
eloc	6
c	0
b	0
f	0
nc	3
nop	1
dl	0
loc	12
ccs	4
cts	5
cp	0.8
crap	3.072
rs	10

<?php

declare(strict_types=1);

namespace League\HTMLToMarkdown;

class Element implements ElementInterface
{
    /** @var \DOMNode */
    protected $node;

    /** @var ElementInterface|null */
    private $nextCached;

    /** @var \DOMNode|null */
    private $previousSiblingCached;

    public function __construct(\DOMNode $node)
    {
        $this->node = $node;

        $this->previousSiblingCached = $this->node->previousSibling;
    }

    public function isBlock(): bool
    {
        switch ($this->getTagName()) {
            case 'blockquote':
            case 'body':
            case 'div':
            case 'h1':
            case 'h2':
            case 'h3':
            case 'h4':
            case 'h5':
            case 'h6':
            case 'hr':
            case 'html':
            case 'li':
            case 'p':
            case 'ol':
            case 'ul':
                return true;
            default:
                return false;
        }
    }

    public function isText(): bool
    {
        return $this->getTagName() === '#text';
    }

    public function isWhitespace(): bool
    {
        return $this->getTagName() === '#text' && \trim($this->getValue()) === '';
    }

    public function getTagName(): string
    {
        return $this->node->nodeName;
    }

    public function getValue(): string
    {
        return $this->node->nodeValue;
    }

    public function hasParent(): bool
    {
        return $this->node->parentNode !== null;
    }

    public function getParent(): ?ElementInterface
    {
        return $this->node->parentNode ? new self($this->node->parentNode) : null;
    }

    public function getNextSibling(): ?ElementInterface
    {
        return $this->node->nextSibling !== null ? new self($this->node->nextSibling) : null;
    }

    public function getPreviousSibling(): ?ElementInterface
    {
        return $this->previousSiblingCached !== null ? new self($this->previousSiblingCached) : null;
    }

    public function hasChildren(): bool
    {
        return $this->node->hasChildNodes();
    }

    /**
     * @return ElementInterface[]
     */
    public function getChildren(): array
    {
        $ret = [];
        foreach ($this->node->childNodes as $node) {
            $ret[] = new self($node);
        }

        return $ret;
    }

    public function getNext(): ?ElementInterface
    {
        if ($this->nextCached === null) {
            $nextNode = $this->getNextNode($this->node);
            if ($nextNode !== null) {
                $this->nextCached = new self($nextNode);
            }
        }

        return $this->nextCached;
    }

    private function getNextNode(\DomNode $node, bool $checkChildren = true): ?\DomNode
    {
        if ($checkChildren && $node->firstChild) {
            return $node->firstChild;
        }

        if ($node->nextSibling) {
            return $node->nextSibling;
        }

        if ($node->parentNode) {
            return $this->getNextNode($node->parentNode, false);
        }

        return null;
    }

    /**
     * @param string[]|string $tagNames
     */
    public function isDescendantOf($tagNames): bool
    {
        if (! \is_array($tagNames)) {
            $tagNames = [$tagNames];
        }

        for ($p = $this->node->parentNode; $p !== false; $p = $p->parentNode) {
            if ($p === null) {
                return false;
            }

            if (\in_array($p->nodeName, $tagNames, true)) {
                return true;
            }
        }

        return false;
    }

    public function setFinalMarkdown(string $markdown): void
    {
        if ($this->node->ownerDocument === null) {
            throw new \RuntimeException('Unowned node');
        }

        if ($this->node->parentNode === null) {
            throw new \RuntimeException('Cannot setFinalMarkdown() on a node without a parent');
        }

        $markdownNode = $this->node->ownerDocument->createTextNode($markdown);
        $this->node->parentNode->replaceChild($markdownNode, $this->node);
    }

    public function getChildrenAsString(): string
    {
        return $this->node->C14N();
    }

    public function getSiblingPosition(): int
    {
        $position = 0;

        $parent = $this->getParent();
        if ($parent === null) {
            return $position;
        }

        // Loop through all nodes and find the given $node
        foreach ($parent->getChildren() as $currentNode) {
            if (! $currentNode->isWhitespace()) {
                $position++;
            }

            // TODO: Need a less-buggy way of comparing these
            // Perhaps we can somehow ensure that we always have the exact same object and use === instead?
            if ($this->equals($currentNode)) {
                break;
            }
        }

        return $position;
    }

    public function getListItemLevel(): int
    {
        $level  = 0;
        $parent = $this->getParent();

        while ($parent !== null && $parent->hasParent()) {
            if ($parent->getTagName() === 'li') {
                $level++;
            }

            $parent = $parent->getParent();
        }

        return $level;
    }

    public function getAttribute(string $name): string
    {
        if ($this->node instanceof \DOMElement) {
            return $this->node->getAttribute($name);
        }

        return '';
    }

    public function equals(ElementInterface $element): bool
    {
        if ($element instanceof self) {
            return $element->node === $this->node;
        }

        return false;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace League\HTMLToMarkdown;
6
7		class Element implements ElementInterface
8		{
9		/** @var \DOMNode */
10		protected $node;
11
12		/** @var ElementInterface\|null */
13		private $nextCached;
14
15		/** @var \DOMNode\|null */
16		private $previousSiblingCached;
17
18		public function __construct(\DOMNode $node)
19		{
20		$this->node = $node;
21
22	96	$this->previousSiblingCached = $this->node->previousSibling;
23		}
24	96
25	96	public function isBlock(): bool
26	96	{
27		switch ($this->getTagName()) {
28		case 'blockquote':
29		case 'body':
30		case 'div':
31	18	case 'h1':
32		case 'h2':
33	18	case 'h3':
34	18	case 'h4':
35	18	case 'h5':
36	18	case 'h6':
37	18	case 'hr':
38	18	case 'html':
39	18	case 'li':
40	18	case 'p':
41	18	case 'ol':
42	18	case 'ul':
43	18	return true;
44	18	default:
45	18	return false;
46	17	}
47	17	}
48	17
49	3	public function isText(): bool
50	10	{
51	15	return $this->getTagName() === '#text';
52	10	}
53
54		public function isWhitespace(): bool
55		{
56		return $this->getTagName() === '#text' && \trim($this->getValue()) === '';
57		}
58	18
59		public function getTagName(): string
60	18	{
61		return $this->node->nodeName;
62		}
63
64		public function getValue(): string
65		{
66	9	return $this->node->nodeValue;
67		}
68	9
69		public function hasParent(): bool
70		{
71		return $this->node->parentNode !== null;
72		}
73
74	96	public function getParent(): ?ElementInterface
75		{
76	96	return $this->node->parentNode ? new self($this->node->parentNode) : null;
77		}
78
79		public function getNextSibling(): ?ElementInterface
80		{
81		return $this->node->nextSibling !== null ? new self($this->node->nextSibling) : null;
82	84	}
83
84	84	public function getPreviousSibling(): ?ElementInterface
85		{
86		return $this->previousSiblingCached !== null ? new self($this->previousSiblingCached) : null;
87		}
88
89		public function hasChildren(): bool
90	81	{
91		return $this->node->hasChildNodes();
92	81	}
93
94		/**
95		* @return ElementInterface[]
96		*/
97		public function getChildren(): array
98	18	{
99		$ret = [];
100	18	foreach ($this->node->childNodes as $node) {
101		$ret[] = new self($node);
102		}
103
104		return $ret;
105		}
106	18
107		public function getNext(): ?ElementInterface
108	18	{
109		if ($this->nextCached === null) {
110		$nextNode = $this->getNextNode($this->node);
111		if ($nextNode !== null) {
112		$this->nextCached = new self($nextNode);
113		}
114	96	}
115
116	96	return $this->nextCached;
117		}
118
119		private function getNextNode(\DomNode $node, bool $checkChildren = true): ?\DomNode
120		{
121		if ($checkChildren && $node->firstChild) {
122	96	return $node->firstChild;
123		}
124	96
125		if ($node->nextSibling) {
126	96	return $node->nextSibling;
127	96	}
128	64
129		if ($node->parentNode) {
130	96	return $this->getNextNode($node->parentNode, false);
131		}
132
133		return null;
134		}
135
136	24	/**
137		* @param string[]\|string $tagNames
138	24	*/
139	24	public function isDescendantOf($tagNames): bool
140	24	{
141	24	if (! \is_array($tagNames)) {
142	16	$tagNames = [$tagNames];
143	16	}
144
145	24	for ($p = $this->node->parentNode; $p !== false; $p = $p->parentNode) {
146		if ($p === null) {
147		return false;
148		}
149
150		if (\in_array($p->nodeName, $tagNames, true)) {
151		return true;
152		}
153		}
154	24
155		return false;
156	24	}
157
158		public function setFinalMarkdown(string $markdown): void
159		{
160	24	if ($this->node->ownerDocument === null) {
161	24	throw new \RuntimeException('Unowned node');
162		}
163
164	6	if ($this->node->parentNode === null) {
165	6	throw new \RuntimeException('Cannot setFinalMarkdown() on a node without a parent');
166		}
167
168		$markdownNode = $this->node->ownerDocument->createTextNode($markdown);
169		$this->node->parentNode->replaceChild($markdownNode, $this->node);
170		}
171
172		public function getChildrenAsString(): string
173		{
174	96	return $this->node->C14N();
175		}
176	96
177	6	public function getSiblingPosition(): int
178	4	{
179		$position = 0;
180	96
181	96	$parent = $this->getParent();
182	96	if ($parent === null) {
183		return $position;
184		}
185	96
186	24	// Loop through all nodes and find the given $node
187		foreach ($parent->getChildren() as $currentNode) {
188	64	if (! $currentNode->isWhitespace()) {
189		$position++;
190		}
191
192		// TODO: Need a less-buggy way of comparing these
193		// Perhaps we can somehow ensure that we always have the exact same object and use === instead?
194		if ($this->equals($currentNode)) {
195		break;
196	96	}
197		}
198	96
199	96	return $position;
200	96	}
201
202		public function getListItemLevel(): int
203		{
204		$level = 0;
205	87	$parent = $this->getParent();
206
207	87	while ($parent !== null && $parent->hasParent()) {
208		if ($parent->getTagName() === 'li') {
209		$level++;
210		}
211
212		$parent = $parent->getParent();
213	9	}
214
215	9	return $level;
216		}
217
218	9	public function getAttribute(string $name): string
219	9	{
220	9	if ($this->node instanceof \DOMElement) {
221	6	return $this->node->getAttribute($name);
222		}
223
224		return '';
225	9	}
226	9
227		public function equals(ElementInterface $element): bool
228	6	{
229		if ($element instanceof self) {
230	9	return $element->node === $this->node;
231		}
232
233		return false;
234		}
235		}
236

thephpleague / html-to-markdown

Push — master ( 44d65f...3ad102 )

Element::setFinalMarkdown() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like