RuntimePlaceholdersTransformation::__toString() - Code Metrics - Inspection of "Merged feature/config-sections into master" - ciandt-dev/behat-placeholders-extension - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 66c291...444f0e )

by Bruno

created 2017-01-02 12:05 UTC

RuntimePlaceholdersTransformation::__toString() A

↳ Parent: RuntimePlaceholdersTransformation

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0

<?php


namespace Ciandt\Behat\PlaceholdersExtension\Transformation;

use Behat\Behat\Definition\Call\DefinitionCall;
use Behat\Gherkin\Node\TableNode;
use Behat\Testwork\Call\RuntimeCallee;
use Ciandt\Behat\PlaceholdersExtension\Config\PlaceholdersRepository;
use Ciandt\Behat\PlaceholdersExtension\PlaceholderContainer\PlaceholderContainer;
use Ciandt\Behat\PlaceholdersExtension\PlaceholderContainer\PlaceholderContainerStepNode;

/**
 *
 */
final class RuntimePlaceholdersTransformation extends RuntimeCallee implements PlaceholdersTransformation {

    const USER_DEFINED_PLACEHOLDER_REGEX = '/\${(?P<placeholder>[a-zA-Z0-9_-]+)}/';

    public function __toString() {
        return 'UserDefinedPlaceholderTransform';
    }

    public function getPattern() {
        return self::USER_DEFINED_PLACEHOLDER_REGEX;
    }

    private static function replaceStringPlaceholders($string, PlaceholdersRepository $repository, PlaceholderContainerStepNode $container) {
        preg_match_all(self::USER_DEFINED_PLACEHOLDER_REGEX, $string, $matches, PREG_SET_ORDER);
        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) { /** ... */ }
            $placeholder = $match['placeholder'];
            $replacement = $repository->getReplacement($placeholder, $container);
            $string = str_replace('${' . $placeholder . '}', $replacement, $string);
        }
        return $string;
    }

    private static function replaceTablePlaceholders(TableNode $table, PlaceholdersRepository $repository, PlaceholderContainerStepNode $container) {

        //@todo
    }

    public static function supportsDefinitionAndArgument(DefinitionCall $definitionCall, $argumentValue) {
        if ($definitionCall->getStep() instanceof PlaceholderContainerStepNode) {
            if (is_string($argumentValue) && preg_match(self::USER_DEFINED_PLACEHOLDER_REGEX, $argumentValue) === 1) {
                return true;
            }
            if ($argumentValue instanceof TableNode && $this->tableHasPlaceholders($table)) {

                return false;
            }
        }
        return false;
    }

    private static function tableHasPlaceholders(TableNode $table) {
        return (preg_match(self::USER_DEFINED_PLACEHOLDER_REGEX, $table->getTableAsString()) === 1);
    }

    public static function transformArgument($argumentValue, PlaceholdersRepository $repository, PlaceholderContainer $container) {
        if (is_string($argumentValue)) {
            return self::replaceStringPlaceholders($argumentValue, $repository, $container);

        }

        if ($argumentValue instanceof TableNode) {
            return self::replaceTablePlaceholders($table, $repository, $container);

        }
    }

}


