ScenarioStateHookDispatcher::__construct() - Code Metrics - Inspection of "[WIP] Inject store arguments in Behat hooks non st..." - gorghoa/ScenarioStateBehatExtension - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#24)

by Vincent

created 2017-04-04 08:27 UTC

ScenarioStateHookDispatcher::__construct() A

↳ Parent: ScenarioStateHookDispatcher

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	5
nc	1
nop	4

<?php

/*
 * This file is part of the ScenarioStateBehatExtension project.
 *
 * (c) Rodrigue Villetard <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Gorghoa\ScenarioStateBehatExtension;

use Behat\Testwork\Call\CallCenter;
use Behat\Testwork\Call\CallResult;
use Behat\Testwork\Call\CallResults;
use Behat\Testwork\Hook\Call\HookCall;
use Behat\Testwork\Hook\Hook;
use Behat\Testwork\Hook\HookRepository;
use Behat\Testwork\Hook\Scope\HookScope;
use Doctrine\Common\Annotations\Reader;
use Gorghoa\ScenarioStateBehatExtension\Annotation\ScenarioStateArgument;
use Gorghoa\ScenarioStateBehatExtension\Context\Initializer\ScenarioStateInitializer;

/**
 * @author Vincent Chalamon <[email protected]>
 */
final class ScenarioStateHookDispatcher
{
    /**
     * @var HookRepository
     */
    private $repository;

    /**
     * @var CallCenter
     */
    private $callCenter;

    /**
     * @var Reader
     */
    private $reader;

    /**
     * @var ScenarioStateInitializer
     */
    private $store;

    /**
     * Initializes scenario state hook dispatcher.
     *
     * @param HookRepository           $repository
     * @param CallCenter               $callCenter
     * @param ScenarioStateInitializer $store
     * @param Reader                   $reader
     */
    public function __construct(HookRepository $repository, CallCenter $callCenter, ScenarioStateInitializer $store, Reader $reader)
    {
        $this->repository = $repository;
        $this->callCenter = $callCenter;
        $this->reader = $reader;
        $this->store = $store;
    }

    /**
     * Dispatches hooks for a specified event.
     *
     * @param HookScope $scope
     *
     * @return CallResults
     */
    public function dispatchScopeHooks(HookScope $scope)
    {
        $results = array();
        foreach ($this->repository->getScopeHooks($scope) as $hook) {
            $function = $hook->getReflection();

            // No `@ScenarioStateArgument` annotation found
            if (null === $this->reader->getMethodAnnotation($function, ScenarioStateArgument::class)) {

                $results[] = $this->callCenter->makeCall(new HookCall($scope, $hook));
                continue;
            }

//            $match = [];

//            $i = array_slice(array_keys($match), -1, 1)[0];
            $paramsKeys = array_map(function($element) {
                return $element->name;
            }, $function->getParameters());
            var_dump($function->getParameters());

            $store = $this->store->getStore();

            /** @var ScenarioStateArgument[] $annotations */
            $annotations = $this->reader->getMethodAnnotations($function);

            foreach ($annotations as $annotation) {

                if ($annotation instanceof ScenarioStateArgument &&
                    in_array($annotation->getArgument(), $paramsKeys) &&
                    $store->hasStateFragment($annotation->getName())
                ) {
                    $match[$annotation->getArgument()] = $store->getStateFragment($annotation->getName());
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
                    $match[strval(++$i)] = $store->getStateFragment($annotation->getName());
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
                }
            }

            $results[] = $this->callCenter->makeCall(new ScenarioStateCall($scope, $hook, ['foo', 'bar']));
        }

        return new CallResults($results);
    }

    /**
     * Dispatches single event hook.
     *
     * @param HookScope $scope
     * @param Hook      $hook
     *
     * @return CallResult
     */
    private function dispatchHook(HookScope $scope, Hook $hook)

    {
        return $this->callCenter->makeCall(new HookCall($scope, $hook));
    }
}


