PhpEnumTypeTest - Code Metrics - jdecool/doctrine-mabe-enum-type - Measure and Improve Code Quality continuously with Scrutinizer

PhpEnumTypeTest A
last analyzed 2019-10-07 18:52 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	223
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	84
c	1
b	0
f	0
dl	0
loc	223
rs	10
wmc	16

16 Methods

Rating	Name	Size	Complexity
A	convertToDatabaseValueParsesEnum()	7	1
A	getType()	4	1
A	setUp()	11	1
A	convertToPHPValueWithCastingMethodProperlyCastsIt()	13	1
A	convertToPHPValueWithValidValueReturnsParsedData()	12	1
A	registerInvalidEnumThrowsException()	9	1
A	SQLCommentHintIsAlwaysRequired()	5	1
A	convertToDatabaseValueReturnsNullWhenNullIsProvided()	5	1
A	convertToPHPValueWithNullReturnsNull()	6	1
A	enumTypesAreProperlyRegistered()	12	1
A	enumTypesAreProperlyCustomizedWhenRegistered()	19	1
A	convertToPHPValueWithInvalidValueThrowsException()	11	1
A	getSQLDeclarationReturnsValueFromPlatform()	7	1
A	provideValues()	8	1
A	usingChildCustomEnumTypeRegisteredValueIsCorrect()	9	1
A	convertToDatabaseValueWithCastingMethodProperlyCastsIt()	6	1

<?php
declare(strict_types=1);

namespace JDecool\Test\Doctrine\Type;

use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\DBAL\Types\Type;
use JDecool\Doctrine\Exception\InvalidArgumentException;
use JDecool\Doctrine\Type\PhpEnumType;
use JDecool\Test\Doctrine\Enum\Action;
use JDecool\Test\Doctrine\Enum\Gender;
use JDecool\Test\Doctrine\Enum\WithCastingMethods;
use JDecool\Test\Doctrine\Enum\WithIntegerValues;
use MabeEnum\Enum;
use PHPUnit\Framework\TestCase;
use Prophecy\Argument;
use Prophecy\Prophecy\ObjectProphecy;
use ReflectionProperty;
use stdClass;
use function implode;
use function sprintf;

class PhpEnumTypeTest extends TestCase
{
    /** @var ObjectProphecy */
    protected $platform;

    public function setUp(): void
    {
        $this->platform = $this->prophesize(AbstractPlatform::class);

        // Before every test, clean registered types
        $refProp = new ReflectionProperty(Type::class, '_typeObjects');
        $refProp->setAccessible(true);
        $refProp->setValue(null, []);
        $refProp = new ReflectionProperty(Type::class, '_typesMap');
        $refProp->setAccessible(true);
        $refProp->setValue(null, []);
    }

    /**
     * @test
     */
    public function enumTypesAreProperlyRegistered(): void
    {
        $this->assertFalse(Type::hasType(Action::class));
        $this->assertFalse(Type::hasType('gender'));

        PhpEnumType::registerEnumType(Action::class);
        PhpEnumType::registerEnumTypes([
            'gender' => Gender::class,
        ]);

        $this->assertTrue(Type::hasType(Action::class));
        $this->assertTrue(Type::hasType('gender'));
    }

    /**
     * @test
     */
    public function enumTypesAreProperlyCustomizedWhenRegistered(): void
    {
        $this->assertFalse(Type::hasType(Action::class));
        $this->assertFalse(Type::hasType(Gender::class));

        PhpEnumType::registerEnumTypes([
            'gender' => Gender::class,
            Action::class,
        ]);

        /** @var Type $actionType */
        $actionType = Type::getType(Action::class);
        $this->assertInstanceOf(PhpEnumType::class, $actionType);
        $this->assertEquals(Action::class, $actionType->getName());

        /** @var Type $actionType */
        $genderType = Type::getType('gender');
        $this->assertInstanceOf(PhpEnumType::class, $genderType);
        $this->assertEquals('gender', $genderType->getName());
    }

    /**
     * @test
     */
    public function registerInvalidEnumThrowsException(): void
    {
        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionMessage(sprintf(
            'Provided enum class "%s" is not valid. Enums must extend "%s"',
            stdClass::class,
            Enum::class
        ));
        PhpEnumType::registerEnumType(stdClass::class);
    }

    /**
     * @test
     */
    public function getSQLDeclarationReturnsValueFromPlatform(): void
    {
        $this->platform->getVarcharTypeDeclarationSQL(Argument::cetera())->willReturn('declaration');

        $type = $this->getType(Gender::class);

        $this->assertEquals('declaration', $type->getSQLDeclaration([], $this->platform->reveal()));
    }

