Yoanm\BehatUtilsExtension\Context\Initializer\BehatContextSubscriberInitializer

Complexity

Total Complexity

6

Size/Duplication

Total Lines	55
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	initializeContext()	0	13	2
A	getSubscribedEvents()	0	7	1
A	clearBehatContextSubscriber()	0	7	2

<?php
namespace Yoanm\BehatUtilsExtension\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 Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Yoanm\BehatUtilsExtension\Context\BehatContextSubscriberInterface;

/**
 * Class BehatContextSubscriberInitializer
 * /!\ /!\ Contexts will be aware of Behat events only from ScenarioTested::BEFORE to ScenarioTested::AFTER only /!\ /!\
 *
 * This is due to the fact that context are (re)-created for each scenario or example
 * So contexts will have access to the followings event workflow (depending of the type of the scenario) :
 *
 * - Basic scenario :
 *      - ScenarioTested
 *          - BEFORE
 *          - AFTER_SETUP
 *      - BackgroundTested
 *          - BEFORE
 *          - AFTER_SETUP
 *      - StepTested
 *          - BEFORE
 *          - AFTER_SETUP
 *          - BEFORE_TEARDOWN
 *          - AFTER
 *      - BackgroundTested
 *          - BEFORE_TEARDOWN
 *          - AFTER
 *      - ScenarioTested
 *          - BEFORE_TEARDOWN
 *          - AFTER
 *
 * - Scenario outline :
 *      - ExampleTested
 *          - BEFORE
 *          - AFTER_SETUP
 *      - BackgroundTested
 *          - BEFORE
 *          - AFTER_SETUP
 *      - StepTested
 *          - BEFORE
 *          - AFTER_SETUP
 *          - BEFORE_TEARDOWN
 *          - AFTER
 *      - BackgroundTested
 *          - BEFORE_TEARDOWN
 *          - AFTER
 *      - ExampleTested
 *          - BEFORE_TEARDOWN
 *          - AFTER
 */
class BehatContextSubscriberInitializer implements ContextInitializer, EventSubscriberInterface
{
    /** @var EventDispatcherInterface */
    private $behatEventDispatcher;
    /** @var BehatContextSubscriberInterface[] */
    private $registeredContextList = [];


    /**
     * @param EventDispatcherInterface $behatEventDispatcher
     */
    public function __construct(EventDispatcherInterface $behatEventDispatcher)
    {
        $this->behatEventDispatcher = $behatEventDispatcher;
    }

    /**
     * {@inheritdoc}
     */
    public function initializeContext(Context $context)
    {
        if (!$context instanceof BehatContextSubscriberInterface) {
            return;
        }
        // This method is called before each scenario/example, so (an instance of) context
        // is probably already registered
        // To avoid any problem, keep a trace of registered contexts instance
        // and remove it at scenario or example end
        // (See clearBehatContextSubscriber method)
        $this->behatEventDispatcher->addSubscriber($context);
        $this->registeredContextList[] = $context;
    }

    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents()
    {
        return [
            ScenarioTested::AFTER => 'clearBehatContextSubscriber',
            ExampleTested::AFTER => 'clearBehatContextSubscriber',
        ];
    }

    /**
     * Clear contexts subscriber after each scenario/example
     */
    public function clearBehatContextSubscriber()
    {
        foreach ($this->registeredContextList as $context) {
            $this->behatEventDispatcher->removeSubscriber($context);
        }
        $this->registeredContextList = [];
    }
}