DispatcherTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extbase\Tests\Unit\SignalSlot;

class DispatcherTest extends \TYPO3\CMS\Core\Tests\UnitTestCase {

    protected $signalSlotDispatcher;

    public function setUp() {
        $accessibleClassName = $this->getAccessibleMock('TYPO3\\CMS\\Extbase\\SignalSlot\\Dispatcher', array('dummy'));
        $this->signalSlotDispatcher = new $accessibleClassName();
    }

    public function connectAllowsForConnectingASlotWithASignal() {
        $mockSignal = $this->getMock('ClassA', array('emitSomeSignal'));
        $mockSlot = $this->getMock('ClassB', array('someSlotMethod'));
        $this->signalSlotDispatcher->connect(get_class($mockSignal), 'emitSomeSignal', get_class($mockSlot), 'someSlotMethod', TRUE);
        $expectedSlots = array(
            array('class' => get_class($mockSlot), 'method' => 'someSlotMethod', 'object' => NULL, 'passSignalInformation' => TRUE)
        );
        $this->assertSame($expectedSlots, $this->signalSlotDispatcher->getSlots(get_class($mockSignal), 'emitSomeSignal'));
    }

    public function connectAlsoAcceptsObjectsInPlaceOfTheClassName() {
        $mockSignal = $this->getMock('ClassA', array('emitSomeSignal'));
        $mockSlot = $this->getMock('ClassB', array('someSlotMethod'));
        $this->signalSlotDispatcher->connect(get_class($mockSignal), 'emitSomeSignal', $mockSlot, 'someSlotMethod', TRUE);
        $expectedSlots = array(
            array('class' => NULL, 'method' => 'someSlotMethod', 'object' => $mockSlot, 'passSignalInformation' => TRUE)
        );
        $this->assertSame($expectedSlots, $this->signalSlotDispatcher->getSlots(get_class($mockSignal), 'emitSomeSignal'));
    }

    public function connectAlsoAcceptsClosuresActingAsASlot() {
        $mockSignal = $this->getMock('ClassA', array('emitSomeSignal'));
        $mockSlot = function () {
        };
        $this->signalSlotDispatcher->connect(get_class($mockSignal), 'emitSomeSignal', $mockSlot, 'foo', TRUE);
        $expectedSlots = array(
            array('class' => NULL, 'method' => '__invoke', 'object' => $mockSlot, 'passSignalInformation' => TRUE)
        );
        $this->assertSame($expectedSlots, $this->signalSlotDispatcher->getSlots(get_class($mockSignal), 'emitSomeSignal'));
    }

    public function dispatchPassesTheSignalArgumentsToTheSlotMethod() {
        $arguments = array();
        $mockSlot = function () use (&$arguments) {
            ($arguments = func_get_args());
        };
        $this->signalSlotDispatcher->connect('Foo', 'bar', $mockSlot, NULL, FALSE);
        $this->signalSlotDispatcher->dispatch('Foo', 'bar', array('bar', 'quux'));
        $this->assertSame(array('bar', 'quux'), $arguments);
    }

    public function dispatchRetrievesSlotInstanceFromTheObjectManagerIfOnlyAClassNameWasSpecified() {
        $slotClassName = $this->getUniqueId('Mock_');
        eval('class ' . $slotClassName . ' { function slot($foo, $baz) { $this->arguments = array($foo, $baz); } }');
        $mockSlot = new $slotClassName();
        $mockObjectManager = $this->getMock('TYPO3\\CMS\\Extbase\\Object\\ObjectManagerInterface');
        $mockObjectManager->expects($this->once())->method('isRegistered')->with($slotClassName)->will($this->returnValue(TRUE));
        $mockObjectManager->expects($this->once())->method('get')->with($slotClassName)->will($this->returnValue($mockSlot));
        $this->signalSlotDispatcher->_set('objectManager', $mockObjectManager);
        $this->signalSlotDispatcher->_set('isInitialized', TRUE);
        $this->signalSlotDispatcher->connect('Foo', 'emitBar', $slotClassName, 'slot', FALSE);
        $this->signalSlotDispatcher->dispatch('Foo', 'emitBar', array('bar', 'quux'));
        $this->assertSame($mockSlot->arguments, array('bar', 'quux'));
    }

