bump up to superbalist/php-pubsub ^2.0 & add new dispatchBatch method to EventManager

Author: matthewgoslett

README.md

@@ -37,7 +37,7 @@ $adapter = new \Superbalist\PubSub\Adapters\LocalPubSubAdapter();
 $translator = new \Superbalist\EventPubSub\Translators\SimpleEventMessageTranslator();
 $manager = new \Superbalist\EventPubSub\EventManager($adapter, $translator);
 
-// publish an event
+// dispatch an event
 $event = new \Superbalist\EventPubSub\Events\SimpleEvent(
     'user.created',
     [
@@ -51,6 +51,27 @@ $event = new \Superbalist\EventPubSub\Events\SimpleEvent(
 );
 $manager->dispatch('events', $event);
 
+// dispatch multiple events
+$events = [
+    new \Superbalist\EventPubSub\Events\SimpleEvent(
+        'user.created',
+        [
+            'user' => [
+                // ...
+            ],
+        ]
+    ),
+    new \Superbalist\EventPubSub\Events\SimpleEvent(
+        'user.created',
+        [
+            'user' => [
+                // ...
+            ],
+        ]
+    ),
+];
+$manager->dispatch('events', $events);
+
 // listen for an event
 $manager->listen('events', 'user.created', function (\Superbalist\EventPubSub\EventInterface $event) {
     var_dump($event->getName());
@@ -73,7 +94,7 @@ $adapter = new \Superbalist\PubSub\Adapters\LocalPubSubAdapter();
 $translator = new \Superbalist\EventPubSub\Translators\TopicEventMessageTranslator();
 $manager = new \Superbalist\EventPubSub\EventManager($adapter, $translator);
 
-// publish an event
+// dispatch an event
 $event = new \Superbalist\EventPubSub\Events\TopicEvent(
     'user',
     'created',
@@ -151,7 +172,7 @@ $validator = new \Superbalist\EventPubSub\Validators\JSONSchemaEventValidator($d
 
 $manager = new \Superbalist\EventPubSub\EventManager($adapter, $translator, $validator);
 
-// publish an event
+// dispatch an event
 $event = new \Superbalist\EventPubSub\Events\SchemaEvent(
     'http://schemas.my-website.org/events/user/created/1.0.json',
     [

changelog.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 3.0.0 - 2017-05-16
+
+* Bump up to superbalist/php-pubsub ^2.0
+* Add new dispatchBatch method to EventManager for dispatching multiple events at once
+
 ## 2.0.0 - 2017-02-01
 
 * Add `setAttribute` method to `EventInterface`

composer.json

@@ -10,7 +10,7 @@
   ],
   "require": {
     "php": ">=5.6.0",
-    "superbalist/php-pubsub": "^1.0",
+    "superbalist/php-pubsub": "^2.0",
     "composer/semver": "^1.4",
     "league/json-guard": "^0.5.1",
     "ramsey/uuid": "^3.5"

src/EventManager.php

@@ -139,12 +139,10 @@ protected function getValuesFromAttributeInjectors()
     }
 
     /**
-     * Dispatch an event.
-     *
-     * @param string $channel
      * @param EventInterface $event
+     * @return EventInterface
      */
-    public function dispatch($channel, EventInterface $event)
+    protected function prepEventForDispatch(EventInterface $event)
     {
         // automagically inject attributes from injectors
         $attributes = $this->getValuesFromAttributeInjectors();
@@ -154,7 +152,32 @@ public function dispatch($channel, EventInterface $event)
                 $e->setAttribute($k, $v);
             }
         }
+        return $e;
+    }
 
+    /**
+     * Dispatch an event.
+     *
+     * @param string $channel
+     * @param EventInterface $event
+     */
+    public function dispatch($channel, EventInterface $event)
+    {
+        $e = $this->prepEventForDispatch($event);
         $this->adapter->publish($channel, $e->toMessage());
     }
+
+    /**
+     * Dispatch multiple events.
+     *
+     * @param string $channel
+     * @param array $events
+     */
+    public function dispatchBatch($channel, array $events)
+    {
+        $messages = array_map(function (EventInterface $event) {
+            return $event->toMessage();
+        }, $events);
+        $this->adapter->publishBatch($channel, $messages);
+    }
 }

tests/EventManagerTest.php

@@ -155,4 +155,37 @@ public function testDispatchWithInjectionsDoNotOverrideExistingAttributes()
         $event = new SimpleEvent('user.created', ['user' => ['id' => 1234], 'date' => 'my_date']);
         $manager->dispatch('channel', $event);
     }
+
+    public function testDispatchBatch()
+    {
+        $adapter = Mockery::mock(PubSubAdapterInterface::class);
+        $adapter->shouldReceive('publishBatch')
+            ->withArgs([
+                'channel',
+                [
+                    [
+                        'event' => 'user.created',
+                        'user' => [
+                            'id' => 1234,
+                        ],
+                    ],
+                    [
+                        'event' => 'user.created',
+                        'user' => [
+                            'id' => 7812,
+                        ],
+                    ],
+                ]
+            ]);
+
+        $translator = Mockery::mock(MessageTranslatorInterface::class);
+
+        $manager = new EventManager($adapter, $translator);
+
+        $events = [
+            new SimpleEvent('user.created', ['user' => ['id' => 1234]]),
+            new SimpleEvent('user.created', ['user' => ['id' => 7812]]),
+        ];
+        $manager->dispatchBatch('channel', $events);
+    }
 }