    /**
     * @test
     * @dataProvider provideValues
     * @param string $typeName
     * @param $phpValue
     * @param string $expectedValue
     */
    public function convertToDatabaseValueParsesEnum(string $typeName, $phpValue, string $expectedValue): void
    {
        $type = $this->getType($typeName);

        $actualValue = $type->convertToDatabaseValue($phpValue, $this->platform->reveal());

        $this->assertEquals($expectedValue, $actualValue);
    }

    public function provideValues(): iterable
    {
        yield [Action::class, Action::CREATE(), Action::CREATE];
        yield [Action::class, Action::READ(), Action::READ];
        yield [Action::class, Action::UPDATE(), Action::UPDATE];
        yield [Action::class, Action::DELETE(), Action::DELETE];
        yield [Gender::class, Gender::FEMALE(), Gender::FEMALE];
        yield [Gender::class, Gender::MALE(), Gender::MALE];
    }

    /**
     * @test
     */
    public function convertToDatabaseValueReturnsNullWhenNullIsProvided(): void
    {
        $type = $this->getType(Action::class);

        $this->assertNull($type->convertToDatabaseValue(null, $this->platform->reveal()));
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }

    /**
     * @test
     */
    public function convertToPHPValueWithValidValueReturnsParsedData(): void
    {
        $type = $this->getType(Action::class);

        /** @var Action $value */
        $value = $type->convertToPHPValue(Action::CREATE, $this->platform->reveal());
        $this->assertInstanceOf(Action::class, $value);
        $this->assertEquals(Action::CREATE, $value->getValue());

        $value = $type->convertToPHPValue(Action::DELETE, $this->platform->reveal());
        $this->assertInstanceOf(Action::class, $value);
        $this->assertEquals(Action::DELETE, $value->getValue());
    }

    /**
     * @test
     */
    public function convertToPHPValueWithNullReturnsNull(): void
    {
        $type = $this->getType(Action::class);

        $value = $type->convertToPHPValue(null, $this->platform->reveal());
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        $this->assertNull($value);
    }

    /**
     * @test
     */
    public function convertToPHPValueWithInvalidValueThrowsException(): void
    {
        $type = $this->getType(Action::class);

        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionMessage(sprintf(
            'The value "invalid" is not valid for the enum "%s". Expected one of ["%s"]',
            Action::class,
            implode('", "', Action::getConstants())
        ));
        $type->convertToPHPValue('invalid', $this->platform->reveal());
    }

    /**
     * @test
     */
    public function convertToPHPValueWithCastingMethodProperlyCastsIt(): void
    {
        $type = $this->getType(WithCastingMethods::class);

        $value = $type->convertToPHPValue('foo VALUE', $this->platform->reveal());
        $this->assertInstanceOf(WithCastingMethods::class, $value);
        $this->assertEquals(WithCastingMethods::FOO, $value->getValue());

        $intType = $this->getType(WithIntegerValues::class);

        $value = $intType->convertToPHPValue('1', $this->platform->reveal());
        $this->assertInstanceOf(WithIntegerValues::class, $value);
        $this->assertEquals(1, $value->getValue());
    }

    /**
     * @test
     */
    public function convertToDatabaseValueWithCastingMethodProperlyCastsIt(): void
    {
        $type = $this->getType(WithCastingMethods::class);

        $value = $type->convertToDatabaseValue(WithCastingMethods::FOO(), $this->platform->reveal());
        $this->assertEquals('FOO VALUE', $value);
    }

    /**
     * @test
     */
    public function usingChildCustomEnumTypeRegisteredValueIsCorrect(): void
    {
        MyCustomEnumType::registerEnumType(Action::class);
        $type = MyCustomEnumType::getType(Action::class);

        $this->assertInstanceOf(MyCustomEnumType::class, $type);
        $this->assertEquals(
            'ENUM("create", "read", "update", "delete") COMMENT "JDecool\Test\Doctrine\Enum\Action"',
            $type->getSQLDeclaration([], $this->platform->reveal())
        );
    }

    /**
     * @test
     */
    public function SQLCommentHintIsAlwaysRequired(): void
    {
        $type = $this->getType(Gender::class);

        $this->assertTrue($type->requiresSQLCommentHint($this->platform->reveal()));
    }

    private function getType(string $typeName): PhpEnumType
    {
        PhpEnumType::registerEnumType($typeName);
        return Type::getType($typeName);

    }
}


