JobQueue\Infrastructure\ServiceContainer

Complexity

Total Complexity

14

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Test Coverage

Coverage

77.14%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	getConfigurationCachePath()	0	8	2
B	getInstance()	0	33	6
A	__isset()	0	3	1
A	__get()	0	3	1
A	getConfigurationFilePath()	0	19	3

<?php

namespace JobQueue\Infrastructure;

use Psr\Container\ContainerInterface;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;

/**
 * This class may be extended to make extra services usable to jobs from workers.
 *
 * The following services have to be set in /config/services_{env}.yml :
 *
 * @property \Symfony\Component\EventDispatcher\EventDispatcher $dispatcher
 * @property \Psr\Log\LoggerInterface $logger
 * @property \JobQueue\Domain\Task\Queue $queue
 */
class ServiceContainer
{
    /**
     *
     * @var self
     */
    protected static $instance;

    /**
     *
     * @var ContainerInterface
     */
    protected $services;

    /**
     *
     * @param ContainerInterface $services
     */
    public function __construct(ContainerInterface $services)
    {
        $this->services = $services;
    }

    /**
     *
     * @return ServiceContainer
     */
    public static function getInstance(): self
    {
        if (self::$instance) {
            return self::$instance;
        }

        $cache = self::getConfigurationCachePath();

        if (Environment::isProd() and is_readable($cache)) {
            // Retrieve services from the cache, if exists...
            require_once $cache;
            $services = new \ProjectServiceContainer;

        } else {
            // ... otherwise compile & cache the configuration
            $services = new ContainerBuilder;

            $loader = new YamlFileLoader($services, new FileLocator);
            $loader->load(self::getConfigurationFilePath());

            // Compile and cache production config
            if (Environment::isProd()) {
                $services->compile(true);

                if (!is_dir($cacheDir = dirname($cache))) {
                    mkdir($cacheDir, 0777, true);
                }

                file_put_contents($cache, (new PhpDumper($services))->dump());
            }
        }

        return self::$instance = new self($services);
    }

    /**
     *
     * @return string
     */
    private static function getConfigurationFilePath(): string
    {
        // Get path from environment variables
        if ($path = getenv('JOBQUEUE_CONFIG_PATH')) {
            return $path;

The expression return $path could return the type array which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

        }

        // Get dir path depending on how component is used
        if (class_exists('\Composer\Autoload\ClassLoader')) {
            // Find config dir using composer ClassLoader class
            $reflection = new \ReflectionClass(\Composer\Autoload\ClassLoader::class);
            $root = dirname(dirname(dirname($reflection->getFileName())));

        } else {
            // If composer has not been user, try to guess the root path
            $root = dirname(dirname(__DIR__));
        }

        return sprintf('%s/config/services_%s.yml', $root, Environment::getName());
    }

    /**
     *
     * @return string
     */
    private static function getConfigurationCachePath(): string
    {
        // Get dir path from environment variables
        if (!$dir = getenv('JOBQUEUE_CACHE_PATH')) {
            $dir = sys_get_temp_dir();
        }

        return sprintf('%s/jobqueue_services.php', $dir);

It seems like $dir can also be of type array; however, parameter $args of sprintf() does only seem to accept string, maybe add an additional type check?

    }

    /**
     *
     * @param $service
     * @return bool
     */
    public function __isset($service)
    {
        return $this->services->has($service);
    }

    /**
     *
     * @param $service
     * @return mixed|object
     */
    public function __get($service)
    {
        return $this->services->get($service);
    }
}