Merge branch 'hotfix/10' into develop

Forward port #10

Author: weierophinney

.gitattributes

@@ -1,3 +1,4 @@
+/benchmarks export-ignore
 /test export-ignore
 /vendor export-ignore
 .coveralls.yml export-ignore

CHANGELOG.md

@@ -82,33 +82,49 @@ All notable changes to this project will be documented in this file, in reverse
 
 - `FilterIterator::insert()` has been modified to raise an exception if the value provided is not a callable.
 
-## 2.6.0 - TBD
+## 2.6.0 - 2015-09-29
 
 ### Added
 
-- Nothing.
+- Added `Zend\EventManager\SharedEventsCapableInterface`. This interface will
+  largely replace `Zend\EventManager\SharedEventManagerAwareInterface` in
+  version 3, and the latter was updated to extend it.
+- Added `EventManager::triggerEvent(EventInterface $event)` as a
+  forwards-compatibility feature.
+- Add `EventManager::triggerEventUntil(callable $callback, EventIterface $event)`
+  as a forwards-compatibility feature.
+- Adds [Athletic](https://github.com/polyfractal/athletic) benchmarks to aid in
+  gauging performanc impact of changes; these are a development change only.
 
 ### Deprecated
 
-- Nothing.
-
-### Removed
-
-- Nothing.
-
-### Fixed
-
-- Nothing.
-
-## 2.5.3 - TBD
-
-### Added
-
-- Nothing.
-
-### Deprecated
-
-- Nothing.
+- Marked `GlobalEventManager` as deprecated; this class will be removed in
+  version 3.
+- Marked `StaticEventManager` as deprecated; this class will be removed in
+  version 3.
+- Marked `SharedListenerAggregateInterface` as deprecated; this interface will
+  be removed in version 3.
+- Marked `SharedEventAggregateAwareInterface` as deprecated; this interface will
+  be removed in version 3.
+- Marked `SharedEventManagerAwareInterface` as deprecated; this interface will
+  be removed in version 3.
+- Marked `EventManager::setSharedManager()` as deprecated; this method will be
+  removed in version 3.
+- Marked `EventManager::unsetSharedManager()` as deprecated; this method will be
+  removed in version 3.
+- Marked `EventManagerInterface::` and `EventManager::getEvents()` as
+  deprecated; this method will be removed in version 3.
+- Marked `EventManagerInterface::` and `EventManager::getListeners()` as
+  deprecated; this method will be removed in version 3.
+- Marked `EventManagerInterface::` and `Eventmanager::setEventClass()` as
+  deprecated; this method is renamed to `setEventPrototype(EventInterface $event)`
+  in version 3.
+- Marked `EventManagerInterface::` and `EventManager::attachAggregate()` as
+  deprecated; this method will be removed in version 3.
+- Marked `EventManagerInterface::` and `EventManager::detachAggregate()` as
+  deprecated; this method will be removed in version 3.
+- Marked `SharedEventManagerInterface::` and `SharedEventManager::getEvents()`
+  as deprecated; this method will be removed in version 3.
 
 ### Removed
 

composer.json

@@ -13,7 +13,7 @@
     "prefer-stable": true,
     "extra": {
         "branch-alias": {
-            "dev-master": "2.5-dev",
+            "dev-master": "2.6-dev",
             "dev-develop": "3.0-dev"
         }
     },

test/EventManagerTest.php

@@ -182,6 +182,7 @@ public function testTriggerUntilShouldMarkResponseCollectionStoppedWhenCondition
         $this->events->attach('foo.bar', function () { return 'found'; }, 2);
         $this->events->attach('foo.bar', function () { return 'zero'; }, 1);
         // @codingStandardsIgnoreEnd
+
         $responses = $this->events->triggerUntil(function ($result) {
             return ($result === 'found');
         }, 'foo.bar', $this);
@@ -200,6 +201,7 @@ public function testTriggerUntilShouldMarkResponseCollectionStoppedWhenCondition
         $this->events->attach('foo.bar', function () { return 'zero'; });
         $this->events->attach('foo.bar', function () { return 'found'; });
         // @codingStandardsIgnoreEnd
+
         $responses = $this->events->triggerUntil(function ($result) {
             return ($result === 'found');
         }, 'foo.bar', $this);
@@ -216,6 +218,7 @@ public function testResponseCollectionIsNotStoppedWhenNoCallbackMatchedByTrigger
         $this->events->attach('foo.bar', function () { return 'found'; }, 2);
         $this->events->attach('foo.bar', function () { return 'zero'; }, 1);
         // @codingStandardsIgnoreEnd
+
         $responses = $this->events->triggerUntil(function ($result) {
             return ($result === 'never found');
         }, 'foo.bar', $this);
@@ -232,6 +235,7 @@ public function testCallingEventsStopPropagationMethodHaltsEventEmission()
         $this->events->attach('foo.bar', function ($e) { return 'found'; }, 2);
         $this->events->attach('foo.bar', function ($e) { return 'zero'; }, 1);
         // @codingStandardsIgnoreEnd
+
         $responses = $this->events->trigger('foo.bar');
         $this->assertInstanceOf('Zend\EventManager\ResponseCollection', $responses);
         $this->assertTrue($responses->stopped());
@@ -252,6 +256,7 @@ public function testCanAlterParametersWithinAEvent()
             $bar = $e->getParam('bar', '__NO_BAR__');
             return $foo . ":" . $bar;
         });
