Elao / ApiResourcesMetadata / 21

pending completion

Build # 21

Build Type

Pull #5

travis-ci

Committed by

web-flow

Commit Message

<a href="https://github.com/Elao/ApiResourcesMetadata/commit/8aa906aba">Add conflicts

ref https://github.com/symfony/symfony/commit/</a><a class="double-link" href="https://github.com/Elao/ApiResourcesMetadata/commit/676012748">676012748</a>

Pull Request Pull Request #5: Allow phpdocumentor/reflection-docblock ^4.0

Run Details

317 of 401 relevant lines covered (79.05%)

5.03 hits per line

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

73.68

/src/Resource/Factory/ResourceMetadataFactory.php

<?php

/*
 * This file is part of the "elao/api-resources-metadata" package.
 *
 * Copyright (C) 2016 Elao
 *
 * @author Elao <contact@elao.com>
 */

namespace Elao\ApiResourcesMetadata\Resource\Factory;

use Elao\ApiResourcesMetadata\Exception\InvalidArgumentException;
use Elao\ApiResourcesMetadata\Resource\Loader\LoaderInterface;
use Elao\ApiResourcesMetadata\Resource\ResourceIndex;
use Elao\ApiResourcesMetadata\Resource\ResourceMetadata;
use Psr\Cache\CacheItemPoolInterface;

final class ResourceMetadataFactory
{
    /**
     * @internal
     */
    const CACHE_PREFIX = 'elao.api_resources_metadata.metadata.';

    /** @var LoaderInterface[] */
    private $loaders;

    /**
     * Loaded metadata indexed by classname
     *
     * @var ResourceMetadata[]
     */
    private $loadedClasses;

    /** @var ResourceIndex */
    private $resourceIndex;

    /** @var CacheItemPoolInterface|null */
    private $cache;

    /**
     * @param ResourceIndex               $resourceIndex
     * @param LoaderInterface[]           $loaders
     * @param CacheItemPoolInterface|null $cache
     */
    public function __construct(ResourceIndex $resourceIndex, array $loaders, CacheItemPoolInterface $cache = null)
    {
        $this->loaders = $loaders;
        $this->resourceIndex = $resourceIndex;
        $this->loadedClasses = [];
        $this->cache = $cache;
    }

    /**
     * @param $value Resource class, instance, or short name
     *
     * @throws InvalidArgumentException When none of the loaders were able to guess information from
     *
     * @return ResourceMetadata
     */
    public function getMetadataFor($value): ResourceMetadata
    {
        $class = $this->getClass($value);
        $cacheKey = self::CACHE_PREFIX . str_replace('\\', '_', $class);

        if (null !== $this->cache && $this->cache->getItem($cacheKey)->isHit()) {
            return $this->cache->getItem($cacheKey)->get();
        }

        if (isset($this->loadedClasses[$class])) {
            return $this->loadedClasses[$class];
        }

        $metadata = new ResourceMetadata($class);

        $loaded = false;
        foreach ($this->loaders as $loader) {
            if ($loader->loadResourceMetadata($metadata)) {
                $loaded = true;
            }
        }

        if (!$loaded) {
            throw new InvalidArgumentException(sprintf(
                'Unable to load metadata for "%s". No supporting loader found.',
                $class
            ));
        }

        if (null !== $this->cache) {
            $item = $this->cache->getItem($cacheKey);
            $item->set($metadata);
            $this->cache->save($item);
        }

        return $this->loadedClasses[$class] = $metadata;
    }

    /**
     * Gets a class name for a given class, instance or resource short name.
     *
     * @param string|object $value
     *
     * @throws InvalidArgumentException If it isn't a resource
     *
     * @return string The resource class
     */
    private function getClass($value): string
    {
        if (!is_string($value) && !is_object($value)) {
            throw new InvalidArgumentException(sprintf(
                'Cannot create metadata for non-objects. Got: "%s"',
                gettype($value)
            ));
        }

        if (is_string($value)) {
            $value = ltrim($value, '\\');
            if (!class_exists($value) && !interface_exists($value)) {
                // Check for the resource short name
                return $this->resourceIndex->getResourceClass($value);
            }
        }

        if (is_object($value)) {
            $value = get_class($value);
        }

        if (!$this->resourceIndex->has($value)) {
            throw new InvalidArgumentException(sprintf('Class "%s" is not indexed as a resource.', $value));
        }

        return $value;
    }
}

