Merge branch 'feature/sem-refactor' into develop

Close #4

Author: weierophinney

.gitignore

@@ -12,4 +12,5 @@ clover.xml
 composer.lock
 coveralls-upload.json
 phpunit.xml
-vendor
+doc/html/
+vendor/

.php_cs

@@ -17,6 +17,7 @@ matrix:
     - php: 5.5
       env:
         - EXECUTE_CS_CHECK=true
+        - EXECUTE_DOC_CHECK=true
     - php: 5.6
       env:
         - EXECUTE_TEST_COVERALLS=true
@@ -33,15 +34,21 @@ notifications:
 before_install:
   - if [[ $EXECUTE_TEST_COVERALLS != 'true' ]]; then phpenv config-rm xdebug.ini || return 0 ; fi
   - composer self-update
+  - if [[ $EXECUTE_DOC_CHECK == 'true' ]]; then composer require --dev --no-update phly/bookdown2mkdocs ; fi
   - if [[ $EXECUTE_TEST_COVERALLS == 'true' ]]; then composer require --dev --no-update satooshi/php-coveralls ; fi
 
 install:
-  - travis_retry composer install --no-interaction --ignore-platform-reqs
+  - travis_retry composer install --no-interaction --ignore-platform-reqs --prefer-source
+  - composer info -i
+
+before_script:
+  - if [[ $EXECUTE_DOC_CHECK == 'true' ]]; then cp mkdocs.yml mkdocs.yml.orig ; fi
 
 script:
   - if [[ $EXECUTE_TEST_COVERALLS == 'true' ]]; then ./vendor/bin/phpunit --coverage-clover clover.xml ; fi
   - if [[ $EXECUTE_TEST_COVERALLS != 'true' ]]; then ./vendor/bin/phpunit ; fi
-  - if [[ $EXECUTE_CS_CHECK == 'true' ]]; then ./vendor/bin/php-cs-fixer fix -v --diff --dry-run ; fi
+  - if [[ $EXECUTE_CS_CHECK == 'true' ]]; then ./vendor/bin/phpcs ; fi
+  - if [[ $EXECUTE_DOC_CHECK == 'true' ]]; then make mkdocs ; diff mkdocs.yml mkdocs.yml.orig ; return $? ; fi
 
 after_script:
   - if [[ $EXECUTE_TEST_COVERALLS == 'true' ]]; then ./vendor/bin/coveralls ; fi

.travis.yml

