Update for new symfony dispatcher

biig-io · Jul 5, 2019 · 29fcf77 · 29fcf77
1 parent 522982c
commit 29fcf77
Show file tree

Hide file tree

Showing 26 changed files with 136 additions and 110 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,15 +1,36 @@
 language: php
+
 php:
     - 7.1
     - 7.2
     - 7.3
 
+cache:
+    directories:
+        - $HOME/.composer/cache
+
+matrix:
+    include:
+        - php: 7.1
+          env: 'COMPOSER_FLAGS="--prefer-lowest --prefer-stable"'
+        - php: 7.1
+          env: 'COMPOSER_FLAGS="--prefer-stable"'
+        - php: 7.2
+          env: 'COMPOSER_FLAGS="--prefer-lowest --prefer-stable"'
+        - php: 7.2
+          env: 'COMPOSER_FLAGS="--prefer-stable"'
+        - php: 7.3
+          env: 'COMPOSER_FLAGS="--prefer-lowest --prefer-stable"'
+        - php: 7.3
+          env: 'COMPOSER_FLAGS="--prefer-stable"'
+
 branches:
     only:
         - master
+        - v1;
 
 install:
-    - composer install --prefer-source
+    - composer update --prefer-source $COMPOSER_FLAGS
 
 script:
     - ./vendor/bin/phpunit -c phpunit.xml.dist
diff --git a/Tests/Event/DelayedListenerTest.php b/Tests/Event/DelayedListenerTest.php
@@ -83,7 +83,7 @@ public function after()
                 return [\FakeModel::class => 'action'];
             }
 
-            public function execute(\Biig\Component\Domain\Event\DomainEvent $event)
+            public function execute(DomainEvent $event)
             {
                 $model = new \FakeModel();
                 $model->setFoo('RulePostPersist');
@@ -173,7 +173,7 @@ public function after()
         return [\FakeModel::class => 'action'];
     }
 
-    public function execute(\Biig\Component\Domain\Event\DomainEvent $event)
+    public function execute(DomainEvent $event)
     {
         // Count times of execution
         $event->getSubject()->setFoo($event->getSubject()->getFoo() + 1);

diff --git a/Tests/Event/DomainEventDispatcherTest.php b/Tests/Event/DomainEventDispatcherTest.php
@@ -41,7 +41,7 @@ public function on()
             public function setFoo($foo)
             {
                 $this->foo = $foo;
-                $this->dispatch('foo.changed', new DomainEvent($this));
+                $this->dispatch(new DomainEvent($this), 'foo.changed');
             }
 
             public function getFoo()
@@ -94,13 +94,13 @@ public function on()
             public function setFoo($foo)
             {
                 $this->foo = $foo;
-                $this->dispatch('foo.changed', new DomainEvent($this));
+                $this->dispatch(new DomainEvent($this), 'foo.changed');
             }
 
             public function setBar($bar)
             {
                 $this->bar = $bar;
-                $this->dispatch('bar.changed', new DomainEvent($this));
+                $this->dispatch(new DomainEvent($this), 'bar.changed');
             }
 
             public function getFoo()

diff --git a/Tests/Event/DomainEventTest.php b/Tests/Event/DomainEventTest.php
@@ -4,21 +4,19 @@
 
 use Biig\Component\Domain\Event\DomainEvent;
 use PHPUnit\Framework\TestCase;
-use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\GenericEvent;
 
 class DomainEventTest extends TestCase
 {
-    public function testItIsInstanceOfSymfonyEvent()
+    public function testItIsInstanceOfGenericEvent()
     {
         $event = new DomainEvent();
-        $this->assertInstanceOf(Event::class, $event);
+        $this->assertInstanceOf(GenericEvent::class, $event);
     }
 
     public function testItAcceptAnEventAsParameter()
     {
         $event = new DomainEvent(null, [], new GenericEvent());
-
         $this->assertInstanceOf(GenericEvent::class, $event->getOriginalEvent());
     }
 
@@ -30,4 +28,12 @@ public function testItReturnIfDelayedOrNot()
         $event->setDelayed();
         $this->assertTrue($event->isDelayed());
     }
+
+    /**
+     * @expectedException \Biig\Component\Domain\Exception\InvalidArgumentException
+     */
+    public function testItThrowsAnErrorIfOrignalEventIsNotAnEvent()
+    {
+        $event = new DomainEvent(null, [], 'foo');
+    }
 }
diff --git a/Tests/Model/Instantiator/DoctrineConfig/ClassMetadataFactoryTest.php b/Tests/Model/Instantiator/DoctrineConfig/ClassMetadataFactoryTest.php
@@ -5,6 +5,7 @@
 require_once __DIR__ . '/../../../fixtures/FakeModel.php';
 
 use Biig\Component\Domain\Event\DomainEventDispatcher;
