Ciandt\Behat\PlaceholdersExtension\Config\PlaceholdersRepository

Complexity

Total Complexity

35

Size/Duplication

Total Lines	181
Duplicated Lines	7.73 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	getTags()	0	4	1
A	loadConfigFiles()	0	9	2
A	getConfig()	7	7	2
A	getFilePath()	7	7	2
A	getEnvironment()	0	4	1
A	setEnvironment()	0	4	1
A	getScenarioTags()	0	3	1
C	replaceRecursively()	0	51	10
A	getReplacement()	0	4	1
B	recursiveReplacementSearch()	0	20	7
A	getSectionPlaceholders()	0	12	3
A	setReplacement()	0	10	3

<?php
namespace Ciandt\Behat\PlaceholdersExtension\Config;

use Symfony\Component\Yaml\Yaml;
use Ciandt\Behat\PlaceholdersExtension\Utils\PlaceholderUtils;
use Ciandt\Behat\PlaceholdersExtension\PlaceholderContainer\PlaceholderContainer;
use Ciandt\Behat\PlaceholdersExtension\Exception\MissingSectionException;
use Ciandt\Behat\PlaceholdersExtension\Exception\UndefinedPlaceholderException;
use Exception;

/**
 * Description of ConfigsRepository
 *
 * @author bwowk
 */
class PlaceholdersRepository
{
    const PLACEHOLDER_REGEX = '/\${(?P<placeholder>[a-zA-Z0-9_-]+)}/';
    
    private $configs;
    
    private $beforeScenarioSubscriber;
    
    private $runtimePlaceholders = array();

    /**
     * @var string
     */
    private $environment;

    public function __construct($configs_mapping, $beforeScenarioSubscriber)
    {
        $this->configs = $this->loadConfigFiles($configs_mapping);
        $this->beforeScenarioSubscriber = $beforeScenarioSubscriber;
    }

    /**
     *
     * @return string[]
     * @todo read configs and also bring alternative @config:section tags
     */
    public function getTags()
    {
        return array_keys($this->configs);
    }

    /**
     * reads the YAML placeholder definitions and returns an associative array
     *
     * @param type $config_files

There is no parameter named $config_files. Was it maybe removed?

     * @todo use %paths.base% value
     * @return array
     */
    private function loadConfigFiles($configs_mapping)
    {
        $placeholder_maps = array();
        foreach ($configs_mapping as $tag => $file_path) {
            $placeholder_maps[$tag]['config'] = Yaml::parse(file_get_contents($file_path));
            $placeholder_maps[$tag]['path'] = $file_path;
        }
        return $placeholder_maps;
    }

    private function getConfig($key)

This method seems to be duplicated in your project.

    {
        if (key_exists($key, $this->configs)) {
            return $this->configs[$key]['config'];
        }
        return null;
    }

    private function getFilePath($key)

This method seems to be duplicated in your project.

    {
         if (key_exists($key, $this->configs)) {
            return $this->configs[$key]['path'];
        }
        return null;
    }
       
    public function getEnvironment()
    {
        return $this->environment;
    }

    public function setEnvironment($environment)
    {
        $this->environment = $environment;
    }
    
    private function getScenarioTags(){
        return $this->beforeScenarioSubscriber->getScenarioTags();
    }

    private function replaceRecursively($placeholder, $replaced = array())
    {
        // if the current placeholder was already replaced before, this is a cyclic dependecy
        if (in_array($placeholder, $replaced)){
            $tree = implode('>', $replaced);
            throw new Exception("Cyclic placeholder dependecy detected. Trying to replace $placeholder again when already replaced: $tree");
        }

        $tags = $this->getScenarioTags();

        //@todo abort if there's no config tag
        $configTag = PlaceholderUtils::getConfigTag($tags);
        $configKey = PlaceholderUtils::getConfigKey($configTag);

        $variantTags = PlaceholderUtils::filterVariantTags($tags, false);
        $variant = end($variantTags);
        $environment = $this->getEnvironment();

        $keys = array('$' . $variant, '$' . $environment, $placeholder);

        // First try to find it in the runtime placeholders
        $replacement = $this->recursiveReplacementSearch($keys, $this->runtimePlaceholders);


        // Then look in the placeholder files
        if ($replacement === null && $configTag !== false ) {
            $section = PlaceholderUtils::getSectionKey($configTag);
            $placeholders = $this->getSectionPlaceholders($configKey, $section);
            $replacement = $this->recursiveReplacementSearch($keys, $placeholders);
        }

        if ($replacement === null && $configTag !== false){
            $configPath = $this->getFilePath($configKey);
            $treePosition = "$configPath>$section>placeholders";

The variable $section does not seem to be defined for all execution paths leading up to this point.

            throw new UndefinedPlaceholderException("No $placeholder replacement was defined on runtime or on $treePosition>$placeholder for variant $variant and environment $environment");
        } elseif ($replacement === null && $configTag === false) {
            throw new UndefinedPlaceholderException("No $placeholder replacement was defined on runtime, and this scenario is not linked with any replacements file");
        }

        //if the replaced string doesn't have placeholders itself, return it right away
        if (preg_match_all(self::PLACEHOLDER_REGEX, $replacement, $matches, PREG_SET_ORDER) == 0) {
            return $replacement;
        }

        //if it does have, replace them before returning
        foreach ($matches as $match) {

The expression $matches of type null|array<integer,array<integer,string>> is not guaranteed to be traversable. How about adding an additional type check?

            $replaced[] = $placeholder;
            $replacement = str_replace('${' . $match['placeholder'] . '}', $this->replaceRecursively($match['placeholder'], $replaced), $replacement);
        }
        return $replacement;
    }

    public function getReplacement($placeholder)
    {
        return $this->replaceRecursively($placeholder);
    }
    
    private function recursiveReplacementSearch($keys, $values)
    {
        if (empty($keys) || is_scalar($values)) {
            return $values;
        }
        $key = array_pop($keys);
        if (key_exists($key, $values)) {
            $specificValue = $this->recursiveReplacementSearch($keys, $values[$key]);
            if ($specificValue) {
                return $specificValue;
            }
        } if (key_exists('$default', $values)) {
            $defaultValue = $this->recursiveReplacementSearch($keys, $values['$default']);
            if ($defaultValue) {
                return $defaultValue;
            }
        }
        
        return null;
    }
    
    private function getSectionPlaceholders($configKey, $section)
    {
        $config = $this->getConfig($configKey);
        if (!isset($config) || !key_exists($section, $config)) {
            throw new MissingSectionException(
                $configKey,
                $this->getFilePath($configKey),
                $section
            );
        }
        return $config[$section]['placeholders'];
    }
    
    public function setReplacement($key, $value, $environment = '$default', $variant = '$default')
    {
        if (!isset($this->runtimePlaceholders[$key])) {
            $this->runtimePlaceholders[$key] = array();
        }
        if (!isset($this->runtimePlaceholders[$key][$environment])) {
            $this->runtimePlaceholders[$key][$environment] = array();
        }
        $this->runtimePlaceholders[$key][$environment][$variant] = $value;
    }

}