AssertTrait - Code Metrics - Inspection of "Extended and exposed permission system" - Schlaefer/Saito - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — feature/currentUserRefactoring (c13c1d)

by Schlaefer

created 2019-10-31 06:54 UTC

AssertTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

Metric	Value
dl	0
loc	110
rs	10
c	0
b	0
f	0
wmc	14
lcom	0
cbo	1

5 Methods

Rating	Name	Size	Complexity
A	assertContainsTag()	20	4
A	assertXPath()	11	1
A	assertNotXPath()	4	1
A	_getDOMXPath()	10	1
B	assertFlash()	22	7

<?php

declare(strict_types=1);

/**
 * Saito - The Threaded Web Forum
 *
 * @copyright Copyright (c) the Saito Project Developers
 * @link https://github.com/Schlaefer/Saito
 * @license http://opensource.org/licenses/MIT
 */

namespace Saito\Test;

use AssertionError;
use Symfony\Component\DomCrawler\Crawler;

/**
 * Non-depended assumptions
 */
trait AssertTrait
{
    /**
     * assert contains tag
     *
     * @param array $expected expected
     * @param string $result HTML
     * @return void
     */
    public function assertContainsTag($expected, $result)
    {
        do {
            $crawler = new Crawler;
            $crawler->addHtmlContent($result);
            $selector = key($expected);
            $node = $crawler->filter($selector);
            $this->assertEquals(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                1,
                $node->count(),
                "Selector '$selector' not found."
            );

            if (isset($expected[$selector]['attributes'])) {
                foreach ($expected[$selector]['attributes'] as $attribute => $value) {
                    $this->assertEquals($value, $node->attr($attribute));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                }
            }
        } while (next($expected));
    }

    /**
     * tests if XPath exists in HTML Source
     *
     * @param string $html HTML
     * @param string $path XPath
     * @param int $count how many times should XPath exist in HTML
     * @return mixed
     */
    public function assertXPath($html, $path, $count = 1)
    {
        $xpath = $this->_getDOMXPath($html);
        $length = $xpath->query($path)->length;

        return $this->assertEquals(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $count,
            $length,
            "Failed XPath. Expected '$path' to be found $count times instead of $length."
        );
    }

    /**
     * assert not xpath
     *
     * @param string $html path
     * @param string $path path
     * @return bool
     */
    public function assertNotXPath($html, $path)
    {
        return !$this->assertXPath($html, $path, 0);
    }

    /**
     * get dom xpath
     *
     * @param string $html HTML
     * @return \DOMXPath
     */
    protected function _getDOMXPath($html)
    {
        $document = new \DOMDocument;
        libxml_use_internal_errors(true);
        $document->loadHTML('<!DOCTYPE html>' . $html);
        $xpath = new \DOMXPath($document);
        libxml_clear_errors();

        return $xpath;
    }

    /**
     * Assert Flash message was set
     *
     * @param string $message message
     * @param string $element element
     * @param bool $debug debugging
     * @return void
     */
    protected function assertFlash(string $message, string $element = null, $debug = false): void
    {
        if ($debug) {
            debug($_SESSION['Flash']['flash']);
        }
        if (!empty($_SESSION['Flash']['flash'])) {
            foreach ($_SESSION['Flash']['flash'] as $flash) {
                if ($flash['message'] !== $message) {
                    continue;
                }
                if ($element !== null && $flash['element'] !== 'Flash/' . $element) {
                    continue;
                }

                return;
            }
        }

        throw new AssertionError(
            sprintf('Flash message "%s" was not set.', $message)

        );
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/**
6			* Saito - The Threaded Web Forum
7			*
8			* @copyright Copyright (c) the Saito Project Developers
9			* @link https://github.com/Schlaefer/Saito
10			* @license http://opensource.org/licenses/MIT
11			*/
12
13			namespace Saito\Test;
14
15			use AssertionError;
16			use Symfony\Component\DomCrawler\Crawler;
17
18			/**
19			* Non-depended assumptions
20			*/
21			trait AssertTrait
22			{
23			/**
24			* assert contains tag
25			*
26			* @param array $expected expected
27			* @param string $result HTML
28			* @return void
29			*/
30			public function assertContainsTag($expected, $result)
31			{
32			do {
33			$crawler = new Crawler;
34			$crawler->addHtmlContent($result);
35			$selector = key($expected);
36			$node = $crawler->filter($selector);
37			$this->assertEquals(
			0 ignored issues – show Bug introduced 2019-05-16 13:57 UTC by Report Bug Copy Issue Report It seems like `assertEquals()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
38			1,
39			$node->count(),
40			"Selector '$selector' not found."
41			);
42
43			if (isset($expected[$selector]['attributes'])) {
44			foreach ($expected[$selector]['attributes'] as $attribute => $value) {
45			$this->assertEquals($value, $node->attr($attribute));
			0 ignored issues – show Bug introduced 2019-05-16 13:57 UTC by Report Bug Copy Issue Report It seems like `assertEquals()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
46			}
47			}
48			} while (next($expected));
49			}
50
51			/**
52			* tests if XPath exists in HTML Source
53			*
54			* @param string $html HTML
55			* @param string $path XPath
56			* @param int $count how many times should XPath exist in HTML
57			* @return mixed
58			*/
59			public function assertXPath($html, $path, $count = 1)
60			{
61			$xpath = $this->_getDOMXPath($html);
62			$length = $xpath->query($path)->length;
63
64			return $this->assertEquals(
			0 ignored issues – show Bug introduced 2019-05-16 13:57 UTC by Report Bug Copy Issue Report It seems like `assertEquals()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
65			$count,
66			$length,
67			"Failed XPath. Expected '$path' to be found $count times instead of $length."
68			);
69			}
70
71			/**
72			* assert not xpath
73			*
74			* @param string $html path
75			* @param string $path path
76			* @return bool
77			*/
78			public function assertNotXPath($html, $path)
79			{
80			return !$this->assertXPath($html, $path, 0);
81			}
82
83			/**
84			* get dom xpath
85			*
86			* @param string $html HTML
87			* @return \DOMXPath
88			*/
89			protected function _getDOMXPath($html)
90			{
91			$document = new \DOMDocument;
92			libxml_use_internal_errors(true);
93			$document->loadHTML('<!DOCTYPE html>' . $html);
94			$xpath = new \DOMXPath($document);
95			libxml_clear_errors();
96
97			return $xpath;
98			}
99
100			/**
101			* Assert Flash message was set
102			*
103			* @param string $message message
104			* @param string $element element
105			* @param bool $debug debugging
106			* @return void
107			*/
108			protected function assertFlash(string $message, string $element = null, $debug = false): void
109			{
110			if ($debug) {
111			debug($_SESSION['Flash']['flash']);
112			}
113			if (!empty($_SESSION['Flash']['flash'])) {
114			foreach ($_SESSION['Flash']['flash'] as $flash) {
115			if ($flash['message'] !== $message) {
116			continue;
117			}
118			if ($element !== null && $flash['element'] !== 'Flash/' . $element) {
119			continue;
120			}
121
122			return;
123			}
124			}
125
126			throw new AssertionError(
127			sprintf('Flash message "%s" was not set.', $message)
			0 ignored issues – show Unused Code introduced 2019-10-31 06:58 UTC by Report Bug Copy Issue Report The call to `AssertionError::__construct()` has too many arguments starting with `sprintf('Flash message "...as not set.', $message)`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
128			);
129			}
130			}
131

Schlaefer / Saito

Branch — feature/currentUserRefactoring (c13c1d)

AssertTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Duplication Side-by-Side

Filter issues like