1		<?php
2
3		/*
4		* This file is part of the ScenarioStateBehatExtension project.
5		*
6		* (c) Rodrigue Villetard <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Gorghoa\ScenarioStateBehatExtension;
13
14		use Behat\Testwork\Call\CallCenter;
15		use Behat\Testwork\Call\CallResult;
16		use Behat\Testwork\Call\CallResults;
17		use Behat\Testwork\Hook\Call\HookCall;
18		use Behat\Testwork\Hook\Hook;
19		use Behat\Testwork\Hook\HookRepository;
20		use Behat\Testwork\Hook\Scope\HookScope;
21		use Doctrine\Common\Annotations\Reader;
22		use Gorghoa\ScenarioStateBehatExtension\Annotation\ScenarioStateArgument;
23		use Gorghoa\ScenarioStateBehatExtension\Context\Initializer\ScenarioStateInitializer;
24
25		/**
26		* @author Vincent Chalamon <[email protected]>
27		*/
28		final class ScenarioStateHookDispatcher
29		{
30		/**
31		* @var HookRepository
32		*/
33		private $repository;
34
35		/**
36		* @var CallCenter
37		*/
38		private $callCenter;
39
40		/**
41		* @var Reader
42		*/
43		private $reader;
44
45		/**
46		* @var ScenarioStateInitializer
47		*/
48		private $store;
49
50		/**
51		* Initializes scenario state hook dispatcher.
52		*
53		* @param HookRepository $repository
54		* @param CallCenter $callCenter
55		* @param ScenarioStateInitializer $store
56		* @param Reader $reader
57		*/
58		public function __construct(HookRepository $repository, CallCenter $callCenter, ScenarioStateInitializer $store, Reader $reader)
59		{
60		$this->repository = $repository;
61		$this->callCenter = $callCenter;
62		$this->reader = $reader;
63		$this->store = $store;
64		}
65
66		/**
67		* Dispatches hooks for a specified event.
68		*
69		* @param HookScope $scope
70		*
71		* @return CallResults
72		*/
73		public function dispatchScopeHooks(HookScope $scope)
74		{
75		$results = array();
76		foreach ($this->repository->getScopeHooks($scope) as $hook) {
77		$function = $hook->getReflection();
78
79		// No `@ScenarioStateArgument` annotation found
80		if (null === $this->reader->getMethodAnnotation($function, ScenarioStateArgument::class)) {
		0 ignored issues – show Compatibility introduced 2017-04-04 08:32 UTC by Report Bug Copy Issue Report `$function` of type `object<ReflectionFunctionAbstract>` is not a sub-type of `object<ReflectionMethod>`. It seems like you assume a child class of the class `ReflectionFunctionAbstract` 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...
81		$results[] = $this->callCenter->makeCall(new HookCall($scope, $hook));
82		continue;
83		}
84
85		// $match = [];
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-04-04 08:32 UTC by Report Bug Copy Issue Report `57%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
86		// $i = array_slice(array_keys($match), -1, 1)[0];
87		$paramsKeys = array_map(function($element) {
88		return $element->name;
89		}, $function->getParameters());
90		var_dump($function->getParameters());
		0 ignored issues – show Security Debugging Code introduced 2017-04-04 08:32 UTC by Report Bug Copy Issue Report `var_dump($function->getParameters());` looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data. Loading history...
91		$store = $this->store->getStore();
92
93		/** @var ScenarioStateArgument[] $annotations */
94		$annotations = $this->reader->getMethodAnnotations($function);
		0 ignored issues – show Compatibility introduced 2017-04-04 08:32 UTC by Report Bug Copy Issue Report `$function` of type `object<ReflectionFunctionAbstract>` is not a sub-type of `object<ReflectionMethod>`. It seems like you assume a child class of the class `ReflectionFunctionAbstract` 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...
95	View Code Duplication	foreach ($annotations as $annotation) {
		0 ignored issues – show Duplication introduced 2017-04-04 08:32 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
96		if ($annotation instanceof ScenarioStateArgument &&
97		in_array($annotation->getArgument(), $paramsKeys) &&
98		$store->hasStateFragment($annotation->getName())
99		) {
100		$match[$annotation->getArgument()] = $store->getStateFragment($annotation->getName());
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-04-04 08:32 UTC by Report Bug Copy Issue Report `$match` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$match = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
101		$match[strval(++$i)] = $store->getStateFragment($annotation->getName());
		0 ignored issues – show Bug introduced 2017-04-04 08:32 UTC by Report Bug Copy Issue Report The variable `$match` 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... Bug introduced 2017-04-04 08:32 UTC by Report Bug Copy Issue Report The variable `$i` 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...
102		}
103		}
104
105		$results[] = $this->callCenter->makeCall(new ScenarioStateCall($scope, $hook, ['foo', 'bar']));
106		}
107
108		return new CallResults($results);
109		}
110
111		/**
112		* Dispatches single event hook.
113		*
114		* @param HookScope $scope
115		* @param Hook $hook
116		*
117		* @return CallResult
118		*/
119		private function dispatchHook(HookScope $scope, Hook $hook)
		0 ignored issues – show Unused Code introduced 2017-04-04 08:32 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
120		{
121		return $this->callCenter->makeCall(new HookCall($scope, $hook));
122		}
123		}
124

gorghoa / ScenarioStateBehatExtension

GitHub Access Token became invalid

Pull Request — master (#24)

ScenarioStateHookDispatcher::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like