aik099\PHPUnit\Session\SharedSessionStrategy

Complexity

Total Complexity

17

Size/Duplication

Total Lines	157
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

97.62%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getSubscribedEvents()	0	7	1
A	setEventDispatcher()	0	4	1
A	session()	0	15	3
A	stopSession()	0	9	2
A	_switchToMainWindow()	0	4	1
A	onTestFailed()	0	10	3
A	onTestSuiteEnd()	0	12	4
A	_isEventForMe()	0	4	1

<?php
/**
 * This file is part of the phpunit-mink library.
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 *
 * @copyright Alexander Obuhovich <aik.bold@gmail.com>
 * @link      https://github.com/aik099/phpunit-mink
 */

namespace aik099\PHPUnit\Session;

Expected 2 blank line(-s) after namespace declaration; 1 found

use aik099\PHPUnit\BrowserConfiguration\BrowserConfiguration;
use aik099\PHPUnit\BrowserTestCase;
use aik099\PHPUnit\Event\TestEvent;
use aik099\PHPUnit\Event\TestFailedEvent;
use Behat\Mink\Session;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;

/**
 * Keeps a Session object shared between test runs to save time.
 *
 * @method \Mockery\Expectation shouldReceive(string $name)
 */
class SharedSessionStrategy implements ISessionStrategy
{

    /**
     * Original session strategy.
     *
     * @var ISessionStrategy
     */
    private $_originalStrategy;

    /**
     * Reference to created session.
     *
     * @var Session
     */
    private $_session;

    /**
     * Remembers if last test failed.
     *
     * @var boolean
     */
    private $_lastTestFailed = false;

    /**
     * Remembers original session strategy upon shared strategy creation.
     *
     * @param ISessionStrategy $original_strategy Original session strategy.
     */
    public function __construct(ISessionStrategy $original_strategy)
    {
        $this->_originalStrategy = $original_strategy;
    }

    /**
     * Returns an array of event names this subscriber wants to listen to.
     *
     * @return array The event names to listen to
     */
    public static function getSubscribedEvents()
    {
        return array(
            BrowserTestCase::TEST_FAILED_EVENT => array('onTestFailed', 0),
            BrowserTestCase::TEST_SUITE_ENDED_EVENT => array('onTestSuiteEnd', 0),
        );
    }

    /**
     * Sets event dispatcher.
     *
     * @param EventDispatcherInterface $event_dispatcher Event dispatcher.
     *
     * @return void
     */
    public function setEventDispatcher(EventDispatcherInterface $event_dispatcher)
    {
        $event_dispatcher->addSubscriber($this);
    }

    /**
     * Returns Mink session with given browser configuration.
     *
     * @param BrowserConfiguration $browser Browser configuration for a session.
     *
     * @return Session
     */
    public function session(BrowserConfiguration $browser)
    {
        if ($this->_lastTestFailed) {

Expected 1 spaces after "if" opening bracket; 0 found

Expected 1 spaces before "if" closing bracket; 0 found

            $this->stopSession();
            $this->_lastTestFailed = false;
        }

        if ($this->_session === null) {

Expected 1 spaces after "if" opening bracket; 0 found

Expected 1 spaces before "if" closing bracket; 0 found

            $this->_session = $this->_originalStrategy->session($browser);
        } else {

Beginning of the "else" control structure must be first content on the line

Expected "}\nelse \n"; found " else {\n"

            $this->_switchToMainWindow();
        }

        return $this->_session;
    }

    /**
     * Stops session.
     *
     * @return void
     */
    protected function stopSession()
    {
        if ($this->_session === null) {

Expected 1 spaces after "if" opening bracket; 0 found

Expected 1 spaces before "if" closing bracket; 0 found

            return;
        }

        $this->_session->stop();
        $this->_session = null;
    }

    /**
     * Switches to window, that was created upon session creation.
     *
     * @return void
     */
    private function _switchToMainWindow()
    {
        $this->_session->switchToWindow(null);
    }

    /**
     * Called, when test fails.
     *
     * @param TestFailedEvent $event Test failed event.
     *
     * @return void
     */
    public function onTestFailed(TestFailedEvent $event)
    {
        if ($event->getException() instanceof \PHPUnit_Framework_IncompleteTestError) {

Expected 1 spaces after "if" opening bracket; 0 found

Expected 1 spaces before "if" closing bracket; 0 found

            return;
        } elseif ($event->getException() instanceof \PHPUnit_Framework_SkippedTestError) {

Beginning of the "elseif" control structure must be first content on the line

Expected "}\nelseif (...) \n"; found " elseif (...) {\n"

Expected 1 spaces after "elseif" opening bracket; 0 found

Expected 1 spaces before "elseif" closing bracket; 0 found

            return;
        }

        $this->_lastTestFailed = true;
    }

    /**
     * Called, when test case ends.
     *
     * @param TestEvent $event Test event.
     *
     * @return void
     */
    public function onTestSuiteEnd(TestEvent $event)
    {
        if (!$this->_isEventForMe($event)) {

Expected 1 spaces after "if" opening bracket; 0 found

Expected 1 spaces before "if" closing bracket; 0 found

            return;
        }

        $session = $event->getSession();

        if ($session !== null && $session->isStarted()) {

Expected 1 spaces after "if" opening bracket; 0 found

Expected 1 spaces before "if" closing bracket; 0 found

            $session->stop();
        }
    }

    /**
     * Checks, that event can be handled by this class.
     *
     * @param TestEvent $event Test event.
     *
     * @return boolean
     */
    private function _isEventForMe(TestEvent $event)
    {
        return $event->getTestCase()->getSessionStrategy() instanceof self;
    }

Expected 1 blank line after function; 0 found

}