    public function dispatchHandsOverArgumentsReturnedByAFormerSlot() {
        $this->signalSlotDispatcher->_set('isInitialized', TRUE);

        $firstMockSlot = $this->getMock('TYPO3\\CMS\\Extbase\\Tests\\Fixture\\SlotFixture');
        $firstMockSlot->expects($this->once())
            ->method('slot')
            ->will($this->returnCallback(
                        function($foo, $baz) {
                            return array('modified_' . $foo, 'modified_' . $baz);}
                    ));

        $secondMockSlot = $this->getMock('TYPO3\\CMS\\Extbase\\Tests\\Fixture\\SlotFixture');
        $secondMockSlot->expects($this->once())
            ->method('slot')
            ->with('modified_bar', 'modified_quux');


        $this->signalSlotDispatcher->connect('Foo', 'emitBar', $firstMockSlot, 'slot', FALSE);
        $this->signalSlotDispatcher->connect('Foo', 'emitBar', $secondMockSlot, 'slot', FALSE);

        $this->signalSlotDispatcher->dispatch('Foo', 'emitBar', array('bar', 'quux'));
    }

    public function dispatchHandsOverArgumentsReturnedByAFormerSlotWithoutInterferingWithSignalSlotInformation() {
        $this->signalSlotDispatcher->_set('isInitialized', TRUE);

        $firstMockSlot = $this->getMock('TYPO3\\CMS\\Extbase\\Tests\\Fixture\\SlotFixture');
        $firstMockSlot->expects($this->once())
            ->method('slot')
            ->will($this->returnCallback(
                        function($foo, $baz) {
                            return array('modified_' . $foo, 'modified_' . $baz);}
                    ));

        $secondMockSlot = $this->getMock('TYPO3\\CMS\\Extbase\\Tests\\Fixture\\SlotFixture');
        $secondMockSlot->expects($this->once())
            ->method('slot')
            ->with('modified_bar', 'modified_quux');

        $this->signalSlotDispatcher->connect('Foo', 'emitBar', $firstMockSlot, 'slot');
        $this->signalSlotDispatcher->connect('Foo', 'emitBar', $secondMockSlot, 'slot');

        $this->signalSlotDispatcher->dispatch('Foo', 'emitBar', array('bar', 'quux'));
    }

    public function dispatchHandsOverFormerArgumentsIfPreviousSlotDoesNotReturnAnything() {
        $this->signalSlotDispatcher->_set('isInitialized', TRUE);

        $firstMockSlot = $this->getMock('TYPO3\\CMS\\Extbase\\Tests\\Fixture\\SlotFixture');
        $firstMockSlot->expects($this->once())
            ->method('slot')
            ->will($this->returnCallback(
                        function($foo, $baz) {
                            return array('modified_' . $foo, 'modified_' . $baz);}
                    ));

        $secondMockSlot = $this->getMock('TYPO3\\CMS\\Extbase\\Tests\\Fixture\\SlotFixture');
        $secondMockSlot->expects($this->once())
            ->method('slot');

        $thirdMockSlot = $this->getMock('TYPO3\\CMS\\Extbase\\Tests\\Fixture\\SlotFixture');
        $thirdMockSlot->expects($this->once())
            ->method('slot')
            ->with('modified_bar', 'modified_quux');


        $this->signalSlotDispatcher->connect('Foo', 'emitBar', $firstMockSlot, 'slot');
        $this->signalSlotDispatcher->connect('Foo', 'emitBar', $secondMockSlot, 'slot');
        $this->signalSlotDispatcher->connect('Foo', 'emitBar', $thirdMockSlot, 'slot');

        $this->signalSlotDispatcher->dispatch('Foo', 'emitBar', array('bar', 'quux'));
    }

    public function dispatchThrowsAnExceptionIfTheSlotReturnsNonArray() {
        $this->signalSlotDispatcher->_set('isInitialized', TRUE);

        $mockSlot = $this->getMock('TYPO3\\CMS\\Extbase\\Tests\\Fixture\\SlotFixture');
        $mockSlot->expects($this->once())
            ->method('slot')
            ->will($this->returnCallback(
                        function() {
                            return 'string';}
                    ));

        $this->signalSlotDispatcher->connect('Foo', 'emitBar', $mockSlot, 'slot', FALSE);
        $this->signalSlotDispatcher->dispatch('Foo', 'emitBar', array('bar', 'quux'));
    }

    public function dispatchThrowsAnExceptionIfTheSlotReturnsDifferentNumberOfItems() {
        $this->signalSlotDispatcher->_set('isInitialized', TRUE);

        $mockSlot = $this->getMock('TYPO3\\CMS\\Extbase\\Tests\\Fixture\\SlotFixture');
        $mockSlot->expects($this->once())
            ->method('slot')
            ->will($this->returnCallback(
                        function() {
                            return array(1, 2, 3);}
                    ));

        $this->signalSlotDispatcher->connect('Foo', 'emitBar', $mockSlot, 'slot', FALSE);
        $this->signalSlotDispatcher->dispatch('Foo', 'emitBar', array('bar', 'quux'));
    }

