UserTest - Code Metrics - Inspection of "EZP-27498: [API] Add shorthand name property on Co..." - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 6.10 ( 0b123e...da1d28 )

by André

created 2017-06-19 11:47 UTC

UserTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	99
Duplicated Lines	13.13 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	13
loc	99
rs	10
c	1
b	0
f	0
wmc	6
lcom	1
cbo	5

6 Methods

Rating	Name	Duplication	Size	Complexity
A	testNewClass()	0	16	1
A	testMissingProperty()	0	6	1
A	testReadOnlyProperty()	0	6	1
A	testIsPropertySet()	0	9	1
A	testUnsetProperty()	0	6	1
A	testGetName()	13	13	1

How to fix Duplicated Code

<?php

/**
 * File containing the UserTest class.
 *
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
namespace eZ\Publish\Core\Repository\Tests\Values\User;

use eZ\Publish\API\Repository\Tests\Values\ValueObjectTestTrait;
use eZ\Publish\API\Repository\Values\Content\Content;
use eZ\Publish\API\Repository\Values\Content\VersionInfo;
use eZ\Publish\Core\Repository\Values\User\User;
use Mockery;
use PHPUnit_Framework_TestCase;

/**
 * Test internal integrity of @see \eZ\Publish\Core\Repository\Values\User\User ValueObject.
 */
class UserTest extends PHPUnit_Framework_TestCase
{
    use ValueObjectTestTrait;

    /**
     * Test a new class and default values on properties.
     *
     * @covers \eZ\Publish\Core\Repository\Values\User\User::__construct
     */
    public function testNewClass()
    {
        $user = new User();

        $this->assertPropertiesCorrect(
            [
                'login' => null,
                'email' => null,
                'passwordHash' => null,
                'hashAlgorithm' => null,
                'maxLogin' => null,
                'enabled' => false,
            ],
            $user
        );
    }

    /**
     * Test getName method.
     *
     * @covers \eZ\Publish\Core\Repository\Values\User\User::getName
     */
    public function testGetName()
    {
        $name = 'Translated name';
        $contentMock = Mockery::mock(Content::class);
        $versionInfoMock = Mockery::mock(VersionInfo::class);

        $contentMock->shouldReceive('getVersionInfo')->andReturn($versionInfoMock);
        $versionInfoMock->shouldReceive('getName')->andReturn($name);

        $object = new User(['content' => $contentMock]);

        $this->assertEquals($name, $object->getName());
    }

    /**
     * Test retrieving missing property.
     *
     * @covers \eZ\Publish\API\Repository\Values\User\User::__get
     * @expectedException \eZ\Publish\API\Repository\Exceptions\PropertyNotFoundException
     */
    public function testMissingProperty()
    {
        $user = new User();
        $value = $user->notDefined;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        self::fail('Succeeded getting non existing property');
    }

    /**
     * Test setting read only property.
     *
     * @covers \eZ\Publish\API\Repository\Values\User\User::__set
     * @expectedException \eZ\Publish\API\Repository\Exceptions\PropertyReadOnlyException
     */
    public function testReadOnlyProperty()
    {
        $user = new User();
        $user->login = 'user';
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        self::fail('Succeeded setting read only property');
    }

    /**
     * Test if property exists.
     *
     * @covers \eZ\Publish\API\Repository\Values\User\User::__isset
     */
    public function testIsPropertySet()
    {
        $user = new User();
        $value = isset($user->notDefined);
        self::assertEquals(false, $value);

        $value = isset($user->login);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        self::assertEquals(true, $value);
    }

    /**
     * Test unsetting a property.
     *
     * @covers \eZ\Publish\API\Repository\Values\User\User::__unset
     * @expectedException \eZ\Publish\API\Repository\Exceptions\PropertyReadOnlyException
     */
    public function testUnsetProperty()
    {
        $user = new User(['login' => 'admin']);
        unset($user->login);
        self::fail('Unsetting read-only property succeeded');
    }
}


