erasys\OpenApi\Tests\AbstractObjectUnitTest

Complexity

Total Complexity

5

Size/Duplication

Total Lines	283
Duplicated Lines	0 %

Importance

Changes

0

45 Methods

Rating	Name	Duplication	Size	Complexity
	testToArrayWithUnsupportedTypeShouldFail()	0	8	?
	getClassStub()	0	9	?
A	hp$9 ➔ testToObject()	0	9	1
	testToArrayWithConflictingExtensionNamesShouldFail()	0	12	?
A	hp$0 ➔ __construct()	0	3	1
A	hp$4 ➔ testToArrayNestedAbstractObjectShouldBeExported()	0	14	1
A	hp$0 ➔ testGetUndefinedPropertyViaGetterShouldFail()	0	7	1
	testToArrayNullPropertiesShouldNotBeExported()	0	13	?
A	hp$9 ➔ testToJson()	0	9	1
	testGetOffsetIsset()	0	7	?
	testSetUndefinedPropertyViaConstructorShouldFail()	0	6	?
A	hp$6 ➔ testToArrayXmlPropertyShouldNotBeTreatedAsExtension()	0	13	1
A	hp$9 ➔ testToYaml()	0	9	1
A	hp$7 ➔ testToArrayExtensionNameShouldBeExportedWithDashedFormatAndRespectedCase()	0	23	1
	testToString()	0	10	?
	testToArrayRawValueShouldBeExportedAsItIs()	0	16	?
A	hp$1 ➔ testToArrayShouldNotReturnNonPublicProperties()	0	13	1
A	hp$5 ➔ testToArrayExtensionPropertyObjectShouldBeMappedAndExported()	0	16	1
	testGetUndefinedPropertyViaGetterShouldFail()	0	7	?
	testToYaml()	0	9	?
	testSetUndefinedPropertyViaSetterShouldFail()	0	7	?
	testSetUndefinedPropertyViaArrayOffsetShouldFail()	0	7	?
	testToArrayNestedAbstractObjectShouldBeExported()	0	14	?
A	hp$0 ➔ testGetUndefinedPropertyViaArrayOffsetShouldFail()	0	7	1
A	hp$2 ➔ testToArrayNullPropertiesShouldNotBeExported()	0	13	1
A	hp$9 ➔ testToString()	0	10	1
	testToArrayRefPropertyNameShouldBeExportedWithDollarSign()	0	16	?
A	hp$0 ➔ testSetUndefinedPropertyViaConstructorShouldFail()	0	6	1
	testToArrayXmlPropertyShouldNotBeTreatedAsExtension()	0	13	?
A	hp$9 ➔ testToArrayRefPropertyNameShouldBeExportedWithDollarSign()	0	16	1
	testToArrayExtensionNameShouldBeExportedWithDashedFormatAndRespectedCase()	0	23	?
A	hp$8 ➔ testToArrayWithConflictingExtensionNamesShouldFail()	0	12	1
	testGetOffsetUnset()	0	6	?
	testGetUndefinedPropertyViaArrayOffsetShouldFail()	0	7	?
A	hp$0 ➔ testGetOffsetIsset()	0	7	1
A	hp$0 ➔ testSetUndefinedPropertyViaSetterShouldFail()	0	7	1
A	hp$3 ➔ testToArrayRawValueShouldBeExportedAsItIs()	0	16	1
A	hp$0 ➔ testSetUndefinedPropertyViaArrayOffsetShouldFail()	0	7	1
	testToJson()	0	9	?
	testToArrayShouldNotReturnNonPublicProperties()	0	13	?
A	hp$0 ➔ testGetOffsetUnset()	0	6	1
A	hp$0 ➔ testToArrayWithUnsupportedTypeShouldFail()	0	8	1
	testToObject()	0	9	?
A	hp$0 ➔ getClassStub()	0	9	1
	testToArrayExtensionPropertyObjectShouldBeMappedAndExported()	0	16	?

<?php

namespace erasys\OpenApi\Tests;

