PropertiesSpec::readOnlyPropertyBehavior() - Code Metrics - Inspection of "#1: draft implementation of properties" - php-kitchen/platform - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 38c8ff...90c00b )

by Dmitry

created 2018-01-26 18:24 UTC

PropertiesSpec::readOnlyPropertyBehavior() A

↳ Parent: PropertiesSpec

Complexity

Conditions	1
Paths	1

Size

Total Lines	19
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	14
nc	1
nop	0
dl	0
loc	19
rs	9.4285
c	0
b	0
f	0

<?php

namespace PHPKitchen\Platform\Specs\Unit\Mixin;

use PHPKitchen\Platform\Exception\Runtime\Property\InvalidAccessException;
use PHPKitchen\Platform\Exception\Runtime\Property\UndefinedPropertyException;
use PHPKitchen\Platform\Mixin\Properties;
use PHPKitchen\Platform\Specs\Base\Spec;

/**
 * Specification of {@link Properies}
 *
 * @author Dmitry Kolodko <[email protected]>
 */
class PropertiesSpec extends Spec {
    protected const TEST_USER_NAME = 'Alex';
    protected const TEST_USER_SEX = 'Male';

    /**
     * @test
     */
    public function getterAndSetterBehavior() {
        $user = $this->createClassWithProperties();
        $I = $this->tester;

        $I->describe('behavior of read/write available properties');


        $I->verifyThat('property defined by get/set methods is accessible to read and writes');


        $I->expectThat('property is readable');

        $I->lookAt('name property');

        $I->seeString($user->name)
<?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.");
        }
    }

}
          ->isEqualTo(self::TEST_USER_NAME);

        $user->name = $newName = 'Anton';
<?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.");
        }
    }

}

        $I->expectThat('property is writable');

        $I->lookAt('name property');

        $I->seeString($user->name)
<?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.");
        }
    }

}
          ->isEqualTo($newName);
    }

    /**
     * @test
     */
    public function readOnlyPropertyBehavior() {
        $user = $this->createClassWithProperties();
        $I = $this->tester;

        $I->describe('behavior of read only properties');


        $I->verifyThat('property defined by "get" method accessible to read but not to write');


        $I->expectThat('property is readable');

        $I->lookAt('sex property');

        $I->seeString($user->sex)
<?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.");
        }
    }

}
          ->isEqualTo(self::TEST_USER_SEX);

        $I->expectThat('property is not writable');

        $I->seeObject($user)

          ->throwsException(InvalidAccessException::class)
          ->when(function ($user) {
              $user->sex = 'Female';
          });
    }

    /**
     * @test
     */
    public function writeOnlyPropertyBehavior() {
        $user = $this->createClassWithProperties();
        $I = $this->tester;

        $I->describe('behavior of write only properties');


        $I->verifyThat('property defined by "set" method is accessible to write and not to read');


        $I->expectThat('property is writable');


        $user->punch = 1;
<?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.");
        }
    }

}

        $I->expectThat('property is not readable');

        $I->seeObject($user)

          ->throwsException(InvalidAccessException::class)
          ->when(function ($user) {
              $p = $user->punch;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
          });
    }

    /**
     * @test
     */
    public function undefinedPropertyBehavior() {
        $user = $this->createClassWithProperties();
        $I = $this->tester;

        $I->describe('behavior of undefined properties access');


        $I->expectThat('reading of undefined properties is not allowed');

        $I->seeObject($user)

          ->throwsException(UndefinedPropertyException::class)
          ->when(function ($user) {
              $no = $user->noProperty;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
          });

        $I->expectThat('writing to undefined properties is not allowed');

        $I->seeObject($user)

          ->throwsException(UndefinedPropertyException::class)
          ->when(function ($user) {
              $user->noProperty = 123;
          });
    }

    /**
     * @test
     */
    public function conditionalPropertiesBehavior() {
        $user = $this->createClassWithProperties();
        $I = $this->tester;

        $I->describe('behavior of read conditional properties');


        $I->verifyThat('property defined by "is" or "has" method accessible to read but not to write');


        $I->expectThat('"is*" property is readable');

        $I->lookAt('status condition');

        $I->seeBool($user->isActive)

          ->isTrue();

        $I->expectThat('"has*" property is readable');

        $I->lookAt('name status condition');

        $I->seeBool($user->hasName)
<?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.");
        }
    }

}
          ->isTrue();

        $I->expectThat('"is*" condition property is not writable');

        $I->seeObject($user)

          ->throwsException(UndefinedPropertyException::class)
          ->when(function ($user) {
              $user->isActive = false;
          });

        $I->expectThat('"has*" condition property is not writable');

        $I->seeObject($user)

          ->throwsException(UndefinedPropertyException::class)
          ->when(function ($user) {
              $user->hasName = false;
          });
    }

    protected function createClassWithProperties() {
        return new class {

            use Properties;
            protected $_name = 'Alex';

            protected $_sex = 'Male';

            protected $active = true;

            public function getSex() {
                return $this->_sex;
            }

            public function getName() {
                return $this->_name;
            }

            public function setName($name) {
                $this->_name = $name;
            }

            public function setPunch($p) {

                // just a stub
            }

            public function isActive() {
                return $this->active;
            }

            public function hasName() {
                return !empty($this->_name);
            }
        };
    }
}

