LibraryLoader::getCustomConfigurationDir() - Code Metrics - Inspection of "Add loading of custom configuration file" - techdivision/import-cli - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — 8.x ( f3eaec...2ddcfa )

by Tim
created 2019-10-16 12:25 UTC
LibraryLoader::getCustomConfigurationDir() A

↳ Parent: LibraryLoader
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
ccs	0
cts	0
cp	0
crap	2
rs	10
<?php

/**
 * TechDivision\Import\Cli\Configuration\LibraryLoader
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2016 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-cli-simple
 * @link      http://www.techdivision.com
 */

namespace TechDivision\Import\Cli\Configuration;

use Symfony\Component\Config\FileLocator;
use Symfony\Component\Config\Loader\LoaderInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
use TechDivision\Import\ConfigurationInterface;
use TechDivision\Import\Cli\Utils\DependencyInjectionKeys;

/**
 * The library loader implementation.
 *
 * @author    Tim Wagner <[email protected]>
 * @copyright 2016 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/techdivision/import-cli-simple
 * @link      http://www.techdivision.com
 */
class LibraryLoader
{

    /**
     * The container instance.
     *
     * @var \Symfony\Component\DependencyInjection\ContainerInterface
     */
    protected $container;

    /**
     * Initializes the configuration loader.
     *
     * @param \Symfony\Component\DependencyInjection\ContainerInterface $container The container instance
     */
    public function __construct(ContainerInterface $container)
    {
        $this->container = $container;
    }

    /**
     * Return's the DI container instance.
     *
     * @return \Symfony\Component\DependencyInjection\ContainerInterface The DI container instance
     */
    protected function getContainer()
    {
        return $this->container;
    }

    /**
     * Return's the absolute path to the actual vendor directory.
     *
     * @return string The absolute path to the actual vendor directory
     */
    protected function getVendorDir()
    {
        return $this->getContainer()->getParameter(DependencyInjectionKeys::CONFIGURATION_VENDOR_DIR);
    }

    /**
     * Return's the relative path to the custom configuration directory.
     *
     * @return string The relative path to the custom configuration directory
     */
    protected function getCustomConfigurationDir()
    {
        return $this->getContainer()->getParameter(DependencyInjectionKeys::APPLICATION_CUSTOM_CONFIGURATION_DIR);
    }

    /**
     * Load's the external libraries registered in the passed configuration.
     *
     * @param \TechDivision\Import\ConfigurationInterface $configuration The configuration instance
     *
     * @return void
     */
    public function load(ConfigurationInterface $configuration)
    {

        // load the DI container, vendor and custom configuration
        // directory as well as the Magento version
        $container = $this->getContainer();
        $vendorDir = $this->getVendorDir();
        $magentoVersion = $configuration->getMagentoVersion();
        $customConfigurationDir = $this->getCustomConfigurationDir();

        // initialize the default loader and load the DI configuration for the this library
        $defaultLoader = new XmlFileLoader($container, new FileLocator($vendorDir));

        // load the DI configuration for all the extension libraries
        foreach ($configuration->getExtensionLibraries() as $library) {
            $this->loadConfiguration($defaultLoader, $magentoVersion, sprintf('%s/%s', $vendorDir, $library));
        }

        // register autoloaders for additional vendor directories
        $customLoader = new XmlFileLoader($container, new FileLocator());
        foreach ($configuration->getAdditionalVendorDirs() as $additionalVendorDir) {
            // load the vendor directory's auto loader
            if (file_exists($autoLoader = $additionalVendorDir->getVendorDir() . '/autoload.php')) {
                require $autoLoader;
            } else {
                throw new \Exception(
                    sprintf(
                        'Can\'t find autoloader in configured additional vendor directory "%s"',
                        $additionalVendorDir->getVendorDir()
                    )
                );
            }

            // try to load the DI configuration for the configured extension libraries
            foreach ($additionalVendorDir->getLibraries() as $library) {
                if ($libraryDir = realpath(sprintf('%s/%s', $additionalVendorDir->getVendorDir(), $library))) {
                    $this->loadConfiguration($customLoader, $magentoVersion, $libraryDir);
                } else {
                    throw new \Exception(
                        sprintf(
                            'Can\'t find find library directory "%s/%s"',
                            $additionalVendorDir->getVendorDir(),
                            $library
                        )
                    );
                }
            }
        }

        // initialize the project specific configuration loader for the DI configuration
        $projectLoader = new XmlFileLoader($container, new FileLocator(getcwd()));

        // finally load the project specific custom library configuration which overwrites the default one
        $this->loadConfiguration($projectLoader, $magentoVersion, $customConfigurationDir);
    }

    /**
     * Loads the version specific Symfony DI configuration.
     *
     * @param \Symfony\Component\Config\Loader\LoaderInterface $loader         The Symfony DI loader instance
     * @param string                                           $magentoVersion The Magento Version to load the configuration for
     * @param string                                           $libraryDir     The library directory
     *
     * @return boolean TRUE if the configuration file has been loaded, else FALSE
     */
    protected function loadConfiguration(LoaderInterface $loader, $magentoVersion, $libraryDir)
    {

        // load the default Symfony Di configuration
        if (file_exists($diConfiguration = sprintf('%s/symfony/Resources/config/services.xml', $libraryDir))) {
            // load the DI configuration
            $loader->load($diConfiguration);

            // load the directories that equals the versions custom configuration files are available for
            $versions = glob(sprintf('%s/symfony/Resources/config/*', $libraryDir), GLOB_ONLYDIR);

            // sort the directories descending by their version
            usort($versions, 'version_compare');
            usort(/** @scrutinizer ignore-type */ $versions, 'version_compare');
            krsort($versions);

            // override DI configuration with version specifc data
            foreach ($versions as $version) {
                if (version_compare(basename($version), $magentoVersion, '<=')) {
                    if (file_exists($diConfiguration = sprintf('%s/services.xml', $version))) {
                        // load the version specific DI configuration
                        $loader->load($diConfiguration);
                    }
                }
            }

            // return TRUE if the configuration has been loaded
            return true;
        }

        // return FALSE if the configuration file has NOT been available
        return false;
    }
}

techdivision / import-cli

Push — 8.x ( f3eaec...2ddcfa )

LibraryLoader::getCustomConfigurationDir() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