1			<?php
2			declare(strict_types=1);
3
4			namespace JDecool\Test\Doctrine\Type;
5
6			use Doctrine\DBAL\Platforms\AbstractPlatform;
7			use Doctrine\DBAL\Types\Type;
8			use JDecool\Doctrine\Exception\InvalidArgumentException;
9			use JDecool\Doctrine\Type\PhpEnumType;
10			use JDecool\Test\Doctrine\Enum\Action;
11			use JDecool\Test\Doctrine\Enum\Gender;
12			use JDecool\Test\Doctrine\Enum\WithCastingMethods;
13			use JDecool\Test\Doctrine\Enum\WithIntegerValues;
14			use MabeEnum\Enum;
15			use PHPUnit\Framework\TestCase;
16			use Prophecy\Argument;
17			use Prophecy\Prophecy\ObjectProphecy;
18			use ReflectionProperty;
19			use stdClass;
20			use function implode;
21			use function sprintf;
22
23			class PhpEnumTypeTest extends TestCase
24			{
25			/** @var ObjectProphecy */
26			protected $platform;
27
28			public function setUp(): void
29			{
30			$this->platform = $this->prophesize(AbstractPlatform::class);
31
32			// Before every test, clean registered types
33			$refProp = new ReflectionProperty(Type::class, '_typeObjects');
34			$refProp->setAccessible(true);
35			$refProp->setValue(null, []);
36			$refProp = new ReflectionProperty(Type::class, '_typesMap');
37			$refProp->setAccessible(true);
38			$refProp->setValue(null, []);
39			}
40
41			/**
42			* @test
43			*/
44			public function enumTypesAreProperlyRegistered(): void
45			{
46			$this->assertFalse(Type::hasType(Action::class));
47			$this->assertFalse(Type::hasType('gender'));
48
49			PhpEnumType::registerEnumType(Action::class);
50			PhpEnumType::registerEnumTypes([
51			'gender' => Gender::class,
52			]);
53
54			$this->assertTrue(Type::hasType(Action::class));
55			$this->assertTrue(Type::hasType('gender'));
56			}
57
58			/**
59			* @test
60			*/
61			public function enumTypesAreProperlyCustomizedWhenRegistered(): void
62			{
63			$this->assertFalse(Type::hasType(Action::class));
64			$this->assertFalse(Type::hasType(Gender::class));
65
66			PhpEnumType::registerEnumTypes([
67			'gender' => Gender::class,
68			Action::class,
69			]);
70
71			/** @var Type $actionType */
72			$actionType = Type::getType(Action::class);
73			$this->assertInstanceOf(PhpEnumType::class, $actionType);
74			$this->assertEquals(Action::class, $actionType->getName());
75
76			/** @var Type $actionType */
77			$genderType = Type::getType('gender');
78			$this->assertInstanceOf(PhpEnumType::class, $genderType);
79			$this->assertEquals('gender', $genderType->getName());
80			}
81
82			/**
83			* @test
84			*/
85			public function registerInvalidEnumThrowsException(): void
86			{
87			$this->expectException(InvalidArgumentException::class);
88			$this->expectExceptionMessage(sprintf(
89			'Provided enum class "%s" is not valid. Enums must extend "%s"',
90			stdClass::class,
91			Enum::class
92			));
93			PhpEnumType::registerEnumType(stdClass::class);
94			}
95
96			/**
97			* @test
98			*/
99			public function getSQLDeclarationReturnsValueFromPlatform(): void
100			{
101			$this->platform->getVarcharTypeDeclarationSQL(Argument::cetera())->willReturn('declaration');
102
103			$type = $this->getType(Gender::class);
104
105			$this->assertEquals('declaration', $type->getSQLDeclaration([], $this->platform->reveal()));
106			}
107
108			/**
109			* @test
110			* @dataProvider provideValues
111			* @param string $typeName
112			* @param $phpValue
113			* @param string $expectedValue
114			*/
115			public function convertToDatabaseValueParsesEnum(string $typeName, $phpValue, string $expectedValue): void
116			{
117			$type = $this->getType($typeName);
118
119			$actualValue = $type->convertToDatabaseValue($phpValue, $this->platform->reveal());
120
121			$this->assertEquals($expectedValue, $actualValue);
122			}
123
124			public function provideValues(): iterable
125			{
126			yield [Action::class, Action::CREATE(), Action::CREATE];
127			yield [Action::class, Action::READ(), Action::READ];
128			yield [Action::class, Action::UPDATE(), Action::UPDATE];
129			yield [Action::class, Action::DELETE(), Action::DELETE];
130			yield [Gender::class, Gender::FEMALE(), Gender::FEMALE];
131			yield [Gender::class, Gender::MALE(), Gender::MALE];
132			}
133
134			/**
135			* @test
136			*/
137			public function convertToDatabaseValueReturnsNullWhenNullIsProvided(): void
138			{
139			$type = $this->getType(Action::class);
140
141			$this->assertNull($type->convertToDatabaseValue(null, $this->platform->reveal()));
			0 ignored issues – show Bug introduced 2019-10-07 18:52 UTC by Report Bug Copy Issue Report Are you sure the usage of `$type->convertToDatabase...is->platform->reveal())` targeting `JDecool\Doctrine\Type\Ph...onvertToDatabaseValue()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
142			}
143
144			/**
145			* @test
146			*/
147			public function convertToPHPValueWithValidValueReturnsParsedData(): void
148			{
149			$type = $this->getType(Action::class);
150
151			/** @var Action $value */
152			$value = $type->convertToPHPValue(Action::CREATE, $this->platform->reveal());
153			$this->assertInstanceOf(Action::class, $value);
154			$this->assertEquals(Action::CREATE, $value->getValue());
155
156			$value = $type->convertToPHPValue(Action::DELETE, $this->platform->reveal());
157			$this->assertInstanceOf(Action::class, $value);
158			$this->assertEquals(Action::DELETE, $value->getValue());
159			}
160
161			/**
162			* @test
163			*/
164			public function convertToPHPValueWithNullReturnsNull(): void
165			{
166			$type = $this->getType(Action::class);
167
168			$value = $type->convertToPHPValue(null, $this->platform->reveal());
			0 ignored issues – show Bug introduced 2019-10-07 18:52 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$value` is correct as `$type->convertToPHPValue...is->platform->reveal())` targeting `JDecool\Doctrine\Type\Ph...pe::convertToPHPValue()` seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
169			$this->assertNull($value);
170			}
171
172			/**
173			* @test
174			*/
175			public function convertToPHPValueWithInvalidValueThrowsException(): void
176			{
177			$type = $this->getType(Action::class);
178
179			$this->expectException(InvalidArgumentException::class);
180			$this->expectExceptionMessage(sprintf(
181			'The value "invalid" is not valid for the enum "%s". Expected one of ["%s"]',
182			Action::class,
183			implode('", "', Action::getConstants())
184			));
185			$type->convertToPHPValue('invalid', $this->platform->reveal());
186			}
187
188			/**
189			* @test
190			*/
191			public function convertToPHPValueWithCastingMethodProperlyCastsIt(): void
192			{
193			$type = $this->getType(WithCastingMethods::class);
194
195			$value = $type->convertToPHPValue('foo VALUE', $this->platform->reveal());
196			$this->assertInstanceOf(WithCastingMethods::class, $value);
197			$this->assertEquals(WithCastingMethods::FOO, $value->getValue());
198
199			$intType = $this->getType(WithIntegerValues::class);
200
201			$value = $intType->convertToPHPValue('1', $this->platform->reveal());
202			$this->assertInstanceOf(WithIntegerValues::class, $value);
203			$this->assertEquals(1, $value->getValue());
204			}
205
206			/**
207			* @test
208			*/
209			public function convertToDatabaseValueWithCastingMethodProperlyCastsIt(): void
210			{
211			$type = $this->getType(WithCastingMethods::class);
212
213			$value = $type->convertToDatabaseValue(WithCastingMethods::FOO(), $this->platform->reveal());
214			$this->assertEquals('FOO VALUE', $value);
215			}
216
217			/**
218			* @test
219			*/
220			public function usingChildCustomEnumTypeRegisteredValueIsCorrect(): void
221			{
222			MyCustomEnumType::registerEnumType(Action::class);
223			$type = MyCustomEnumType::getType(Action::class);
224
225			$this->assertInstanceOf(MyCustomEnumType::class, $type);
226			$this->assertEquals(
227			'ENUM("create", "read", "update", "delete") COMMENT "JDecool\Test\Doctrine\Enum\Action"',
228			$type->getSQLDeclaration([], $this->platform->reveal())
229			);
230			}
231
232			/**
233			* @test
234			*/
235			public function SQLCommentHintIsAlwaysRequired(): void
236			{
237			$type = $this->getType(Gender::class);
238
239			$this->assertTrue($type->requiresSQLCommentHint($this->platform->reveal()));
240			}
241
242			private function getType(string $typeName): PhpEnumType
243			{
244			PhpEnumType::registerEnumType($typeName);
245			return Type::getType($typeName);
			0 ignored issues – show Bug Best Practice introduced 2019-10-07 18:52 UTC by Report Bug Copy Issue Report The expression `return Doctrine\DBAL\Typ...ype::getType($typeName)` returns the type `Doctrine\DBAL\Types\Type` which includes types incompatible with the type-hinted return `JDecool\Doctrine\Type\PhpEnumType`. Loading history...
246			}
247			}
248

jdecool / doctrine-mabe-enum-type

PhpEnumTypeTest A last analyzed 2019-10-07 18:52 UTC

Complexity

Size/Duplication

Importance

16 Methods

Duplication Side-by-Side

Filter issues like

PhpEnumTypeTest A
last analyzed 2019-10-07 18:52 UTC