#27280

pending completion

Build # #27280

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/f0947756ac27d48c3736eaeb19ae5a179c8f0bdb">f0947756a<a href="https://github.com/api-platform/core/commit/f0947756ac27d48c3736eaeb19ae5a179c8f0bdb">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/7c74abbd9f4827ee0802776f55955edaca8bd521">7c74abbd9</a>">7c74abbd9</a><a href="https://github.com/api-platform/core/commit/f0947756ac27d48c3736eaeb19ae5a179c8f0bdb"> into cd198d20b">cd198d20b</a>

Run Details

422 of 422 new or added lines in 36 files covered. (100.0%)

10250 of 12298 relevant lines covered (83.35%)

14.74 hits per line

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

78.57

/src/Metadata/ResourceCollection/Factory/PhpDocResourceCollectionMetadataFactory.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\Core\Metadata\ResourceCollection\Factory;

use ApiPlatform\Core\Metadata\ResourceCollection\ResourceCollection;
use phpDocumentor\Reflection\DocBlockFactory;
use phpDocumentor\Reflection\DocBlockFactoryInterface;
use phpDocumentor\Reflection\Types\ContextFactory;

/**
 * Extracts descriptions from PHPDoc.
 *
 * @author Kévin Dunglas <dunglas@gmail.com>
 * @experimental
 */
final class PhpDocResourceCollectionMetadataFactory implements ResourceCollectionMetadataFactoryInterface
{
    private $decorated;
    private $docBlockFactory;
    private $contextFactory;

    public function __construct(ResourceCollectionMetadataFactoryInterface $decorated, DocBlockFactoryInterface $docBlockFactory = null)
    {
        $this->decorated = $decorated;
        $this->docBlockFactory = $docBlockFactory ?: DocBlockFactory::createInstance();
        $this->contextFactory = new ContextFactory();
    }

    /**
     * {@inheritdoc}
     */
    public function create(string $resourceClass): ResourceCollection
    {
        $resourceMetadataCollection = $this->decorated->create($resourceClass);

        foreach ($resourceMetadataCollection as $key => $resourceMetadata) {
            if (null !== $resourceMetadata->description) {
                continue;
            }

            $reflectionClass = new \ReflectionClass($resourceClass);

            try {
                $docBlock = $this->docBlockFactory->create($reflectionClass, $this->contextFactory->createFromReflector($reflectionClass));
                $resourceMetadata->description = $docBlock->getSummary();
                $resourceMetadataCollection[$key] = $resourceMetadata;
            } catch (\InvalidArgumentException $e) {
                // Ignore empty DocBlocks
            }
        }

        return new ResourceCollection($resourceMetadataCollection);
    }
}

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\Core\Metadata\ResourceCollection\Factory;
15
16	use ApiPlatform\Core\Metadata\ResourceCollection\ResourceCollection;
17	use phpDocumentor\Reflection\DocBlockFactory;
18	use phpDocumentor\Reflection\DocBlockFactoryInterface;
19	use phpDocumentor\Reflection\Types\ContextFactory;
20
21	/**
22	* Extracts descriptions from PHPDoc.
23	*
24	* @author Kévin Dunglas <dunglas@gmail.com>
25	* @experimental
26	*/
27	final class PhpDocResourceCollectionMetadataFactory implements ResourceCollectionMetadataFactoryInterface
28	{
29	private $decorated;
30	private $docBlockFactory;
31	private $contextFactory;
32
33	public function __construct(ResourceCollectionMetadataFactoryInterface $decorated, DocBlockFactoryInterface $docBlockFactory = null)
34	{
35	$this->decorated = $decorated;	36✔
36	$this->docBlockFactory = $docBlockFactory ?: DocBlockFactory::createInstance();	36✔
37	$this->contextFactory = new ContextFactory();	36✔
38	}	36✔
39
40	/**
41	* {@inheritdoc}
42	*/
43	public function create(string $resourceClass): ResourceCollection
44	{
45	$resourceMetadataCollection = $this->decorated->create($resourceClass);	2✔
46
47	foreach ($resourceMetadataCollection as $key => $resourceMetadata) {	1✔
48	if (null !== $resourceMetadata->description) {	1✔
49	continue;	×
50	}
51
52	$reflectionClass = new \ReflectionClass($resourceClass);	1✔
53
54	try {
55	$docBlock = $this->docBlockFactory->create($reflectionClass, $this->contextFactory->createFromReflector($reflectionClass));	1✔
56	$resourceMetadata->description = $docBlock->getSummary();	×
57	$resourceMetadataCollection[$key] = $resourceMetadata;	×
58	} catch (\InvalidArgumentException $e) {	1✔
59	// Ignore empty DocBlocks
60	}
61	}
62
63	return new ResourceCollection($resourceMetadataCollection);	1✔
64	}
65	}

api-platform / core / #27280

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