KernelAwareInitializer - Code Metrics - Behat/Symfony2Extension - Measure and Improve Code Quality continuously with Scrutinizer

KernelAwareInitializer A
last analyzed 2018-05-22 21:25 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
dl	0
loc	65
rs	10
c	2
b	0
f	0
wmc	9
lcom	1
cbo	1

5 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	getSubscribedEvents()	7	1
A	initializeContext()	8	3
A	rebootKernel()	5	1
A	usesKernelDictionary()	11	3

<?php

/*
 * This file is part of the Behat Symfony2Extension
 *
 * (c) Konstantin Kudryashov <[email protected]>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace Behat\Symfony2Extension\Context\Initializer;

use Behat\Behat\Context\Context;
use Behat\Behat\Context\Initializer\ContextInitializer;
use Behat\Behat\EventDispatcher\Event\ExampleTested;
use Behat\Behat\EventDispatcher\Event\ScenarioTested;
use Behat\Symfony2Extension\Context\KernelAwareContext;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\KernelInterface;

/**
 * Kernel aware contexts initializer.
 * Sets Kernel instance to the KernelAware contexts.
 *
 * @author Konstantin Kudryashov <[email protected]>
 */
final class KernelAwareInitializer implements ContextInitializer, EventSubscriberInterface
{
    private $kernel;

    /**
     * Initializes initializer.
     *
     * @param KernelInterface $kernel
     */
    public function __construct(KernelInterface $kernel)
    {
        $this->kernel = $kernel;
    }

    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents()
    {
        return array(
            ScenarioTested::AFTER  => array('rebootKernel', -15),
            ExampleTested::AFTER   => array('rebootKernel', -15),
        );
    }

    /**
     * {@inheritdoc}
     */
    public function initializeContext(Context $context)
    {
        if (!$context instanceof KernelAwareContext && !$this->usesKernelDictionary($context)) {
            return;
        }

        $context->setKernel($this->kernel);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * Reboots HttpKernel after each scenario.
     */
    public function rebootKernel()
    {
        $this->kernel->shutdown();
        $this->kernel->boot();
    }

    /**
     * Checks whether the context uses the KernelDictionary trait.
     *
     * @param Context $context
     *
     * @return boolean
     */
    private function usesKernelDictionary(Context $context)
    {
        $refl = new \ReflectionObject($context);
        if (method_exists($refl, 'getTraitNames')) {
            if (in_array('Behat\\Symfony2Extension\\Context\\KernelDictionary', $refl->getTraitNames())) {
                return true;
            }
        }

        return false;
    }
}


1			<?php
2
3			/*
4			* This file is part of the Behat Symfony2Extension
5			*
6			* (c) Konstantin Kudryashov <[email protected]>
7			*
8			* This source file is subject to the MIT license that is bundled
9			* with this source code in the file LICENSE.
10			*/
11
12			namespace Behat\Symfony2Extension\Context\Initializer;
13
14			use Behat\Behat\Context\Context;
15			use Behat\Behat\Context\Initializer\ContextInitializer;
16			use Behat\Behat\EventDispatcher\Event\ExampleTested;
17			use Behat\Behat\EventDispatcher\Event\ScenarioTested;
18			use Behat\Symfony2Extension\Context\KernelAwareContext;
19			use Symfony\Component\EventDispatcher\EventSubscriberInterface;
20			use Symfony\Component\HttpKernel\KernelInterface;
21
22			/**
23			* Kernel aware contexts initializer.
24			* Sets Kernel instance to the KernelAware contexts.
25			*
26			* @author Konstantin Kudryashov <[email protected]>
27			*/
28			final class KernelAwareInitializer implements ContextInitializer, EventSubscriberInterface
29			{
30			private $kernel;
31
32			/**
33			* Initializes initializer.
34			*
35			* @param KernelInterface $kernel
36			*/
37			public function __construct(KernelInterface $kernel)
38			{
39			$this->kernel = $kernel;
40			}
41
42			/**
43			* {@inheritdoc}
44			*/
45			public static function getSubscribedEvents()
46			{
47			return array(
48			ScenarioTested::AFTER => array('rebootKernel', -15),
49			ExampleTested::AFTER => array('rebootKernel', -15),
50			);
51			}
52
53			/**
54			* {@inheritdoc}
55			*/
56			public function initializeContext(Context $context)
57			{
58			if (!$context instanceof KernelAwareContext && !$this->usesKernelDictionary($context)) {
59			return;
60			}
61
62			$context->setKernel($this->kernel);
			0 ignored issues – show Bug introduced 2015-11-23 11:56 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Behat\Behat\Context\Context` as the method `setKernel()` does only exist in the following implementations of said interface: `Behat\Sf2DemoBundle\Feat...\Context\FeatureContext`, `Behat\Sf2DemoBundle\Features\Context\WebContext`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
63			}
64
65			/**
66			* Reboots HttpKernel after each scenario.
67			*/
68			public function rebootKernel()
69			{
70			$this->kernel->shutdown();
71			$this->kernel->boot();
72			}
73
74			/**
75			* Checks whether the context uses the KernelDictionary trait.
76			*
77			* @param Context $context
78			*
79			* @return boolean
80			*/
81			private function usesKernelDictionary(Context $context)
82			{
83			$refl = new \ReflectionObject($context);
84			if (method_exists($refl, 'getTraitNames')) {
85			if (in_array('Behat\\Symfony2Extension\\Context\\KernelDictionary', $refl->getTraitNames())) {
86			return true;
87			}
88			}
89
90			return false;
91			}
92			}
93

Behat / Symfony2Extension

KernelAwareInitializer A last analyzed 2018-05-22 21:25 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like

KernelAwareInitializer A
last analyzed 2018-05-22 21:25 UTC