1			<?php
2
3			namespace PHPKitchen\Platform\Specs\Unit\Mixin;
4
5			use PHPKitchen\Platform\Exception\Runtime\Property\InvalidAccessException;
6			use PHPKitchen\Platform\Exception\Runtime\Property\UndefinedPropertyException;
7			use PHPKitchen\Platform\Mixin\Properties;
8			use PHPKitchen\Platform\Specs\Base\Spec;
9
10			/**
11			* Specification of {@link Properies}
12			*
13			* @author Dmitry Kolodko <[email protected]>
14			*/
15			class PropertiesSpec extends Spec {
16			protected const TEST_USER_NAME = 'Alex';
17			protected const TEST_USER_SEX = 'Male';
18
19			/**
20			* @test
21			*/
22			public function getterAndSetterBehavior() {
23			$user = $this->createClassWithProperties();
24			$I = $this->tester;
			0 ignored issues – show Coding Style introduced 2018-01-26 18:25 UTC by Report Bug Copy Issue Report `$I` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
25			$I->describe('behavior of read/write available properties');
			0 ignored issues – show Coding Style introduced 2018-01-26 18:25 UTC by Report Bug Copy Issue Report `$I` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
26
27			$I->verifyThat('property defined by get/set methods is accessible to read and writes');
			0 ignored issues – show Coding Style introduced 2018-01-26 18:25 UTC by Report Bug Copy Issue Report `$I` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
28
29			$I->expectThat('property is readable');
			0 ignored issues – show Coding Style introduced 2018-01-26 18:25 UTC by Report Bug Copy Issue Report `$I` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
30			$I->lookAt('name property');
			0 ignored issues – show Coding Style introduced 2018-01-26 18:25 UTC by Report Bug Copy Issue Report `$I` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]*$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
31			$I->seeString($user->name)
			0 ignored issues – show Coding Style introduced 2018-01-26 18:25 UTC by Report Bug Copy Issue Report `$I` does not seem to conform to the naming convention (`^[a-z][a-zA-Z0-9]$`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history... Documentation introduced 2018-01-26 18:25 UTC by Report Bug Copy Issue Report The property `name` does not exist on `object<PHPKitchen\Platfo...n/PropertiesSpec.php$0>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
32			->isEqualTo(self::TEST_USER_NAME);
33
34			$user->name = $newName = 'Anton';

php-kitchen / platform

Push — master ( 38c8ff...90c00b )

PropertiesSpec::readOnlyPropertyBehavior() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like