@@ -2,6 +2,86 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
+## 3.0.0 - TBD
+
+### Added
+
+- [Migration documentation](doc/book/migration/) was added.
+- [Automated benchmarks](benchmarks/) were added.
+- `EventManager::__construct()` now accepts an optional
+  `SharedEventManagerInterface` instance as the first argument, and an optional
+  array of identifiers as the second. As identifiers have no meaning without a
+  shared manager present, they are secondary to providing the shared manager.
+- `EventManagerInterface::trigger()` changes its signature to
+  `trigger($eventName, $target = null, $argv = [])`; each argument has exactly
+  one possible meaning; the `$eventName` can only be a string event name. The
+  fourth `$callback` argument is removed.
+- `EventManagerInterface::triggerUntil()` changes its signature to
+  `triggerUntil(callable $callback, $eventName, $target = null, $argv = null)`.
+  Each argument has exactly one meaning.
+- `EventManagerInterface` adds two new methods for triggering provided
+  `EventInterface` arguments: `triggerEvent(EventInterface $event)` and
+  `triggerEventUntil(callable $callback, EventInterface $event)`.
+- `EventManagerInterface::attach()` and `detach()` change their signatures to
+  `attach($eventName, callable $listener, $priority = 1)` and `detach(callable
+  $listener, $eventName = null)`, respectively. Note that `$eventName` can now
+  only be a string event name, not an array or `Traversable`.
+- `EventManagerInterface::setIdentifiers()` and `addIdentifiers()` change their
+  signatures to each only accept an *array* of identifiers.
+- `SharedEventManagerInterface::getListeners()` changes signature to
+  `getListeners(array $identifiers, $eventName)` and now guarantees return of an
+  array. Note that the second argument is now *required*.
+- `SharedEventManagerInterface::attach()` changes signature to
+  `attach($identifier, $eventName, callable $listener, $priority = 1)`. The
+  `$identifier` and `$eventName` **must** be strings.
+- `SharedEventManagerInterface::detach()` changes signature to `detach(callable
+  $listener, $identifier = null, $eventName = null)`; `$identifier` and
+  `$eventName` **must** be strings if passed.
+- `ListenerAggregateInterface::attach()` adds an optional `$priority = 1`
+  argument. This was used already in v2, but not dictated by the interface.
+- `FilterInterface::attach()` and `detach()` have changed signature to
+  `attach(callable $callback)` and `detach(callable $ilter)`, respectively.
+- `LazyListener` allows wrapping:
+  - fetching a listener service from a container-interop container, and
+  - invoking a designated listener method with the provided event.
+- `LazyEventListener` extends `LazyListener`, and provides metadata for
+  discovering the intended event name and priority at which to attach the lazy
+  listener; these are consumed by:
+- `LazyListenerAggregate`, which, provided a list of `LazyEventListeners` and/or
+  definitions to use to create them, acts as an aggregate for attaching a number
+  of such listeners at once.
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- `GlobalEventManager` and `StaticEventManager` are removed (with prejudice!).
+- `ProvidesEvents`, which was previously deprecated, is removed.
+- `EventManagerInterface::setSharedManager()` is removed. Shared managers are
+  now expected to be injected during instantiation.
+- `EventManagerInterface::getEvents()` and `getListeners()` are removed; they
+  had now purpose within the implementation.
+- `EventManagerInterface::setEventClass()` was renamed to `setEventPrototype()`,
+  which now expects an `EventInterface` instance. That instance will be cloned
+  whenever a new event is created.
+- `EventManagerInterface::attachAggregate()` and `detachAggregate()` are
+  removed. Users should use the `attach()` and `detach()` methods of the
+  aggregates themselves.
+- `SharedEventAggregateAwareInterface` and `SharedListenerAggregateInterface`
+  are removed. This was an undocumented and largely unused feature.
+- `SharedEventManagerAwareInterface` is removed. A new interface,
+  `SharedEventsCapableInterface` defines the `getSharedManager()` method from
+  the interface, and `EventManagerInterface` extends that new interface.
+- `SharedEventManagerInterface::getEvents()` is removed, as it had no purpose in
+  the implementation.
+- `ResponseCollection::setStopped()` no longer implements a fluent interface.
+
+### Fixed
+
+- `FilterIterator::insert()` has been modified to raise an exception if the value provided is not a callable.
+
 ## 2.6.0 - TBD
 
 ### Added

CHANGELOG.md

@@ -0,0 +1,23 @@
+# zend-eventmanager Makefile
+#
+# Primary purpose is for generating the mkdocs.yml from the bookdown.json
+# sources.
+#
+# Configurable variables:
+# - BOOKDOWN2MKDOCS - specify the path to the executable; defaults to
+#   				  ./vendor/bin/bookdown2mkdocs
+#
+# Available targets:
+# - mkdocs   - regenerate mkdocs.yml
+# - all      - synonym for mkdocs target
+
+BOOKDOWN2MKDOCS?=$(CURDIR)/vendor/bin/bookdown2mkdocs.php
+
+.PHONY : all mkdocs bookdown2mkdocs
+
+all : mkdocs
+
+mkdocs : 
+	@echo "Generating mkdocs.yml from bookdown.json..."
+	-$(BOOKDOWN2MKDOCS) convert --site-name=zend-eventmanager --repo-url=https://github.com/zendframework/zend-eventmanager --copyright-url=http://www.zend.com/ --copyright-author="Zend Technologies USA Inc."
+	@echo "[DONE] Generating mkdocs.yml from bookdown.json"

Makefile

@@ -23,9 +23,7 @@ public function setUp()
         foreach ($this->getEventList() as $event) {
             $this->sharedEvents->attach($identifiers[0], $event, $this->generateCallback());
         }
-        $this->events = new EventManager();
-        $this->events->setSharedManager($this->sharedEvents);
-        $this->events->setIdentifiers([$identifiers[0]]);
+        $this->events = new EventManager($this->sharedEvents, [$identifiers[0]]);
 
         $this->eventsToTrigger = array_filter($this->getEventList(), function ($value) {
             return ($value !== '*');

benchmarks/MultipleEventIndividualSharedListener.php

@@ -25,9 +25,7 @@ public function setUp()
                 $this->sharedEvents->attach($identifier, $event, $this->generateCallback());
             }
         }