use erasys\OpenApi\Exceptions\ArrayKeyConflictException;
use erasys\OpenApi\Exceptions\UndefinedPropertyException;
use erasys\OpenApi\Exceptions\UnsupportedTypeException;
use erasys\OpenApi\ExtensionProperty;
use erasys\OpenApi\RawValue;
use erasys\OpenApi\Spec\v3\AbstractObject;
use erasys\OpenApi\Spec\v3\Reference;
use erasys\OpenApi\Spec\v3\Tag;
use PHPUnit\Framework\TestCase;
use stdClass;

class AbstractObjectUnitTest extends TestCase
{
    private function getClassStub(array $properties = []): AbstractObject
    {
        return new class($properties) extends AbstractObject
        {
            public $foo;

            public function __construct(array $properties = [])
            {
                parent::__construct($properties);
            }
        };
    }

    public function testGetUndefinedPropertyViaGetterShouldFail()
    {
        $this->expectException(UndefinedPropertyException::class);
        $this->expectExceptionCode(1);

        $obj = $this->getClassStub();
        $obj->undefinedProperty;

The property undefinedProperty does not exist on anonymous//tests/AbstractObjectUnitTest.php$0. Since you implemented __get, consider adding a @property annotation.

    }

    public function testSetUndefinedPropertyViaSetterShouldFail()
    {
        $this->expectException(UndefinedPropertyException::class);
        $this->expectExceptionCode(2);

        $obj                    = $this->getClassStub();
        $obj->undefinedProperty = null;

The property undefinedProperty does not exist on anonymous//tests/AbstractObjectUnitTest.php$0. Since you implemented __set, consider adding a @property annotation.

    }

    public function testGetUndefinedPropertyViaArrayOffsetShouldFail()
    {
        $this->expectException(UndefinedPropertyException::class);
        $this->expectExceptionCode(1);

        $obj = $this->getClassStub();
        $obj['undefinedProperty'];
    }

    public function testGetOffsetIsset()
    {
        $obj = $this->getClassStub();
        $this->assertFalse(isset($obj['foo']));
        $this->assertFalse(isset($obj['undefinedProperty']));
        $obj->foo = 'bar';
        $this->assertTrue(isset($obj['foo']));
    }

    public function testGetOffsetUnset()
    {
        $obj = $this->getClassStub(['foo' => 'bar']);
        $this->assertTrue(isset($obj['foo']));
        unset($obj['foo']);
        $this->assertFalse(isset($obj['foo']));
    }

    public function testSetUndefinedPropertyViaArrayOffsetShouldFail()
    {
        $this->expectException(UndefinedPropertyException::class);
        $this->expectExceptionCode(2);

        $obj                      = $this->getClassStub();
        $obj['undefinedProperty'] = null;
    }

    public function testSetUndefinedPropertyViaConstructorShouldFail()
    {
        $this->expectException(UndefinedPropertyException::class);
        $this->expectExceptionCode(2);

        $this->getClassStub(['undefinedProperty' => null]);
    }

    public function testToArrayWithUnsupportedTypeShouldFail()
    {
        $this->expectException(UnsupportedTypeException::class);
        $this->expectExceptionCode(0);

        $obj      = $this->getClassStub();
        $obj->foo = new stdClass();
        $obj->toArray();
    }

    public function testToArrayShouldNotReturnNonPublicProperties()
    {
        $obj = new class() extends AbstractObject
        {
            public $foo = 'a';
            protected $bar = 'b';
            private $baz = 'c';
        };

        $expected = ['foo' => 'a'];
        $actual   = $obj->toArray();

        $this->assertEquals($expected, $actual);
    }

    public function testToArrayNullPropertiesShouldNotBeExported()
    {
        $obj = new class() extends AbstractObject
        {
            public $foo = 'a';
            public $bar = null;
            public $baz;
        };

        $expected = ['foo' => 'a'];
        $actual   = $obj->toArray();

        $this->assertEquals($expected, $actual);
    }

    public function testToArrayRawValueShouldBeExportedAsItIs()
    {
        $obj = new class() extends AbstractObject
        {
            public $foo = 'a';
            public $bar = null;
            public $baz;
        };

        $obj->bar = new RawValue('b');
        $obj->baz = new RawValue(null);

        $expected = ['foo' => 'a', 'bar' => 'b', 'baz' => null];
        $actual   = $obj->toArray();

        $this->assertEquals($expected, $actual);
    }

