16524130380

Committed 25 Jul 2025 02:14PM UTC coverage: 22.07% (+0.03%) from 22.039%

Build # 16524130380

Build Type

push

github

Committed by

web-flow

Commit Message

feat(metadata): introduce metadata mutators for resource & operations (#7213)

Co-authored-by: Antoine Bluchet <soyuka@users.noreply.github.com>

Run Details

40 of 106 new or added lines in 9 files covered. (37.74%)

112 existing lines in 2 files now uncovered.

11573 of 52437 relevant lines covered (22.07%)

23.46 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/Metadata/Tests/Resource/Factory/MutatorResourceMetadataCollectionFactoryTest.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Metadata\Tests\Resource\Factory;

use ApiPlatform\Metadata\ApiResource;
use ApiPlatform\Metadata\HttpOperation;
use ApiPlatform\Metadata\Mutator\OperationResourceMutatorCollection;
use ApiPlatform\Metadata\Mutator\ResourceResourceMutatorCollection;
use ApiPlatform\Metadata\Operation;
use ApiPlatform\Metadata\OperationMutatorInterface;
use ApiPlatform\Metadata\Operations;
use ApiPlatform\Metadata\Resource\Factory\MutatorResourceMetadataCollectionFactory;
use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
use ApiPlatform\Metadata\ResourceMutatorInterface;
use PHPUnit\Framework\TestCase;

final class MutatorResourceMetadataCollectionFactoryTest extends TestCase
{
    public function testMutateResource(): void
    {
        $decorated = $this->createMock(ResourceMetadataCollectionFactoryInterface::class);
        $resourceClass = \stdClass::class;
        $resourceMetadataCollection = new ResourceMetadataCollection($resourceClass);
        $resourceMetadataCollection[] = (new ApiResource())->withClass($resourceClass);

        $resourceMutatorCollection = new ResourceResourceMutatorCollection();
        $resourceMutatorCollection->addMutator($resourceClass, new DummyResourceMutator());

        $customResourceMetadataCollectionFactory = new MutatorResourceMetadataCollectionFactory($resourceMutatorCollection, new OperationResourceMutatorCollection(), $decorated);

        $decorated->expects($this->once())->method('create')->with($resourceClass)->willReturn(
            $resourceMetadataCollection,
        );

        $resourceMetadataCollection = $customResourceMetadataCollectionFactory->create($resourceClass);

        $resource = $resourceMetadataCollection->getIterator()->current();
        $this->assertInstanceOf(ApiResource::class, $resource);
        $this->assertSame('dummy', $resource->getShortName());
    }

    public function testMutateOperation(): void
    {
        $decorated = $this->createMock(ResourceMetadataCollectionFactoryInterface::class);
        $resourceClass = \stdClass::class;

        $operations = new Operations();
        $operations->add('_api_Dummy_get', new HttpOperation());

        $resourceMetadataCollection = new ResourceMetadataCollection($resourceClass);
        $resourceMetadataCollection[] = (new ApiResource())->withClass($resourceClass)->withOperations($operations);

        $operationMutatorCollection = new OperationResourceMutatorCollection();
        $operationMutatorCollection->add('_api_Dummy_get', new DummyOperationMutator());

        $customResourceMetadataCollectionFactory = new MutatorResourceMetadataCollectionFactory(new ResourceResourceMutatorCollection(), $operationMutatorCollection, $decorated);

        $decorated->expects($this->once())->method('create')->with($resourceClass)->willReturn(
            $resourceMetadataCollection,
        );

        $resourceMetadataCollection = $customResourceMetadataCollectionFactory->create($resourceClass);

        $resource = $resourceMetadataCollection->getIterator()->current();
        $this->assertInstanceOf(ApiResource::class, $resource);
        $this->assertEquals('custom_dummy', $resourceMetadataCollection->getOperation('_api_Dummy_get')->getShortName());
    }
}

final class DummyResourceMutator implements ResourceMutatorInterface
{
    public function __invoke(ApiResource $resource): ApiResource
    {
        return $resource->withShortName('dummy');
    }
}

final class DummyOperationMutator implements OperationMutatorInterface
{
    public function __invoke(Operation $operation): Operation
    {
        return $operation->withShortName('custom_dummy');
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\Metadata\Tests\Resource\Factory;
15
16	use ApiPlatform\Metadata\ApiResource;
17	use ApiPlatform\Metadata\HttpOperation;
18	use ApiPlatform\Metadata\Mutator\OperationResourceMutatorCollection;
19	use ApiPlatform\Metadata\Mutator\ResourceResourceMutatorCollection;
20	use ApiPlatform\Metadata\Operation;
21	use ApiPlatform\Metadata\OperationMutatorInterface;
22	use ApiPlatform\Metadata\Operations;
23	use ApiPlatform\Metadata\Resource\Factory\MutatorResourceMetadataCollectionFactory;
24	use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
25	use ApiPlatform\Metadata\Resource\ResourceMetadataCollection;
26	use ApiPlatform\Metadata\ResourceMutatorInterface;
27	use PHPUnit\Framework\TestCase;
28
29	final class MutatorResourceMetadataCollectionFactoryTest extends TestCase
30	{
31	public function testMutateResource(): void
32	{
NEW 33	$decorated = $this->createMock(ResourceMetadataCollectionFactoryInterface::class);	×
NEW 34	$resourceClass = \stdClass::class;	×
NEW 35	$resourceMetadataCollection = new ResourceMetadataCollection($resourceClass);	×
NEW 36	$resourceMetadataCollection[] = (new ApiResource())->withClass($resourceClass);	×
37
NEW 38	$resourceMutatorCollection = new ResourceResourceMutatorCollection();	×
NEW 39	$resourceMutatorCollection->addMutator($resourceClass, new DummyResourceMutator());	×
40
NEW 41	$customResourceMetadataCollectionFactory = new MutatorResourceMetadataCollectionFactory($resourceMutatorCollection, new OperationResourceMutatorCollection(), $decorated);	×
42
NEW 43	$decorated->expects($this->once())->method('create')->with($resourceClass)->willReturn(	×
NEW 44	$resourceMetadataCollection,	×
NEW 45	);	×
46
NEW 47	$resourceMetadataCollection = $customResourceMetadataCollectionFactory->create($resourceClass);	×
48
NEW 49	$resource = $resourceMetadataCollection->getIterator()->current();	×
NEW 50	$this->assertInstanceOf(ApiResource::class, $resource);	×
NEW 51	$this->assertSame('dummy', $resource->getShortName());	×
52	}
53
54	public function testMutateOperation(): void
55	{
NEW 56	$decorated = $this->createMock(ResourceMetadataCollectionFactoryInterface::class);	×
NEW 57	$resourceClass = \stdClass::class;	×
58
NEW 59	$operations = new Operations();	×
NEW 60	$operations->add('_api_Dummy_get', new HttpOperation());	×
61
NEW 62	$resourceMetadataCollection = new ResourceMetadataCollection($resourceClass);	×
NEW 63	$resourceMetadataCollection[] = (new ApiResource())->withClass($resourceClass)->withOperations($operations);	×
64
NEW 65	$operationMutatorCollection = new OperationResourceMutatorCollection();	×
NEW 66	$operationMutatorCollection->add('_api_Dummy_get', new DummyOperationMutator());	×
67
NEW 68	$customResourceMetadataCollectionFactory = new MutatorResourceMetadataCollectionFactory(new ResourceResourceMutatorCollection(), $operationMutatorCollection, $decorated);	×
69
NEW 70	$decorated->expects($this->once())->method('create')->with($resourceClass)->willReturn(	×
NEW 71	$resourceMetadataCollection,	×
NEW 72	);	×
73
NEW 74	$resourceMetadataCollection = $customResourceMetadataCollectionFactory->create($resourceClass);	×
75
NEW 76	$resource = $resourceMetadataCollection->getIterator()->current();	×
NEW 77	$this->assertInstanceOf(ApiResource::class, $resource);	×
NEW 78	$this->assertEquals('custom_dummy', $resourceMetadataCollection->getOperation('_api_Dummy_get')->getShortName());	×
79	}
80	}
81
82	final class DummyResourceMutator implements ResourceMutatorInterface
83	{
84	public function __invoke(ApiResource $resource): ApiResource
85	{
NEW 86	return $resource->withShortName('dummy');	×
87	}
88	}
89
90	final class DummyOperationMutator implements OperationMutatorInterface
91	{
92	public function __invoke(Operation $operation): Operation
93	{
NEW 94	return $operation->withShortName('custom_dummy');	×
95	}
96	}

api-platform / core / 16524130380

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous