Graviton\ProxyExtensionBundle\Definition\Loader\ConfigurationLoaderAbstract

Complexity

Total Complexity

11

Size/Duplication

Total Lines	136
Duplicated Lines	6.62 %

Coupling/Cohesion

Components	2
Dependencies	3

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	setOptions()	9	9	2
A	setDispersalStrategy()	0	4	1
A	setCache()	0	3	1
A	supports()	0	6	1
A	load()	0	11	1
A	defineSchema()	0	20	4
	findSchemaFile()	0	1	?

<?php
/**
 * ConfigurationLoaderAbstract
 */

namespace Graviton\ProxyExtensionBundle\Definition\Loader;

use Doctrine\Common\Cache\CacheProvider;
use Graviton\ProxyBundle\Definition\ApiDefinition;
use Graviton\ProxyBundle\Definition\Loader\DispersalStrategy\DispersalStrategyInterface;
use Graviton\ProxyBundle\Definition\Loader\LoaderInterface;
use Psr\Log\LoggerInterface;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Validator\Constraints\Url;
use Symfony\Component\Validator\Validator\ValidatorInterface;

/**
 * Class ConfigurationLoaderAbstract
 *
 * @package Graviton\ProxyExtensionBundle\Definition\Loader
 *
 * @author   List of contributors <https://github.com/libgraviton/graviton/graphs/contributors>
 * @license  http://opensource.org/licenses/gpl-license.php GNU Public License
 * @link     http://swisscom.ch
 */
abstract class ConfigurationLoaderAbstract implements LoaderInterface

ConfigurationLoaderAbstract does not seem to conform to the naming convention (^Abstract|Factory$).

{
    /** @var ValidatorInterface */
    private $validator;

    /** @var  DispersalStrategyInterface */
    private $strategy;

    /** @var array  */
    private $options = [];


    /**
     * constructor
     *
     * @param ValidatorInterface $validator validator
     * @param LoggerInterface    $logger    Logger
     */
    public function __construct(ValidatorInterface $validator, LoggerInterface $logger)
    {
        $this->validator = $validator;
        $this->logger = $logger;
    }

    /**
     * @inheritDoc
     *
     * @param array $options Configuration options ['prefix']
     *
     * @return void
     */
    public function setOptions($options)

This method seems to be duplicated in your project.

    {
        if (!empty($options['prefix'])) {
            $options['storeKey'] = $options['prefix'];
            unset($options['prefix']);
        }

        $this->options = array_merge($this->options, $options);
    }

    /**
     * @inheritDoc
     *
     * @param DispersalStrategyInterface $strategy Strategy to be used
     *
     * @return void
     */
    public function setDispersalStrategy(DispersalStrategyInterface $strategy)
    {
        $this->strategy = $strategy;
    }

    /**
     * @inheritDoc
     *
     * @param CacheProvider $cache          Cache layer to be used
     * @param string        $cacheNamespace Name of the cache to be used
     * @param int           $cacheLifetime  Cache time to life
     *
     * @return void
     */
    public function setCache(CacheProvider $cache, $cacheNamespace, $cacheLifetime)
    {
    }

    /**
     * Determines, if the current loader is capable of handling the request.
     *
     * @param string $url Current url
     *
     * @return bool
     */
    public function supports($url)
    {
        $error = $this->validator->validate($url, [new Url()]);

        return 0 === count($error);
    }

    /**
     * @inheritDoc
     *
     * @param string $url Current Url
     *
     * @return ApiDefinition
     */
    public function load($url)
    {
        $apiDef =  new ApiDefinition();
        $apiDef->setHost(parse_url($url, PHP_URL_HOST));

It seems like parse_url($url, PHP_URL_HOST) targeting parse_url() can also be of type false; however, Graviton\ProxyBundle\Definition\ApiDefinition::setHost() does only seem to accept string, did you maybe forget to handle an error condition?

        $apiDef->setBasePath(parse_url($url, PHP_URL_PATH));

It seems like parse_url($url, PHP_URL_PATH) targeting parse_url() can also be of type false; however, Graviton\ProxyBundle\Definition\ApiDefinition::setBasePath() does only seem to accept string, did you maybe forget to handle an error condition?

        $this->defineSchema($apiDef);
        $apiDef->addEndpoint($this->options['endpoint']);

        return $apiDef;
    }

    /**
     * @inheritDoc
     *
     * @param ApiDefinition $apiDef Api definition the Schema to be defined in.
     *
     * @return void
     */
    private function defineSchema(ApiDefinition $apiDef)
    {
        if (array_key_exists('endpoint', $this->options)) {
            $finder = $this->findSchemaFile($this->options['storeKey']);

            foreach ($finder as $file) {
                $endpoint = $this->options['endpoint'];

                // MAGIC happens here:
                // need to streamline endpoint and filename to be able to find the endpoint.
                $cmp = str_replace('/', '', $endpoint);
                list($filename, ) = explode('.', $file->getFilename());

                if ($cmp == $filename) {
                    $schema = json_decode(file_get_contents($file->getRealPath()));
                    $apiDef->addSchema($endpoint, $schema);
                }
            }
        }
    }

    /**
     * Provides information about a filesystem directory and its' containing files.
     *
     * @param string $prefix Name of the directory to search in.
     *
     * @return Finder
     */
    abstract protected function findSchemaFile($prefix);
}