1			<?php
2
3
4			namespace Ciandt\Behat\PlaceholdersExtension\Transformation;
5
6			use Behat\Behat\Definition\Call\DefinitionCall;
7			use Behat\Gherkin\Node\TableNode;
8			use Behat\Testwork\Call\RuntimeCallee;
9			use Ciandt\Behat\PlaceholdersExtension\Config\PlaceholdersRepository;
10			use Ciandt\Behat\PlaceholdersExtension\PlaceholderContainer\PlaceholderContainer;
11			use Ciandt\Behat\PlaceholdersExtension\PlaceholderContainer\PlaceholderContainerStepNode;
12
13			/**
14			*
15			*/
16			final class RuntimePlaceholdersTransformation extends RuntimeCallee implements PlaceholdersTransformation {
17
18			const USER_DEFINED_PLACEHOLDER_REGEX = '/\${(?P<placeholder>[a-zA-Z0-9_-]+)}/';
19
20			public function __toString() {
21			return 'UserDefinedPlaceholderTransform';
22			}
23
24			public function getPattern() {
25			return self::USER_DEFINED_PLACEHOLDER_REGEX;
26			}
27
28			private static function replaceStringPlaceholders($string, PlaceholdersRepository $repository, PlaceholderContainerStepNode $container) {
29			preg_match_all(self::USER_DEFINED_PLACEHOLDER_REGEX, $string, $matches, PREG_SET_ORDER);
30			foreach ($matches as $match) {
			0 ignored issues – show Bug introduced 2017-01-02 12:09 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...
31			$placeholder = $match['placeholder'];
32			$replacement = $repository->getReplacement($placeholder, $container);
33			$string = str_replace('${' . $placeholder . '}', $replacement, $string);
34			}
35			return $string;
36			}
37
38			private static function replaceTablePlaceholders(TableNode $table, PlaceholdersRepository $repository, PlaceholderContainerStepNode $container) {
			0 ignored issues – show Unused Code introduced 2017-01-02 12:09 UTC by Report Bug Copy Issue Report The parameter `$table` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2017-01-02 12:09 UTC by Report Bug Copy Issue Report The parameter `$repository` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2017-01-02 12:09 UTC by Report Bug Copy Issue Report The parameter `$container` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
39			//@todo
40			}
41
42			public static function supportsDefinitionAndArgument(DefinitionCall $definitionCall, $argumentValue) {
43			if ($definitionCall->getStep() instanceof PlaceholderContainerStepNode) {
44			if (is_string($argumentValue) && preg_match(self::USER_DEFINED_PLACEHOLDER_REGEX, $argumentValue) === 1) {
45			return true;
46			}
47			if ($argumentValue instanceof TableNode && $this->tableHasPlaceholders($table)) {
			0 ignored issues – show Bug introduced 2017-01-02 12:09 UTC by Report Bug Copy Issue Report The variable `$this` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Bug introduced 2017-01-02 12:09 UTC by Report Bug Copy Issue Report The variable `$table` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
48			return false;
49			}
50			}
51			return false;
52			}
53
54			private static function tableHasPlaceholders(TableNode $table) {
55			return (preg_match(self::USER_DEFINED_PLACEHOLDER_REGEX, $table->getTableAsString()) === 1);
56			}
57
58			public static function transformArgument($argumentValue, PlaceholdersRepository $repository, PlaceholderContainer $container) {
59			if (is_string($argumentValue)) {
60			return self::replaceStringPlaceholders($argumentValue, $repository, $container);
			0 ignored issues – show Compatibility introduced 2017-01-02 12:09 UTC by Report Bug Copy Issue Report `$container` of type `object<Ciandt\Behat\Plac...r\PlaceholderContainer>` is not a sub-type of `object<Ciandt\Behat\Plac...olderContainerStepNode>`. It seems like you assume a concrete implementation of the interface `Ciandt\Behat\Placeholder...er\PlaceholderContainer` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
61			}
62
63			if ($argumentValue instanceof TableNode) {
64			return self::replaceTablePlaceholders($table, $repository, $container);
			0 ignored issues – show Bug introduced 2017-01-02 12:09 UTC by Report Bug Copy Issue Report The variable `$table` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Compatibility introduced 2017-01-02 12:09 UTC by Report Bug Copy Issue Report `$container` of type `object<Ciandt\Behat\Plac...r\PlaceholderContainer>` is not a sub-type of `object<Ciandt\Behat\Plac...olderContainerStepNode>`. It seems like you assume a concrete implementation of the interface `Ciandt\Behat\Placeholder...er\PlaceholderContainer` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
65			}
66			}
67
68			}
69

ciandt-dev / behat-placeholders-extension

GitHub Access Token became invalid

Push — master ( 66c291...444f0e )

RuntimePlaceholdersTransformation::__toString() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like