Merge branch 'hotfix/26' into develop

Forward port #26

Author: weierophinney

.gitignore

@@ -6,11 +6,12 @@
 .*.sw*
 .*.un~
 nbproject
+doc/html/
 tmp/
+vendor/
+zf-mkdoc-theme/
 
 clover.xml
 composer.lock
 coveralls-upload.json
 phpunit.xml
-doc/html/
-vendor/

.travis.yml

@@ -10,6 +10,16 @@ branches:
 cache:
   directories:
     - $HOME/.composer/cache
+    - $HOME/.local
+    - zf-mkdoc-theme
+
+env:
+  global:
+    - SITE_URL: https://zendframework.github.io/zend-eventmanager
+    - GH_USER_NAME: "Matthew Weier O'Phinney"
+    - GH_USER_EMAIL: [email protected]
+    - GH_REF: github.com/zendframework/zend-eventmanager.git
+    - secure: "q6mC+KhLKsPYD22R9RI7lLhQGF5dSQ0QttmaFSQf/wtIntruVIFoyWt8ObR3zFsZ4xxra8MZFV2AjbMM9vqB28aHZ1jV5kbCbhTfSbdv0GT4nwqIHh84Ui7gCykJBqyyboWf/ekOv87cbuTg3EbqJcgdBh6/oyRGIVVB3HQayJJTTUCz+TQ/M4mpvOE+61FGpu6WLv465R8aKRi0ZLjk6qMtAY616cnGlPBOoNopyQM2+VTGyLOFgwnCUae3l4MSc8zsWgA4FLwttsYOzoVXit1ZXcqAt+XCAxUMntT3esIKVdeNejqQ7ZhMdMJpbdXTgfOD9kPt4fbNrcyg12Zkl0F3lHUNMb22PWNXb7tZ3+E4pR8B+6GtKXLRleEl9sPUKhxZ0CgwQErqOE8Osnw+BeNjueosNzJvrpxdHLX1a1+1v4VZIcikK+btW6YS+YLjZJgd80LI/4vQByUehgfFRuJnmjkMp+p9NN+PphdYHcQLfe2VU+qif114cR2WAyaiJ47zXMu2+vqp9sR20M2CfKZXrihiSO+CdbhSmep3sWaCuLWZtpsMx7u3rKl1o5doGLmkYAc+OaCEw5mZ/nVxzkH2ldNNcCeV2+ENKj4zlKoVXy1MB0KTT2U2rJ4pO5WhYLORbgBNNKeuD8r5nl65Dhn3gaIPXvlica/jIqay+/U="
 
 matrix:
   fast_finish: true
@@ -21,6 +31,8 @@ matrix:
     - php: 5.6
       env:
         - EXECUTE_TEST_COVERALLS=true
+        - DEPLOY_DOCS="$(if [[ $TRAVIS_BRANCH == 'master' && $TRAVIS_PULL_REQUEST == 'false' ]]; then echo -n 'true' ; else echo -n 'false' ; fi)"
+        - PATH="$HOME/.local/bin:$PATH"
     - php: 7
     - php: hhvm 
   allow_failures:
@@ -33,21 +45,20 @@ 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 --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/phpcs ; fi
-  - if [[ $EXECUTE_DOC_CHECK == 'true' ]]; then make mkdocs ; diff mkdocs.yml mkdocs.yml.orig ; return $? ; fi
+  - if [[ $DEPLOY_DOCS == "true" && "$TRAVIS_TEST_RESULT" == "0" ]]; then wget -O theme-installer.sh "https://raw.githubusercontent.com/zendframework/zf-mkdoc-theme/master/theme-installer.sh" ; chmod 755 theme-installer.sh ; ./theme-installer.sh ; fi
+
+after_success:
+  - if [[ $DEPLOY_DOCS == "true" ]]; then echo "Preparing to build and deploy documentation" ; ./zf-mkdoc-theme/deploy.sh ; echo "Completed deploying documentation" ; fi
 
 after_script:
   - if [[ $EXECUTE_TEST_COVERALLS == 'true' ]]; then ./vendor/bin/coveralls ; fi

CHANGELOG.md

@@ -24,7 +24,8 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Added
 
