Completed
Push — master ( 03e47f...db33ac )
by WEBEWEB
06:42 queued 01:35
created

NavigationNodeTest   A

Complexity

Total Complexity 2

Size/Duplication

Total Lines 54
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 3

Importance

Changes 4
Bugs 0 Features 0
Metric Value
wmc 2
c 4
b 0
f 0
lcom 0
cbo 3
dl 0
loc 54
rs 10

2 Methods

Rating   Name   Duplication   Size   Complexity  
B testConstructor() 0 26 1
A testIsDisplayable() 0 13 1
1
<?php
2
3
/**
4
 * This file is part of the core-library package.
5
 *
6
 * (c) 2017 NdC/WBW
7
 *
8
 * For the full copyright and license information, please view the LICENSE
9
 * file that was distributed with this source code.
10
 */
11
12
namespace WBW\Library\Core\Tests\Navigation\Node;
13
14
use PHPUnit_Framework_TestCase;
15
use WBW\Library\Core\Navigation\Item\NavigationItem;
16
use WBW\Library\Core\Navigation\Node\NavigationNode;
17
18
/**
19
 * Navigation node test.
20
 *
21
 * @author NdC/WBW <https://github.com/webeweb/>
22
 * @package WBW\Library\Core\Tests\Navigation\Node
23
 * @final
24
 */
25
final class NavigationNodeTest extends PHPUnit_Framework_TestCase {
26
27
	/**
28
	 * Tests the __construct() method.
29
	 *
30
	 * @return void
31
	 */
32
	public function testConstructor() {
33
34
		$obj = new NavigationNode("id");
35
36
		$this->assertEquals(false, $obj->getActive());
37
		$this->assertEquals(false, $obj->getEnable());
38
		$this->assertEquals(null, $obj->getIcon());
39
		$this->assertEquals(null, $obj->getRoute());
40
		$this->assertEquals(null, $obj->getTarget());
41
		$this->assertEquals(null, $obj->getUrl());
42
		$this->assertEquals(true, $obj->getVisible());
43
44
		$obj->setActive(true);
45
		$obj->setEnable(true);
46
		$obj->setIcon("icon");
47
		$obj->setRoute("route");
48
		$obj->setTarget("_blank");
49
		$obj->setUrl("url");
50
51
		$this->assertEquals(true, $obj->getActive());
52
		$this->assertEquals(true, $obj->getEnable());
53
		$this->assertEquals("icon", $obj->getIcon());
54
		$this->assertEquals("route", $obj->getRoute());
55
		$this->assertEquals("_blank", $obj->getTarget());
56
		$this->assertEquals("url", $obj->getUrl());
57
	}
58
59
	/**
60
	 * Tests the isDisplayable() method.
61
	 *
62
	 * @return void
63
	 */
64
	public function testIsDisplayable() {
65
66
		$obj = new NavigationNode("id");
67
68
		$obj->addNode(new NavigationItem("id1"));
0 ignored issues
show
Deprecated Code introduced by
The class WBW\Library\Core\Navigation\Item\NavigationItem has been deprecated.

This class, trait or interface has been deprecated.

Loading history...
69
		$obj->addNode(new NavigationNode("id2"));
70
71
		$this->assertEquals(false, $obj->isDisplayable());
72
73
		$obj->getLastNode()->setActive(true);
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class WBW\Library\Core\Node\AbstractNode as the method setActive() does only exist in the following sub-classes of WBW\Library\Core\Node\AbstractNode: WBW\Library\Core\Navigat...\AbstractNavigationNode, WBW\Library\Core\Navigation\Node\BreadcrumbNode, WBW\Library\Core\Navigation\Node\NavigationNode, WBW\Library\Core\Navigation\Tree\NavigationTree. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
74
		$obj->getLastNode()->setEnable(true);
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class WBW\Library\Core\Node\AbstractNode as the method setEnable() does only exist in the following sub-classes of WBW\Library\Core\Node\AbstractNode: WBW\Library\Core\Navigat...\AbstractNavigationNode, WBW\Library\Core\Navigation\Node\BreadcrumbNode, WBW\Library\Core\Navigation\Node\NavigationNode, WBW\Library\Core\Navigation\Tree\NavigationTree. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
75
		$this->assertEquals(true, $obj->isDisplayable());
76
	}
77
78
}
79