-        $this->events = new EventManager();
-        $this->events->setSharedManager($this->sharedEvents);
-        $this->events->setIdentifiers($identifiers);
+        $this->events = new EventManager($this->sharedEvents, $identifiers);
 
         $this->eventsToTrigger = array_filter($this->getEventList(), function ($value) {
             return ($value !== '*');

benchmarks/MultipleEventMultipleLocalAndSharedListener.php

@@ -25,9 +25,7 @@ public function setUp()
                 $this->sharedEvents->attach($identifier, $event, $this->generateCallback());
             }
         }
-        $this->events = new EventManager();
-        $this->events->setSharedManager($this->sharedEvents);
-        $this->events->setIdentifiers($identifiers);
+        $this->events = new EventManager($this->sharedEvents, $identifiers);
 
         $this->eventsToTrigger = array_filter($this->getEventList(), function ($value) {
             return ($value !== '*');

benchmarks/MultipleEventMultipleSharedListener.php

@@ -21,9 +21,7 @@ public function setUp()
         for ($i = 0; $i < $this->numListeners; $i += 1) {
             $this->sharedEvents->attach($identifiers[0], 'dispatch', $this->generateCallback());
         }
-        $this->events = new EventManager();
-        $this->events->setSharedManager($this->sharedEvents);
-        $this->events->setIdentifiers([$identifiers[0]]);
+        $this->events = new EventManager($this->sharedEvents, [$identifiers[0]]);
     }
 
     /**

benchmarks/SingleEventMultipleSharedListener.php

@@ -19,9 +19,7 @@ public function setUp()
         $identifiers = $this->getIdentifierList();
         $this->sharedEvents = new SharedEventManager();
         $this->sharedEvents->attach($identifiers[0], 'dispatch', $this->generateCallback());
-        $this->events = new EventManager();
-        $this->events->setSharedManager($this->sharedEvents);
-        $this->events->setIdentifiers([$identifiers[0]]);
+        $this->events = new EventManager($this->sharedEvents, [$identifiers[0]]);
     }
 
     /**

benchmarks/SingleEventSingleSharedListener.php

@@ -1,28 +1,25 @@
 {
     "name": "zendframework/zend-eventmanager",
-    "description": " ",
+    "description": "Trigger and listen to events within a PHP application",
     "license": "BSD-3-Clause",
     "keywords": [
         "zf2",
+        "event",
+        "events",
         "eventmanager"
     ],
     "homepage": "https://github.com/zendframework/zend-eventmanager",
-    "autoload": {
-        "psr-4": {
-            "Zend\\EventManager\\": "src/"
-        }
-    },
-    "require": {
-        "php": ">=5.5",
-        "zendframework/zend-stdlib": "~2.5",
-        "athletic/athletic": "dev-master"
-    },
     "minimum-stability": "dev",
     "prefer-stable": true,
     "extra": {
         "branch-alias": {
             "dev-master": "2.5-dev",
-            "dev-develop": "2.6-dev"
+            "dev-develop": "3.0-dev"
+        }
+    },
+    "autoload": {
+        "psr-4": {
+            "Zend\\EventManager\\": "src/"
         }
     },
     "autoload-dev": {
@@ -31,8 +28,18 @@
             "ZendBench\\EventManager\\": "benchmarks/"
         }
     },
+    "require": {
+        "php": ">=5.5"
+    },
     "require-dev": {
-        "fabpot/php-cs-fixer": "1.7.*",
-        "phpunit/PHPUnit": "~4.0"
+        "phpunit/PHPUnit": "~4.0",
+        "athletic/athletic": "^0.1",
+        "squizlabs/php_codesniffer": "^2.0@dev",
+        "zendframework/zend-stdlib": "^2.7.3",
+        "container-interop/container-interop": "^1.1.0"
+    },
+    "suggest": {
+        "container-interop/container-interop": "^1.1.0, to use the lazy listeners feature",
+        "zendframework/zend-stdlib": "^2.7.3, to use the FilterChain feature"
     }
 }