-- Nothing.
+- [#26](https://github.com/zendframework/zend-eventmanager/pull/26) publishes
+  the documentation to https://zendframework.github.io/zend-eventmanager/
 
 ### Deprecated
 

README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://secure.travis-ci.org/zendframework/zend-eventmanager.svg?branch=master)](https://secure.travis-ci.org/zendframework/zend-eventmanager)
 [![Coverage Status](https://coveralls.io/repos/zendframework/zend-eventmanager/badge.svg?branch=master)](https://coveralls.io/r/zendframework/zend-eventmanager?branch=master)
 
-The `Zend\EventManager` is a component designed for the following use cases:
+zend-eventmanager is designed for the following use cases:
 
 - Implementing simple subject/observer patterns.
 - Implementing Aspect-Oriented designs.
@@ -14,10 +14,10 @@ both on a per-instance basis as well as via shared collections; trigger events;
 and interrupt execution of listeners.
 
 - File issues at https://github.com/zendframework/zend-eventmanager/issues
-- Documentation is at http://zend-eventmanager.rtfd.org
+- Documentation is at https://zendframework.github.io/zend-eventmanager/
 
 For migration from version 2 to version 3, please [read the migration
-documentation](http://zend-eventmanager.readthedocs.org/en/latest/migration/intro/).
+documentation](https://zendframework.github.io/zend-eventmanager/migration/intro/).
 
 ## Benchmarks
 

doc/book/api.md

@@ -114,7 +114,7 @@ $events->triggerUntil(function ($result) {
 In the above example, the event loop will short-circuit after the second
 listener executes, resulting in the following output:
 
-```
+```text
 Triggered first
 Triggered second
 ```

doc/book/examples.md

@@ -206,7 +206,7 @@ class CacheListener implements ListenerAggregateInterface
 
 We can then attach the aggregate to an event manager instance.
 
-```
+```php
 $value         = new SomeValueObject();
 $cacheListener = new CacheListener($cache);
 $cacheListener->attach($value->getEventManager());

doc/book/index.html

@@ -0,0 +1,12 @@
+<div class="container">
+    <div class="jumbotron">
+        <h1>zend-eventmanager</h1>
+
+        <p>
+            Implement events, signal slots, aspects, and observers!
+        </p>
+
+        <pre><code class="language-bash">$ composer require zendframework/zend-eventmanager</code></pre>
+    </div>
+</div>
+

doc/book/lazy-listeners/bookdown.json

@@ -44,7 +44,7 @@ $events->trigger('do', null, $params);
 
 The above will result in the following:
 
-```
+```text
 Handled event "do", with parameters {"foo":"bar","baz":"bat"}
 ```
 
@@ -176,7 +176,7 @@ $example->do('bar', 'bat');
 
 and expect the following output:
 
-```
+```text
 Handled event "do" on target "Example", with parameters {"foo":"bar","baz":"bat"}
 ```
 

doc/book/migration/bookdown.json

@@ -2,17 +2,25 @@ docs_dir: doc/book
 site_dir: doc/html
 pages:
     - index.md
-    - { Overview: intro.md }
-    - { 'Quick Start': quick-start.md }
-    - { Tutorial: tutorial.md }
-    - { 'Wildcard Listeners': wildcard-listeners.md }
-    - { 'Listener Aggregates': aggregates.md }
-    - { 'Lazy Listeners': [{ Introduction: lazy-listeners/intro.md }, { LazyListener: lazy-listeners/lazy-listener.md }, { LazyEventListener: lazy-listeners/lazy-event-listener.md }, { LazyListenerAggregate: lazy-listeners/lazy-listener-aggregate.md }] }
-    - { Examples: examples.md }
-    - { 'EventManager API': api.md }
-    - { 'Intercepting Filters': intercepting-filters.md }
-    - { 'Migration Guide': [{ Introduction: migration/intro.md }, { 'Removed Functionality': migration/removed.md }, { 'Changed Functionality': migration/changed.md }] }
+    - Intro: intro.md
+    - "Quick Start": quick-start.md
+    - Tutorial: tutorial.md
+    - Examples: examples.md
+    - Reference:
+        - "Wildcard Listeners": wildcard-listeners.md
+        - "Listener Aggregates": aggregates.md
+        - "Lazy Listeners":
+            - Intro: lazy-listeners/intro.md
+            - LazyListener: lazy-listeners/lazy-listener.md
+            - LazyEventListener: lazy-listeners/lazy-event-listener.md
+            - LazyListenerAggregate: lazy-listeners/lazy-listener-aggregate.md
+        - "EventManager API": api.md
+        - "Intercepting Filters": intercepting-filters.md
+        - "Migration Guide":
+            - Intro: migration/intro.md
+            - "Removed Functionality": migration/removed.md
+            - "Changed Functionality": migration/changed.md
 site_name: zend-eventmanager
-site_description: 'zend-eventmanager: Powerful event bus system for Zend Framework'
+site_description: "zend-eventmanager: Implement events, signal slots, aspects, and observers!"
 repo_url: 'https://github.com/zendframework/zend-eventmanager'
 copyright: 'Copyright (c) 2016 <a href="http://www.zend.com/">Zend Technologies USA Inc.</a>'