1	<?php
2
3	/*
4	* This file is part of the "elao/api-resources-metadata" package.
5	*
6	* Copyright (C) 2016 Elao
7	*
8	* @author Elao <contact@elao.com>
9	*/
10
11	namespace Elao\ApiResourcesMetadata\Resource\Factory;
12
13	use Elao\ApiResourcesMetadata\Exception\InvalidArgumentException;
14	use Elao\ApiResourcesMetadata\Resource\Loader\LoaderInterface;
15	use Elao\ApiResourcesMetadata\Resource\ResourceIndex;
16	use Elao\ApiResourcesMetadata\Resource\ResourceMetadata;
17	use Psr\Cache\CacheItemPoolInterface;
18
19	final class ResourceMetadataFactory
20	{
21	/**
22	* @internal
23	*/
24	const CACHE_PREFIX = 'elao.api_resources_metadata.metadata.';
25
26	/** @var LoaderInterface[] */
27	private $loaders;
28
29	/**
30	* Loaded metadata indexed by classname
31	*
32	* @var ResourceMetadata[]
33	*/
34	private $loadedClasses;
35
36	/** @var ResourceIndex */
37	private $resourceIndex;
38
39	/** @var CacheItemPoolInterface\|null */
40	private $cache;
41
42	/**
43	* @param ResourceIndex $resourceIndex
44	* @param LoaderInterface[] $loaders
45	* @param CacheItemPoolInterface\|null $cache
46	*/
47	public function __construct(ResourceIndex $resourceIndex, array $loaders, CacheItemPoolInterface $cache = null)
48	{
49	$this->loaders = $loaders;	12✔
50	$this->resourceIndex = $resourceIndex;	12✔
51	$this->loadedClasses = [];	12✔
52	$this->cache = $cache;	12✔
53	}	12✔
54
55	/**
56	* @param $value Resource class, instance, or short name
57	*
58	* @throws InvalidArgumentException When none of the loaders were able to guess information from
59	*
60	* @return ResourceMetadata
61	*/
62	public function getMetadataFor($value): ResourceMetadata
63	{
64	$class = $this->getClass($value);	12✔
65	$cacheKey = self::CACHE_PREFIX . str_replace('\\', '_', $class);	9✔
66
67	if (null !== $this->cache && $this->cache->getItem($cacheKey)->isHit()) {	9✔
68	return $this->cache->getItem($cacheKey)->get();	×
69	}
70
71	if (isset($this->loadedClasses[$class])) {	9✔
72	return $this->loadedClasses[$class];	2✔
73	}
74
75	$metadata = new ResourceMetadata($class);	9✔
76
77	$loaded = false;	9✔
78	foreach ($this->loaders as $loader) {	9✔
79	if ($loader->loadResourceMetadata($metadata)) {	9✔
80	$loaded = true;	9✔
81	}
82	}
83
84	if (!$loaded) {	9✔
85	throw new InvalidArgumentException(sprintf(	×
86	'Unable to load metadata for "%s". No supporting loader found.',	×
87	$class	×
88	));
89	}
90
91	if (null !== $this->cache) {	9✔
92	$item = $this->cache->getItem($cacheKey);	×
93	$item->set($metadata);	×
94	$this->cache->save($item);	×
95	}
96
97	return $this->loadedClasses[$class] = $metadata;	9✔
98	}
99
100	/**
101	* Gets a class name for a given class, instance or resource short name.
102	*
103	* @param string\|object $value
104	*
105	* @throws InvalidArgumentException If it isn't a resource
106	*
107	* @return string The resource class
108	*/
109	private function getClass($value): string
110	{
111	if (!is_string($value) && !is_object($value)) {	12✔
112	throw new InvalidArgumentException(sprintf(	×
113	'Cannot create metadata for non-objects. Got: "%s"',	×
114	gettype($value)	×
115	));
116	}
117
118	if (is_string($value)) {	12✔
119	$value = ltrim($value, '\\');	10✔
120	if (!class_exists($value) && !interface_exists($value)) {	10✔
121	// Check for the resource short name
122	return $this->resourceIndex->getResourceClass($value);	3✔
123	}
124	}
125
126	if (is_object($value)) {	9✔
127	$value = get_class($value);	2✔
128	}
129
130	if (!$this->resourceIndex->has($value)) {	9✔
131	throw new InvalidArgumentException(sprintf('Class "%s" is not indexed as a resource.', $value));	1✔
132	}
133
134	return $value;	8✔
135	}
136	}

Elao / ApiResourcesMetadata / 21

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