+use Biig\Component\Domain\Event\DomainEventDispatcherInterface;
 use Biig\Component\Domain\Model\Instantiator\DoctrineConfig\ClassMetadata;
 use Biig\Component\Domain\Model\Instantiator\DoctrineConfig\ClassMetadataFactory;
 use Doctrine\ORM\EntityManager;
@@ -46,7 +47,7 @@ public function testItAllowToRetrieveDomainModel()
         $config = Setup::createYAMLMetadataConfiguration(array(__DIR__ . '/../../../fixtures/config'), true);
         $config->setClassMetadataFactoryName(ClassMetadataFactory::class);
 
-        $dispatcher = $this->prophesize(DomainEventDispatcher::class);
+        $dispatcher = $this->prophesize(DomainEventDispatcherInterface::class);
         $dispatcher->dispatch(Argument::cetera())->shouldBeCalled();
 
         $conn = [

diff --git a/Tests/PostPersistListener/DoctrinePostPersistListenerTest.php b/Tests/PostPersistListener/DoctrinePostPersistListenerTest.php
@@ -5,6 +5,7 @@
 require_once __DIR__ . '/../fixtures/FakeModel.php';
 
 use Biig\Component\Domain\Event\DomainEventDispatcher;
+use Biig\Component\Domain\Event\DomainEventDispatcherInterface;
 use Biig\Component\Domain\PostPersistListener\DoctrinePostPersistListener;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Event\OnFlushEventArgs;
@@ -18,7 +19,7 @@ public function testItCallPersistForEachFlushedModel()
     {
         $model = new \FakeModel();
 
-        $dispatcher = $this->prophesize(DomainEventDispatcher::class);
+        $dispatcher = $this->prophesize(DomainEventDispatcherInterface::class);
         $dispatcher->persistModel($model)->shouldBeCalled();
 
         $unitOfWork = $this->prophesize(UnitOfWork::class);

diff --git a/Tests/Symfony/DependencyInjection/EntityManagerConfiguratorTest.php b/Tests/Symfony/DependencyInjection/EntityManagerConfiguratorTest.php
@@ -14,13 +14,12 @@ class EntityManagerConfiguratorTest extends TestCase
     public function testItInsertsTheDispatcher()
     {
         $entityManager = $this->prophesize(EntityManager::class);
-        $dispatcher = $this->prophesize(DomainEventDispatcher::class)->reveal();
         $originalConfigurator = $this->prophesize(ManagerConfigurator::class)->reveal();
         $factory = new ClassMetadataFactory();
 
         $entityManager->getMetadataFactory()->willReturn($factory);
 
-        $configurator = new EntityManagerConfigurator($originalConfigurator, $dispatcher);
+        $configurator = new EntityManagerConfigurator($originalConfigurator, new DomainEventDispatcher());
         $configurator->configure($entityManager->reveal());
 
         $ref = new \ReflectionObject($factory);

diff --git a/Tests/Symfony/Serializer/DomainDenormalizerTest.php b/Tests/Symfony/Serializer/DomainDenormalizerTest.php
@@ -26,19 +26,19 @@ class DomainDenormalizerTest extends TestCase
     public function setUp()
     {
         $this->decorated = $this->prophesize(ObjectNormalizer::class);
-        $this->dispatcher = $this->prophesize(DomainEventDispatcher::class);
+        $this->dispatcher = new DomainEventDispatcher();
     }
 
     public function testItIsAnInstanceOfDenormalize()
     {
-        $denormalizer = new DomainDenormalizer($this->decorated->reveal(), $this->dispatcher->reveal());
+        $denormalizer = new DomainDenormalizer($this->decorated->reveal(), $this->dispatcher);
         $this->assertInstanceOf(DenormalizerInterface::class, $denormalizer);
     }
 
     public function testItDoesntSupportsDenormalization()
     {
         $this->decorated->supportsDenormalization(Argument::cetera())->willReturn(false);
-        $denormalizer = new DomainDenormalizer($this->decorated->reveal(), $this->dispatcher->reveal());
+        $denormalizer = new DomainDenormalizer($this->decorated->reveal(), $this->dispatcher);
 
         $this->assertFalse($denormalizer->supportsDenormalization([], \stdClass::class, []));
         $this->assertFalse($denormalizer->supportsDenormalization([], \FakeModel::class, []));
@@ -47,7 +47,7 @@ public function testItDoesntSupportsDenormalization()
     public function testItSupportsDenormalization()
     {
         $this->decorated->supportsDenormalization(Argument::cetera())->willReturn(true);
-        $denormalizer = new DomainDenormalizer($this->decorated->reveal(), $this->dispatcher->reveal());
+        $denormalizer = new DomainDenormalizer($this->decorated->reveal(), $this->dispatcher);
 
         $this->assertTrue($denormalizer->supportsDenormalization([], \stdClass::class, []));
         $this->assertTrue($denormalizer->supportsDenormalization([], \FakeModel::class, []));
@@ -58,9 +58,9 @@ public function testDenormalize()
         $fake = $this->prophesize(\FakeModel::class);
 
         $this->decorated->denormalize([], \FakeModel::class, null, [])->willReturn($fake)->shouldBeCalled();
-        $fake->setDispatcher($this->dispatcher->reveal())->shouldBeCalled();
+        $fake->setDispatcher($this->dispatcher)->shouldBeCalled();
 
-        $denormalizer = new DomainDenormalizer($this->decorated->reveal(), $this->dispatcher->reveal());
+        $denormalizer = new DomainDenormalizer($this->decorated->reveal(), $this->dispatcher);
         $denormalizer->denormalize([], \FakeModel::class, null, []);
     }
 }
diff --git a/Tests/fixtures/FakeModel.php b/Tests/fixtures/FakeModel.php
@@ -58,7 +58,7 @@ public function setFoo($foo)
      */
     public function doAction()
     {
-        $this->dispatch('previous_action',  new \Biig\Component\Domain\Event\DomainEvent($this));
-        $this->dispatch('action', new \Biig\Component\Domain\Event\DomainEvent($this));
+        $this->dispatch(new \Biig\Component\Domain\Event\DomainEvent($this), 'previous_action');
+        $this->dispatch(new \Biig\Component\Domain\Event\DomainEvent($this), 'action');
     }
 }
diff --git a/composer.json b/composer.json
@@ -4,7 +4,8 @@
     "license": "MIT",
     "require": {
         "php": ">=7.1",
-        "symfony/event-dispatcher": "~3.3|~4.0"
+        "symfony/event-dispatcher": "^4.3|^5.0",
+        "doctrine/orm": "^2.6.3"
     },
     "authors": [
         {
@@ -14,10 +15,13 @@
     ],
     "require-dev": {
         "phpunit/phpunit": "^6.4",
-        "doctrine/orm": "^2.5",
-        "symfony/symfony": "~3.3|~4.0",
+        "doctrine/orm": "^2.6.3",
         "friendsofphp/php-cs-fixer": "^2.14",
-        "doctrine/doctrine-bundle": "^1.8"
+        "doctrine/doctrine-bundle": "^1.8",
+        "symfony/symfony": "^4.3|^5.0"
+    },
+    "conflict": {
+        "doctrine/orm": "<2.6.3"
     },
     "autoload": {
         "psr-4": {

diff --git a/src/Event/DomainEvent.php b/src/Event/DomainEvent.php
@@ -2,13 +2,14 @@
 
 namespace Biig\Component\Domain\Event;
 
-use Symfony\Component\EventDispatcher\Event;
+use Biig\Component\Domain\Exception\InvalidArgumentException;
 use Symfony\Component\EventDispatcher\GenericEvent;
 
+
 class DomainEvent extends GenericEvent
 {
     /**
-     * @var Event
+     * @var \Symfony\Component\EventDispatcher\Event|\Symfony\Contracts\EventDispatcher\Event|null
      */
     private $originalEvent;
 
@@ -19,17 +20,26 @@ class DomainEvent extends GenericEvent
      */
     private $delayed;
 
-    public function __construct($subject = null, $arguments = [], Event $originalEvent = null)
+    public function __construct($subject = null, $arguments = [], /* Event */ $originalEvent = null)
     {
+        // BC layer for Symfony 4.3
+        if (!\is_null($originalEvent) &&
+            !((class_exists(\Symfony\Component\EventDispatcher\Event::class) && $originalEvent instanceof \Symfony\Component\EventDispatcher\Event)
+            || (class_exists(\Symfony\Contracts\EventDispatcher\Event::class) && $originalEvent instanceof \Symfony\Contracts\EventDispatcher\Event)
+            )
+        ) {
+            throw new InvalidArgumentException('The orignal event must be an instance of Symfony Events');
+        }
+
         parent::__construct($subject, $arguments);
         $this->originalEvent = $originalEvent;
         $this->delayed = false;
     }
 
     /**
-     * @return Event
+     * @return \Symfony\Component\EventDispatcher\Event|\Symfony\Contracts\EventDispatcher\Event|null
      */
-    public function getOriginalEvent(): ?Event
+    public function getOriginalEvent()
     {
         return $this->originalEvent;
     }

diff --git a/src/Event/DomainEventDispatcher.php b/src/Event/DomainEventDispatcher.php
@@ -7,10 +7,10 @@
 use Biig\Component\Domain\Rule\DomainRuleInterface;
 use Biig\Component\Domain\Rule\PostPersistDomainRuleInterface;
 use Biig\Component\Domain\Rule\RuleInterface;
-use Symfony\Component\EventDispatcher\Event;
+use Symfony\Contracts\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 
-class DomainEventDispatcher extends EventDispatcher
+final class DomainEventDispatcher extends EventDispatcher implements DomainEventDispatcherInterface
 {
     /**
      * @var DelayedListener[]
@@ -19,6 +19,7 @@ class DomainEventDispatcher extends EventDispatcher
 
     public function __construct()
     {
+        parent::__construct();
         $this->delayedListeners = [];
     }
 
@@ -79,14 +80,14 @@ public function addPostPersistDomainRuleInterface(PostPersistDomainRuleInterface
     }
 
     /**
-     * @param string     $eventName
      * @param Event|null $event
      *
      * @return Event
      */
-    public function dispatch($eventName, Event $event = null)
+    public function dispatch($event/*, string $eventName = null*/)
     {
-        $event = parent::dispatch($eventName, $event);
+        $eventName = 1 < \func_num_args() ? \func_get_arg(1) : null;
+        $event = parent::dispatch($event, $eventName);
 
         if ($event instanceof DomainEvent) {
             foreach ($this->delayedListeners as $listener) {
@@ -104,6 +105,7 @@ public function dispatch($eventName, Event $event = null)
      */
     public function persistModel(ModelInterface $model)
     {
+
         foreach ($this->delayedListeners as $listener) {
             if ($listener->shouldOccur($model)) {
                 $listener->process($model);

diff --git a/src/Event/DomainEventDispatcherInterface.php b/src/Event/DomainEventDispatcherInterface.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace Biig\Component\Domain\Event;
+
+use Biig\Component\Domain\Model\ModelInterface;
+use Biig\Component\Domain\Rule\DomainRuleInterface;
+use Biig\Component\Domain\Rule\PostPersistDomainRuleInterface;
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
+
+interface DomainEventDispatcherInterface extends EventDispatcherInterface
+{
+    public function addDomainRule(DomainRuleInterface $rule);
+    public function addPostPersistDomainRuleInterface(PostPersistDomainRuleInterface $rule);
+    public function persistModel(ModelInterface $model);
+}
diff --git a/src/Integration/Symfony/DependencyInjection/Configuration.php b/src/Integration/Symfony/DependencyInjection/Configuration.php
@@ -11,14 +11,8 @@ public function getConfigTreeBuilder()
     {
         $treeBuilder = new TreeBuilder('biig_domain');
 
-        if (method_exists($treeBuilder, 'getRootNode')) {
-            $rootNode = $treeBuilder->getRootNode();
-        } else {
-            // BC for symfony/config < 4.2
-            $rootNode = $treeBuilder->root('biig_domain');
-        }
-
-        $rootNode
+        $treeBuilder
+            ->getRootNode()
             ->children()
                 ->booleanNode('override_doctrine_instantiator')
                     ->defaultTrue()

diff --git a/src/Integration/Symfony/DependencyInjection/EntityManagerConfigurator.php b/src/Integration/Symfony/DependencyInjection/EntityManagerConfigurator.php
@@ -2,7 +2,7 @@
 
 namespace Biig\Component\Domain\Integration\Symfony\DependencyInjection;
 
-use Biig\Component\Domain\Event\DomainEventDispatcher;
+use Biig\Component\Domain\Event\DomainEventDispatcherInterface;
 use Biig\Component\Domain\Model\Instantiator\DoctrineConfig\ClassMetadataFactory;
 use Doctrine\Bundle\DoctrineBundle\ManagerConfigurator;
 use Doctrine\ORM\EntityManager;
@@ -18,11 +18,11 @@ class EntityManagerConfigurator
     private $originalConfigurator;
 
     /**
-     * @var DomainEventDispatcher
+     * @var DomainEventDispatcherInterface
      */
     private $dispatcher;
 
-    public function __construct(ManagerConfigurator $configurator, DomainEventDispatcher $dispatcher)
+    public function __construct(ManagerConfigurator $configurator, DomainEventDispatcherInterface $dispatcher)
     {
         $this->originalConfigurator = $configurator;
         $this->dispatcher = $dispatcher;