    public function dispatchThrowsAnExceptionIfTheSpecifiedClassOfASlotIsUnknown() {
        $mockObjectManager = $this->getMock('TYPO3\\CMS\\Extbase\\Object\\ObjectManagerInterface');
        $mockObjectManager->expects($this->once())->method('isRegistered')->with('NonExistingClassName')->will($this->returnValue(FALSE));
        $this->signalSlotDispatcher->_set('objectManager', $mockObjectManager);
        $this->signalSlotDispatcher->_set('isInitialized', TRUE);
        $this->signalSlotDispatcher->connect('Foo', 'emitBar', 'NonExistingClassName', 'slot', TRUE);
        $this->signalSlotDispatcher->dispatch('Foo', 'emitBar', array());
    }

    public function dispatchThrowsAnExceptionIfTheSpecifiedSlotMethodDoesNotExist() {
        $slotClassName = $this->getUniqueId('Mock_');
        eval('class ' . $slotClassName . ' { function slot($foo, $baz) { $this->arguments = array($foo, $baz); } }');
        $mockSlot = new $slotClassName();
        $mockObjectManager = $this->getMock('TYPO3\\CMS\\Extbase\\Object\\ObjectManagerInterface');
        $mockObjectManager->expects($this->once())->method('isRegistered')->with($slotClassName)->will($this->returnValue(TRUE));
        $mockObjectManager->expects($this->once())->method('get')->with($slotClassName)->will($this->returnValue($mockSlot));
        $this->signalSlotDispatcher->_set('objectManager', $mockObjectManager);
        $this->signalSlotDispatcher->_set('isInitialized', TRUE);
        $this->signalSlotDispatcher->connect('Foo', 'emitBar', $slotClassName, 'unknownMethodName', TRUE);
        $this->signalSlotDispatcher->dispatch('Foo', 'emitBar', array('bar', 'quux'));
        $this->assertSame($mockSlot->arguments, array('bar', 'quux'));
    }

    public function dispatchPassesFirstArgumentContainingSlotInformationIfTheConnectionStatesSo() {
        $arguments = array();
        $mockSlot = function () use (&$arguments) {
            ($arguments = func_get_args());
        };
        $mockObjectManager = $this->getMock('TYPO3\\CMS\\Extbase\\Object\\ObjectManagerInterface');
        $this->signalSlotDispatcher->connect('SignalClassName', 'methodName', $mockSlot, NULL, TRUE);
        $this->signalSlotDispatcher->_set('objectManager', $mockObjectManager);
        $this->signalSlotDispatcher->_set('isInitialized', TRUE);
        $this->signalSlotDispatcher->dispatch('SignalClassName', 'methodName', array('bar', 'quux'));
        $this->assertSame(array('bar', 'quux', 'SignalClassName::methodName'), $arguments);
    }

    public function connectThrowsInvalidArgumentExceptionIfSlotMethodNameIsEmptyAndSlotClassNameIsNoClosure() {
        $this->signalSlotDispatcher->connect('ClassA', 'emitSomeSignal', 'ClassB', '');
    }

    public function dispatchReturnsEmptyArrayIfSignalNameAndOrSignalClassNameIsNotRegistered() {
        $this->assertSame(array(), $this->signalSlotDispatcher->dispatch('ClassA', 'someNotRegisteredSignalName'));
    }

    public function dispatchReturnsEmptyArrayIfSignalDoesNotProvideAnyArguments() {
        $this->assertSame(array(), $this->signalSlotDispatcher->dispatch('ClassA', 'emitSomeSignal'));
    }

    public function dispatchReturnsArgumentsArrayAsIsIfSignalIsNotRegistered() {
        $arguments = array(
            42,
            'a string',
            new \stdClass()
        );
        $this->assertSame($arguments, $this->signalSlotDispatcher->dispatch('ClassA', 'emitSomeSignal', $arguments));
    }

    public function dispatchThrowsInvalidSlotExceptionIfObjectManagerOfSignalSlotDispatcherIsNotSet() {
        $this->signalSlotDispatcher->_set('isInitialized', TRUE);
        $this->signalSlotDispatcher->_set('objectManager', NULL);
        $this->signalSlotDispatcher->_set('slots', array('ClassA' => array('emitSomeSignal' => array(array()))));

        $this->assertSame(NULL, $this->signalSlotDispatcher->dispatch('ClassA', 'emitSomeSignal'));
    }
}