UserGroupTest - Code Metrics - Inspection of "Minor User & UserGroup properties fixes (#2021)" - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d6b271...11b69a )

by André

created 2017-06-19 09:37 UTC

UserGroupTest A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	101
Duplicated Lines	20.79 %

Coupling/Cohesion

Components	2
Dependencies	3

Importance

Changes

Metric	Value
dl	21
loc	101
rs	10
c	0
b	0
f	0
wmc	9
lcom	2
cbo	3

6 Methods

Rating	Name	Duplication	Size	Complexity
A	testNewClass()	0	14	1
A	testMissingProperty()	0	6	1
A	testObjectProperties()	21	21	4
A	testReadOnlyProperty()	0	6	1
A	testIsPropertySet()	0	9	1
A	testUnsetProperty()	0	6	1

How to fix Duplicated Code

<?php

/**
 * File containing the UserGroupTest 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\Core\Repository\Values\User\UserGroup;
use PHPUnit_Framework_TestCase;

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

    /**
     * @covers \eZ\Publish\Core\Repository\Values\User\UserGroup::__construct
     */
    public function testNewClass()
    {
        $group = new UserGroup();
        self::assertEquals(null, $group->parentId);
<?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(null, $group->subGroupCount);
<?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.");
        }
    }

}

        $this->assertPropertiesCorrect(
            [
                'parentId' => null,
                'subGroupCount' => null,
            ],
            $group
        );
    }

    /**
     * Test retrieving missing property.
     *
     * @covers \eZ\Publish\API\Repository\Values\User\UserGroup::__get
     * @expectedException \eZ\Publish\API\Repository\Exceptions\PropertyNotFoundException
     */
    public function testMissingProperty()
    {
        $userGroup = new UserGroup();
        $value = $userGroup->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');
    }

    /**
     * @covers \eZ\Publish\Core\Repository\Values\User\UserGroup::getProperties
     */
    public function testObjectProperties()
    {
        $object = new UserGroup();
        $properties = $object->attributes();

        self::assertNotContains('internalFields', $properties, 'Internal property found ');
        self::assertContains('id', $properties, 'Property not found ');
        self::assertContains('fields', $properties, 'Property not found ');
        self::assertContains('versionInfo', $properties, 'Property not found ');
        self::assertContains('contentInfo', $properties, 'Property not found ');

        // check for duplicates and double check existence of property
        $propertiesHash = [];
        foreach ($properties as $property) {
            if (isset($propertiesHash[$property])) {
                self::fail("Property '{$property}' exists several times in properties list");
            } elseif (!isset($object->$property)) {
                self::fail("Property '{$property}' does not exist on object, even though it was hinted to be there");
            }
            $propertiesHash[$property] = 1;
        }
    }

    /**
     * Test setting read only property.
     *
     * @covers \eZ\Publish\API\Repository\Values\User\UserGroup::__set
     * @expectedException \eZ\Publish\API\Repository\Exceptions\PropertyReadOnlyException
     */
    public function testReadOnlyProperty()
    {
        $userGroup = new UserGroup();
        $userGroup->parentId = 42;
<?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\UserGroup::__isset
     */
    public function testIsPropertySet()
    {
        $userGroup = new UserGroup();
        $value = isset($userGroup->notDefined);
        self::assertEquals(false, $value);

        $value = isset($userGroup->parentId);
<?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\UserGroup::__unset
     * @expectedException \eZ\Publish\API\Repository\Exceptions\PropertyReadOnlyException
     */
    public function testUnsetProperty()
    {
        $userGroup = new UserGroup(['parentId' => 1]);
        unset($userGroup->parentId);
        self::fail('Unsetting read-only property succeeded');
    }
}


1		<?php
2
3		/**
4		* File containing the UserGroupTest 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\Core\Repository\Values\User\UserGroup;
13		use PHPUnit_Framework_TestCase;
14
15		/**
16		* Test internal integrity of @see \eZ\Publish\Core\Repository\Values\User\UserGroup.
17		*/
18		class UserGroupTest extends PHPUnit_Framework_TestCase
19		{
20		use ValueObjectTestTrait;
21
22		/**
23		* @covers \eZ\Publish\Core\Repository\Values\User\UserGroup::__construct
24		*/
25		public function testNewClass()
26		{
27		$group = new UserGroup();
28		self::assertEquals(null, $group->parentId);
		0 ignored issues – show Documentation introduced 2017-01-25 10:19 UTC by Report Bug Copy Issue Report The property `$parentId` is declared protected in `eZ\Publish\API\Repository\Values\User\UserGroup`. 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...
29		self::assertEquals(null, $group->subGroupCount);
		0 ignored issues – show Documentation introduced 2017-01-25 10:19 UTC by Report Bug Copy Issue Report The property `$subGroupCount` is declared protected in `eZ\Publish\API\Repository\Values\User\UserGroup`. 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... Deprecated Code introduced 2017-01-25 10:19 UTC by Report Bug Copy Issue Report The property `eZ\Publish\API\Repositor...erGroup::$subGroupCount` has been deprecated with message: As of eZ Publish 5.3.3, count can be obtained on demand using location service. This property has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the property will be removed from the class and what other property to use instead. Loading history...
30
31		$this->assertPropertiesCorrect(
32		[
33		'parentId' => null,
34		'subGroupCount' => null,
35		],
36		$group
37		);
38		}
39
40		/**
41		* Test retrieving missing property.
42		*
43		* @covers \eZ\Publish\API\Repository\Values\User\UserGroup::__get
44		* @expectedException \eZ\Publish\API\Repository\Exceptions\PropertyNotFoundException
45		*/
46		public function testMissingProperty()
47		{
48		$userGroup = new UserGroup();
49		$value = $userGroup->notDefined;
		0 ignored issues – show Documentation introduced 2017-01-25 10:19 UTC by Report Bug Copy Issue Report The property `notDefined` does not exist on `object<eZ\Publish\Core\R...\Values\User\UserGroup>`. 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-01-25 10:19 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...
50		self::fail('Succeeded getting non existing property');
51		}
52
53		/**
54		* @covers \eZ\Publish\Core\Repository\Values\User\UserGroup::getProperties
55		*/
56	View Code Duplication	public function testObjectProperties()
57		{
58		$object = new UserGroup();
59		$properties = $object->attributes();
		0 ignored issues – show Deprecated Code introduced 2015-11-21 14:37 UTC by Report Bug Copy Issue Report The method `eZ\Publish\API\Repositor...lueObject::attributes()` has been deprecated with message: Since 5.0, available purely for legacy eZTemplate compatibility This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
60		self::assertNotContains('internalFields', $properties, 'Internal property found ');
61		self::assertContains('id', $properties, 'Property not found ');
62		self::assertContains('fields', $properties, 'Property not found ');
63		self::assertContains('versionInfo', $properties, 'Property not found ');
64		self::assertContains('contentInfo', $properties, 'Property not found ');
65
66		// check for duplicates and double check existence of property
67		$propertiesHash = [];
68		foreach ($properties as $property) {
69		if (isset($propertiesHash[$property])) {
70		self::fail("Property '{$property}' exists several times in properties list");
71		} elseif (!isset($object->$property)) {
72		self::fail("Property '{$property}' does not exist on object, even though it was hinted to be there");
73		}
74		$propertiesHash[$property] = 1;
75		}
76		}
77
78		/**
79		* Test setting read only property.
80		*
81		* @covers \eZ\Publish\API\Repository\Values\User\UserGroup::__set
82		* @expectedException \eZ\Publish\API\Repository\Exceptions\PropertyReadOnlyException
83		*/
84		public function testReadOnlyProperty()
85		{
86		$userGroup = new UserGroup();
87		$userGroup->parentId = 42;
		0 ignored issues – show Documentation introduced 2017-04-18 15:26 UTC by Report Bug Copy Issue Report The property `$parentId` is declared protected in `eZ\Publish\API\Repository\Values\User\UserGroup`. 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...
88		self::fail('Succeeded setting read only property');
89		}
90
91		/**
92		* Test if property exists.
93		*
94		* @covers \eZ\Publish\API\Repository\Values\User\UserGroup::__isset
95		*/
96		public function testIsPropertySet()
97		{
98		$userGroup = new UserGroup();
99		$value = isset($userGroup->notDefined);
100		self::assertEquals(false, $value);
101
102		$value = isset($userGroup->parentId);
		0 ignored issues – show Documentation introduced 2017-04-18 15:26 UTC by Report Bug Copy Issue Report The property `$parentId` is declared protected in `eZ\Publish\API\Repository\Values\User\UserGroup`. 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...
103		self::assertEquals(true, $value);
104		}
105
106		/**
107		* Test unsetting a property.
108		*
109		* @covers \eZ\Publish\API\Repository\Values\User\UserGroup::__unset
110		* @expectedException \eZ\Publish\API\Repository\Exceptions\PropertyReadOnlyException
111		*/
112		public function testUnsetProperty()
113		{
114		$userGroup = new UserGroup(['parentId' => 1]);
115		unset($userGroup->parentId);
116		self::fail('Unsetting read-only property succeeded');
117		}
118		}
119

ezsystems / ezpublish-kernel

Push — master ( d6b271...11b69a )

UserGroupTest A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like