1		<?php
2
3		/**
4		* File containing the UserTest class.
5		*
6		* @copyright Copyright (C) eZ Systems AS. All rights reserved.
7		* @license For full copyright and license information view LICENSE file distributed with this source code.
8		*/
9		namespace eZ\Publish\Core\Repository\Tests\Values\User;
10
11		use eZ\Publish\API\Repository\Tests\Values\ValueObjectTestTrait;
12		use eZ\Publish\API\Repository\Values\Content\Content;
13		use eZ\Publish\API\Repository\Values\Content\VersionInfo;
14		use eZ\Publish\Core\Repository\Values\User\User;
15		use Mockery;
16		use PHPUnit_Framework_TestCase;
17
18		/**
19		* Test internal integrity of @see \eZ\Publish\Core\Repository\Values\User\User ValueObject.
20		*/
21		class UserTest extends PHPUnit_Framework_TestCase
22		{
23		use ValueObjectTestTrait;
24
25		/**
26		* Test a new class and default values on properties.
27		*
28		* @covers \eZ\Publish\Core\Repository\Values\User\User::__construct
29		*/
30		public function testNewClass()
31		{
32		$user = new User();
33
34		$this->assertPropertiesCorrect(
35		[
36		'login' => null,
37		'email' => null,
38		'passwordHash' => null,
39		'hashAlgorithm' => null,
40		'maxLogin' => null,
41		'enabled' => false,
42		],
43		$user
44		);
45		}
46
47		/**
48		* Test getName method.
49		*
50		* @covers \eZ\Publish\Core\Repository\Values\User\User::getName
51		*/
52	View Code Duplication	public function testGetName()
53		{
54		$name = 'Translated name';
55		$contentMock = Mockery::mock(Content::class);
56		$versionInfoMock = Mockery::mock(VersionInfo::class);
57
58		$contentMock->shouldReceive('getVersionInfo')->andReturn($versionInfoMock);
59		$versionInfoMock->shouldReceive('getName')->andReturn($name);
60
61		$object = new User(['content' => $contentMock]);
62
63		$this->assertEquals($name, $object->getName());
64		}
65
66		/**
67		* Test retrieving missing property.
68		*
69		* @covers \eZ\Publish\API\Repository\Values\User\User::__get
70		* @expectedException \eZ\Publish\API\Repository\Exceptions\PropertyNotFoundException
71		*/
72		public function testMissingProperty()
73		{
74		$user = new User();
75		$value = $user->notDefined;
		0 ignored issues – show Documentation introduced 2017-04-18 15:26 UTC by Report Bug Copy Issue Report The property `notDefined` does not exist on `object<eZ\Publish\Core\R...itory\Values\User\User>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Unused Code introduced 2017-04-18 15:26 UTC by Report Bug Copy Issue Report `$value` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
76		self::fail('Succeeded getting non existing property');
77		}
78
79		/**
80		* Test setting read only property.
81		*
82		* @covers \eZ\Publish\API\Repository\Values\User\User::__set
83		* @expectedException \eZ\Publish\API\Repository\Exceptions\PropertyReadOnlyException
84		*/
85		public function testReadOnlyProperty()
86		{
87		$user = new User();
88		$user->login = 'user';
		0 ignored issues – show Documentation introduced 2017-01-25 10:19 UTC by Report Bug Copy Issue Report The property `$login` is declared protected in `eZ\Publish\API\Repository\Values\User\User`. Since you implemented `__set()`, maybe consider adding a @property or @property-write annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
89		self::fail('Succeeded setting read only property');
90		}
91
92		/**
93		* Test if property exists.
94		*
95		* @covers \eZ\Publish\API\Repository\Values\User\User::__isset
96		*/
97		public function testIsPropertySet()
98		{
99		$user = new User();
100		$value = isset($user->notDefined);
101		self::assertEquals(false, $value);
102
103		$value = isset($user->login);
		0 ignored issues – show Documentation introduced 2017-04-18 15:26 UTC by Report Bug Copy Issue Report The property `$login` is declared protected in `eZ\Publish\API\Repository\Values\User\User`. Since you implemented `__get()`, maybe consider adding a @property or @property-read annotation. This makes it easier for IDEs to provide auto-completion. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
104		self::assertEquals(true, $value);
105		}
106
107		/**
108		* Test unsetting a property.
109		*
110		* @covers \eZ\Publish\API\Repository\Values\User\User::__unset
111		* @expectedException \eZ\Publish\API\Repository\Exceptions\PropertyReadOnlyException
112		*/
113		public function testUnsetProperty()
114		{
115		$user = new User(['login' => 'admin']);
116		unset($user->login);
117		self::fail('Unsetting read-only property succeeded');
118		}
119		}
120

ezsystems / ezpublish-kernel

Push — 6.10 ( 0b123e...da1d28 )

UserTest A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like