    public function testToArrayNestedAbstractObjectShouldBeExported()
    {
        $obj = new class() extends AbstractObject
        {
            public $foo = 'a';
            public $bar;
        };

        $obj->bar = new Tag('foobar');

        $expected = ['foo' => 'a', 'bar' => ['name' => 'foobar']];
        $actual   = $obj->toArray();

        $this->assertEquals($expected, $actual);
    }

    public function testToArrayExtensionPropertyObjectShouldBeMappedAndExported()
    {
        $obj = new class() extends AbstractObject
        {
            public $foo = 'a';
            public $xBarBaz;
            public $xBarBazFoo;
        };

        $obj->xBarBaz    = new ExtensionProperty('Hello-World', 123);
        $obj->xBarBazFoo = new ExtensionProperty('Hello-World-Foo', null);

        $expected = ['foo' => 'a', 'x-Hello-World' => 123];
        $actual   = $obj->toArray();

        $this->assertEquals($expected, $actual);
    }

    public function testToArrayXmlPropertyShouldNotBeTreatedAsExtension()
    {
        $obj = new class() extends AbstractObject
        {
            public $foo = 'a';
            public $xml = 'b';
            public $xML = 'c';
        };

        $expected = ['foo' => 'a', 'xml' => 'b', 'x-ML' => 'c'];
        $actual   = $obj->toArray();

        $this->assertEquals($expected, $actual);
    }

    public function testToArrayExtensionNameShouldBeExportedWithDashedFormatAndRespectedCase()
    {
        $obj = new class() extends AbstractObject
        {
            public $foo = 'a';
            public $x_bar_baz = 'b';
            public $x_BarBazFoo = 'c';
            public $xBarBaz_foo_Bar = 'd';
            public $xBar_baz = 'e';
            public $xbar_baz_foo = 'f';
        };

        $expected = [
            'foo' => 'a',
            'x-bar-baz' => 'b',
            'x-BarBazFoo' => 'c',
            'x-BarBaz-foo-Bar' => 'd',
            'x-Bar-baz' => 'e',
            'x-bar-baz-foo' => 'f',
        ];
        $actual   = $obj->toArray();

        $this->assertEquals($expected, $actual);
    }

    public function testToArrayWithConflictingExtensionNamesShouldFail()
    {
        $this->expectException(ArrayKeyConflictException::class);
        $this->expectExceptionCode(0);

        $obj = new class() extends AbstractObject
        {
            public $foo = 'a';
            public $x_Bar_baz = 'b';
            public $xBar_baz = 'e';
        };
        $obj->toArray();
    }

    public function testToArrayRefPropertyNameShouldBeExportedWithDollarSign()
    {
        $obj = new class() extends AbstractObject
        {
            public $foo = 'a';
            public $ref;
            public $data;
        };

        $obj->ref  = 'b';
        $obj->data = new Reference('c');

        $expected = ['foo' => 'a', '$ref' => 'b', 'data' => ['$ref' => 'c']];
        $actual   = $obj->toArray();

        $this->assertEquals($expected, $actual);
    }

    public function testToJson()
    {
        $obj = $this->getClassStub();
        $this->assertEquals('{}', $obj->toJson());

        $obj      = $this->getClassStub();
        $obj->foo = 'bar';

        $this->assertEquals('{"foo":"bar"}', $obj->toJson());
    }

    public function testToYaml()
    {
        $obj = $this->getClassStub();
        $this->assertEquals('{  }', $obj->toYaml());

        $obj      = $this->getClassStub();
        $obj->foo = 'bar';

        $this->assertEquals("foo: bar\n", $obj->toYaml());
    }

    public function testToObject()
    {
        $obj = $this->getClassStub();
        $this->assertEquals('{}', $obj->__toString());

        $obj      = $this->getClassStub();
        $obj->foo = 'bar';

        $this->assertEquals('{"foo":"bar"}', $obj->__toString());
    }

    public function testToString()
    {
        $obj = $this->getClassStub();
        $this->assertEquals(new stdClass(), $obj->toObject());

        $obj           = $this->getClassStub();
        $obj->foo      = 'bar';
        $expected      = new stdClass();
        $expected->foo = 'bar';
        $this->assertEquals($expected, $obj->toObject());
    }
}