PlaceholdersRepository::replaceRecursively() - Code Metrics - Inspection of "Renaming repository's interface method setPlacehol..." - ciandt-dev/behat-placeholders-extension - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 78b9a3...0417b0 )

by Bruno

created 2017-10-03 21:47 UTC

PlaceholdersRepository::replaceRecursively() C

↳ Parent: PlaceholdersRepository

Complexity

Conditions	10
Paths	11

Size

Total Lines	51
Code Lines	28

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	51
rs	6
c	0
b	0
f	0
cc	10
eloc	28
nc	11
nop	2

How to fix Long Method Complexity

<?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
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @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)

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

    private function getFilePath($key)

    {
         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";
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            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) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $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;
    }

}


GitHub Access Token became invalid

Push — master ( 78b9a3...0417b0 )

PlaceholdersRepository::replaceRecursively() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

1		<?php
2		namespace Ciandt\Behat\PlaceholdersExtension\Config;
3
4		use Symfony\Component\Yaml\Yaml;
5		use Ciandt\Behat\PlaceholdersExtension\Utils\PlaceholderUtils;
6		use Ciandt\Behat\PlaceholdersExtension\PlaceholderContainer\PlaceholderContainer;
7		use Ciandt\Behat\PlaceholdersExtension\Exception\MissingSectionException;
8		use Ciandt\Behat\PlaceholdersExtension\Exception\UndefinedPlaceholderException;
9		use Exception;
10
11		/**
12		* Description of ConfigsRepository
13		*
14		* @author bwowk
15		*/
16		class PlaceholdersRepository
17		{
18		const PLACEHOLDER_REGEX = '/\${(?P<placeholder>[a-zA-Z0-9_-]+)}/';
19
20		private $configs;
21
22		private $beforeScenarioSubscriber;
23
24		private $runtimePlaceholders = array();
25
26		/**
27		* @var string
28		*/
29		private $environment;
30
31		public function __construct($configs_mapping, $beforeScenarioSubscriber)
32		{
33		$this->configs = $this->loadConfigFiles($configs_mapping);
34		$this->beforeScenarioSubscriber = $beforeScenarioSubscriber;
35		}
36
37		/**
38		*
39		* @return string[]
40		* @todo read configs and also bring alternative @config:section tags
41		*/
42		public function getTags()
43		{
44		return array_keys($this->configs);
45		}
46
47		/**
48		* reads the YAML placeholder definitions and returns an associative array
49		*
50		* @param type $config_files
		0 ignored issues – show Bug introduced 2016-12-14 18:54 UTC by Report Bug Copy Issue Report There is no parameter named `$config_files`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
51		* @todo use %paths.base% value
52		* @return array
53		*/
54		private function loadConfigFiles($configs_mapping)
55		{
56		$placeholder_maps = array();
57		foreach ($configs_mapping as $tag => $file_path) {
58		$placeholder_maps[$tag]['config'] = Yaml::parse(file_get_contents($file_path));
59		$placeholder_maps[$tag]['path'] = $file_path;
60		}
61		return $placeholder_maps;
62		}
63
64	View Code Duplication	private function getConfig($key)
		0 ignored issues – show Duplication introduced 2017-09-23 17:54 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
65		{
66		if (key_exists($key, $this->configs)) {
67		return $this->configs[$key]['config'];
68		}
69		return null;
70		}
71
72	View Code Duplication	private function getFilePath($key)
		0 ignored issues – show Duplication introduced 2017-09-23 17:54 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
73		{
74		if (key_exists($key, $this->configs)) {
75		return $this->configs[$key]['path'];
76		}
77		return null;
78		}
79
80		public function getEnvironment()
81		{
82		return $this->environment;
83		}
84
85		public function setEnvironment($environment)
86		{
87		$this->environment = $environment;
88		}
89
90		private function getScenarioTags(){
91		return $this->beforeScenarioSubscriber->getScenarioTags();
92		}
93
94		private function replaceRecursively($placeholder, $replaced = array())
95		{
96		// if the current placeholder was already replaced before, this is a cyclic dependecy
97		if (in_array($placeholder, $replaced)){
98		$tree = implode('>', $replaced);
99		throw new Exception("Cyclic placeholder dependecy detected. Trying to replace $placeholder again when already replaced: $tree");
100		}
101
102		$tags = $this->getScenarioTags();
103
104		//@todo abort if there's no config tag
105		$configTag = PlaceholderUtils::getConfigTag($tags);
106		$configKey = PlaceholderUtils::getConfigKey($configTag);
107
108		$variantTags = PlaceholderUtils::filterVariantTags($tags, false);
109		$variant = end($variantTags);
110		$environment = $this->getEnvironment();
111
112		$keys = array('$' . $variant, '$' . $environment, $placeholder);
113
114		// First try to find it in the runtime placeholders
115		$replacement = $this->recursiveReplacementSearch($keys, $this->runtimePlaceholders);
116
117
118		// Then look in the placeholder files
119		if ($replacement === null && $configTag !== false ) {
120		$section = PlaceholderUtils::getSectionKey($configTag);
121		$placeholders = $this->getSectionPlaceholders($configKey, $section);
122		$replacement = $this->recursiveReplacementSearch($keys, $placeholders);
123		}
124
125		if ($replacement === null && $configTag !== false){
126		$configPath = $this->getFilePath($configKey);
127		$treePosition = "$configPath>$section>placeholders";
		0 ignored issues – show Bug introduced 2017-10-03 21:48 UTC by Report Bug Copy Issue Report The variable `$section` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
128		throw new UndefinedPlaceholderException("No $placeholder replacement was defined on runtime or on $treePosition>$placeholder for variant $variant and environment $environment");
129		} elseif ($replacement === null && $configTag === false) {
130		throw new UndefinedPlaceholderException("No $placeholder replacement was defined on runtime, and this scenario is not linked with any replacements file");
131		}
132
133		//if the replaced string doesn't have placeholders itself, return it right away
134		if (preg_match_all(self::PLACEHOLDER_REGEX, $replacement, $matches, PREG_SET_ORDER) == 0) {
135		return $replacement;
136		}
137
138		//if it does have, replace them before returning
139		foreach ($matches as $match) {
		0 ignored issues – show Bug introduced 2017-09-24 17:34 UTC by Report Bug Copy Issue Report The expression `$matches` of type `null\|array<integer,array<integer,string>>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
140		$replaced[] = $placeholder;
141		$replacement = str_replace('${' . $match['placeholder'] . '}', $this->replaceRecursively($match['placeholder'], $replaced), $replacement);
142		}
143		return $replacement;
144		}
145
146		public function getReplacement($placeholder)
147		{
148		return $this->replaceRecursively($placeholder);
149		}
150
151		private function recursiveReplacementSearch($keys, $values)
152		{
153		if (empty($keys) \|\| is_scalar($values)) {
154		return $values;
155		}
156		$key = array_pop($keys);
157		if (key_exists($key, $values)) {
158		$specificValue = $this->recursiveReplacementSearch($keys, $values[$key]);
159		if ($specificValue) {
160		return $specificValue;
161		}
162		} if (key_exists('$default', $values)) {
163		$defaultValue = $this->recursiveReplacementSearch($keys, $values['$default']);
164		if ($defaultValue) {
165		return $defaultValue;
166		}
167		}
168
169		return null;
170		}
171
172		private function getSectionPlaceholders($configKey, $section)
173		{
174		$config = $this->getConfig($configKey);
175		if (!isset($config) \|\| !key_exists($section, $config)) {
176		throw new MissingSectionException(
177		$configKey,
178		$this->getFilePath($configKey),
179		$section
180		);
181		}
182		return $config[$section]['placeholders'];
183		}
184
185		public function setReplacement($key, $value, $environment = '$default', $variant = '$default')
186		{
187		if (!isset($this->runtimePlaceholders[$key])) {
188		$this->runtimePlaceholders[$key] = array();
189		}
190		if (!isset($this->runtimePlaceholders[$key][$environment])) {
191		$this->runtimePlaceholders[$key][$environment] = array();
192		}
193		$this->runtimePlaceholders[$key][$environment][$variant] = $value;
194		}
195
196		}
197

ciandt-dev / behat-placeholders-extension

GitHub Access Token became invalid

Push — master ( 78b9a3...0417b0 )

PlaceholdersRepository::replaceRecursively() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like