+
         $responses = $this->events->trigger('foo.bar');
         $this->assertEquals('bar:baz', $responses->last());
     }
@@ -260,10 +265,12 @@ public function testParametersArePassedToEventByReference()
     {
         $params = [ 'foo' => 'bar', 'bar' => 'baz'];
         $args   = $this->events->prepareArgs($params);
+
         // @codingStandardsIgnoreStart
         $this->events->attach('foo.bar', function ($e) { $e->setParam('foo', 'FOO'); });
         $this->events->attach('foo.bar', function ($e) { $e->setParam('bar', 'BAR'); });
         // @codingStandardsIgnoreEnd
+
         $responses = $this->events->trigger('foo.bar', $this, $args);
         $this->assertEquals('FOO', $args['foo']);
         $this->assertEquals('BAR', $args['bar']);
@@ -276,6 +283,7 @@ public function testCanPassObjectForEventParameters()
         $this->events->attach('foo.bar', function ($e) { $e->setParam('foo', 'FOO'); });
         $this->events->attach('foo.bar', function ($e) { $e->setParam('bar', 'BAR'); });
         // @codingStandardsIgnoreEnd
+
         $responses = $this->events->trigger('foo.bar', $this, $params);
         $this->assertEquals('FOO', $params->foo);
         $this->assertEquals('BAR', $params->bar);
@@ -744,4 +752,54 @@ public function testTriggeringAnEventWithAnEmptyNameRaisesAnException($event, $m
             $this->events->$method($event);
         }
     }
+
+    public function testTriggerEventAcceptsEventInstanceAndTriggersListeners()
+    {
+        $event = $this->prophesize(EventInterface::class);
+        $event->getName()->willReturn('test');
+        $event->stopPropagation(false)->shouldBeCalled();
+        $event->propagationIsStopped()->willReturn(false);
+
+        $triggered = false;
+        $this->events->attach('test', function ($e) use ($event, &$triggered) {
+            $this->assertSame($event->reveal(), $e);
+            $triggered = true;
+        });
+
+        $this->events->triggerEvent($event->reveal());
+        $this->assertTrue($triggered, 'Listener for event was not triggered');
+    }
+
+    public function testTriggerEventUntilAcceptsEventInstanceAndTriggersListenersUntilCallbackEvaluatesTrue()
+    {
+        $event = $this->prophesize(EventInterface::class);
+        $event->getName()->willReturn('test');
+        $event->stopPropagation(false)->shouldBeCalled();
+        $event->propagationIsStopped()->willReturn(false);
+
+        $callback = function ($result) {
+            return ($result === true);
+        };
+
+        $triggeredOne = false;
+        $this->events->attach('test', function ($e) use ($event, &$triggeredOne) {
+            $this->assertSame($event->reveal(), $e);
+            $triggeredOne = true;
+        });
+
+        $triggeredTwo = false;
+        $this->events->attach('test', function ($e) use ($event, &$triggeredTwo) {
+            $this->assertSame($event->reveal(), $e);
+            $triggeredTwo = true;
+            return true;
+        });
+
+        $this->events->attach('test', function ($e) {
+            $this->fail('Third listener was triggered and should not have been');
+        });
+
+        $this->events->triggerEventUntil($callback, $event->reveal());
+        $this->assertTrue($triggeredOne, 'First Listener for event was not triggered');
+        $this->assertTrue($triggeredTwo, 'First Listener for event was not triggered');
+    }
 }