Add Event implementation

.gitignore

@@ -7,3 +7,4 @@
 /theme/
 /Vagrantfile
 /.vagrant
+.idea/

composer.json

@@ -27,7 +27,8 @@
         "phine/phar": "~1.0",
         "mnapoli/front-yaml": "~1.5",
         "php-di/php-di": "^5.2.1",
-        "psr/log": "~1.0"
+        "psr/log": "~1.0",
+        "league/event": "^2.1"
     },
     "require-dev": {
         "phpunit/phpunit": "~4.5"

couscous.yml

@@ -13,6 +13,24 @@ scripts:
 baseUrl: http://couscous.io
 cname: couscous.io
 
+# This config is for demo purposes only. This will be removed when this feature will be merged.
+events:
+    listeners:
+        - event: 'couscous.step.after_config'
+          listener: 'Couscous\Event\Listener\AfterConfigListener'
+        - event: 'couscous.step.before_parse'
+          listener: 'Couscous\Event\Listener\BeforeParseListener'
+        - event: 'couscous.step.after_parse'
+          listener: 'Couscous\Event\Listener\AfterParseListener'
+        - event: 'couscous.step.before_render_markdown'
+          listener: 'Couscous\Event\Listener\BeforeRenderMarkdownListener'
+        - event: 'couscous.step.after_render_markdown'
+          listener: 'Couscous\Event\Listener\AfterRenderMarkdownListener'
+        - event: 'couscous.step.before_write'
+          listener: 'Couscous\Event\Listener\BeforeWriteListener'
+        - event: 'couscous.step.after_write'
+          listener: 'Couscous\Event\Listener\AfterWriteListener'
+
 menu:
     items:
         getting-started:

src/Application/config.php

@@ -10,6 +10,9 @@
         DI\get('Couscous\Module\Config\Step\LoadConfig'),
         DI\get('Couscous\Module\Config\Step\OverrideBaseUrlForPreview'),
 
+        DI\get('Couscous\Module\Events\Step\InitEventListeners'),
+        DI\get('Couscous\Module\Events\Step\EmitAfterConfigEvent'),
+
         DI\get('Couscous\Module\Scripts\Step\ExecuteBeforeScripts'),
 
         DI\get('Couscous\Module\Template\Step\UseDefaultTemplate'),
@@ -25,18 +28,26 @@
 
         DI\get('Couscous\Module\Core\Step\AddFileNameToMetadata'),
 
+        DI\get('Couscous\Module\Events\Step\EmitBeforeParseEvent'),
         DI\get('Couscous\Module\Markdown\Step\ParseMarkdownFrontMatter'),
+        DI\get('Couscous\Module\Events\Step\EmitAfterParseEvent'),
         DI\get('Couscous\Module\Markdown\Step\ProcessMarkdownFileName'),
         DI\get('Couscous\Module\Markdown\Step\RewriteMarkdownLinks'),
+        DI\get('Couscous\Module\Events\Step\EmitBeforeRenderMarkdownEvent'),
         DI\get('Couscous\Module\Markdown\Step\RenderMarkdown'),
+        DI\get('Couscous\Module\Events\Step\EmitAfterRenderMarkdownEvent'),
         DI\get('Couscous\Module\Markdown\Step\CreateHeadingIds'),
 
         DI\get('Couscous\Module\Template\Step\AddPageListToLayoutVariables'),
         DI\get('Couscous\Module\Template\Step\ProcessTwigLayouts'),
 
+        DI\get('Couscous\Module\Events\Step\EmitBeforeWriteEvent'),
+
         DI\get('Couscous\Module\Core\Step\ClearTargetDirectory'),
         DI\get('Couscous\Module\Core\Step\WriteFiles'),
 
+        DI\get('Couscous\Module\Events\Step\EmitAfterWriteEvent'),
+
         DI\get('Couscous\Module\Scripts\Step\ExecuteAfterScripts'),
     ],
 

src/Event/EventManager.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Couscous\Event;
+
+use DI\Container;
+use DI\ContainerBuilder;
+use League\Event\Emitter;
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\Finder\SplFileInfo;
+
+/**
+ * Eventmanager.
+ * Handles the event emitter.
+ *
+ * @author Bob Mulder <bobmulder@outlook.com>
+ */
+class EventManager
+{
+    /**
+     * The emitter instance.
+     *
+     * @var Emitter
+     */
+    protected static $emitter;
+
+    /**
+     * Returns the static instance of the emitter.
+     *
+     * @return Emitter
+     */
+    public static function &emitter()
+    {
+        if(!self::$emitter) {
+            self::$emitter = new Emitter();
+        }
+        return self::$emitter;
+    }
+}

src/Event/Listener/AfterConfigListener.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Couscous\Event\Listener;
+
+use Couscous\Model\Project;
+use Couscous\Step;
+use League\Event\EventInterface;
+
+/**
+ * After Config Event Listener
+ *
+ * @author Bob Mulder <bobmulder@outlook.com>
+ */
+class AfterConfigListener extends BaseListener
+{
+
+    /**
+     * Handle the event.
+     *
+     * @param EventInterface $event
+     */
+    public function handle(EventInterface $event)
+    {
+        $project = func_get_arg(1)['project'];
+
+        var_dump('after_config');
+    }
+}

src/Event/Listener/AfterParseListener.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Couscous\Event\Listener;
+
+use Couscous\Model\Project;
+use Couscous\Step;
+use League\Event\EventInterface;
+
+/**
+ * After Parse Event Listener
+ *
+ * @author Bob Mulder <bobmulder@outlook.com>
+ */
+class AfterParseListener extends BaseListener
+{
+
+    /**
+     * Handle the event.
+     *
+     * @param EventInterface $event
+     */
+    public function handle(EventInterface $event)
+    {
+        $project = func_get_arg(1)['project'];
+
+        var_dump('after_parse');
+    }
+}

src/Event/Listener/AfterRenderMarkdownListener.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Couscous\Event\Listener;
+
+use Couscous\Model\Project;
+use Couscous\Step;
+use League\Event\EventInterface;
+
+/**
+ * After Render Markdown Event Listener
+ *
+ * @author Bob Mulder <bobmulder@outlook.com>
+ */
+class AfterRenderMarkdownListener extends BaseListener
+{
+
+    /**
+     * Handle the event.
+     *
+     * @param EventInterface $event
+     */
+    public function handle(EventInterface $event)
+    {
+        $project = func_get_arg(1)['project'];
+
+        var_dump('after_render_markdown');
+    }
+}

src/Event/Listener/AfterWriteListener.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Couscous\Event\Listener;
+
+use Couscous\Model\Project;
+use Couscous\Step;
+use League\Event\EventInterface;
+
+/**
+ * After Write Event Listener
+ *
+ * @author Bob Mulder <bobmulder@outlook.com>
+ */
+class AfterWriteListener extends BaseListener
+{
+
+    /**
+     * Handle the event.
+     *
+     * @param EventInterface $event
+     */
+    public function handle(EventInterface $event)
+    {
+        $project = func_get_arg(1)['project'];
+
+        var_dump('after_write');
+    }
+}

src/Event/Listener/BaseListener.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Couscous\Event\Listener;
+
+use DI\Container;
+use DI\ContainerBuilder;
+use League\Event\EventInterface;
+use League\Event\ListenerInterface;
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\Finder\SplFileInfo;
+
+/**
+ * Base Event Listener
+ *
+ * @author Bob Mulder <bobmulder@outlook.com>
+ */
+class BaseListener implements ListenerInterface
+{
+
+    /**
+     * Handle the event.
+     *
+     * @param EventInterface $event
+     *
+     * @return void
+     */
+    public function handle(EventInterface $event)
+    {
+    }
+
+    /**
+     * Check whether the listener is the given parameter.
+     *
+     * @param mixed $listener
+     *
+     * @return bool
+     */
+    public function isListener($listener)
+    {
+        return $listener === $this;
+    }
+}

src/Event/Listener/BeforeParseListener.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Couscous\Event\Listener;
+
+use Couscous\Model\Project;
+use Couscous\Step;
+use League\Event\EventInterface;
+
+/**
+ * Before Parse Event Listener
+ *
+ * @author Bob Mulder <bobmulder@outlook.com>
+ */
+class BeforeParseListener extends BaseListener
+{
+
+    /**
+     * Handle the event.
+     *
+     * @param EventInterface $event
+     */
+    public function handle(EventInterface $event)
+    {
+        $project = func_get_arg(1)['project'];
+
+        var_dump('before_parse');
+
+        /** @var MarkdownFile[] $markdownFiles */
+        $markdownFiles = $project->findFilesByType('Couscous\Module\Markdown\Model\MarkdownFile');
+
+        foreach ($markdownFiles as $file) {
+            $file->content = str_replace('Couscous', '**CakePlugins**', $file->content);
+        }
+    }
+}

src/Event/Listener/BeforeRenderMarkdownListener.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Couscous\Event\Listener;
+
+use Couscous\Model\Project;
+use Couscous\Step;
+use League\Event\EventInterface;
+
+/**
+ * Before Render Markdown Event Listener
+ *
+ * @author Bob Mulder <bobmulder@outlook.com>
+ */
+class BeforeRenderMarkdownListener extends BaseListener
+{
+
+    /**
+     * Handle the event.
+     *
+     * @param EventInterface $event
+     */
+    public function handle(EventInterface $event)
+    {
+        $project = func_get_arg(1)['project'];
+
+        var_dump('before_render_markdown');
+    }
+}

src/Event/Listener/BeforeWriteListener.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Couscous\Event\Listener;
+
+use Couscous\Model\Project;
+use Couscous\Step;
+use League\Event\EventInterface;
+
+/**
+ * Before Write Event Listener
+ *
+ * @author Bob Mulder <bobmulder@outlook.com>
+ */
+class BeforeWriteListener extends BaseListener
+{
+
+    /**
+     * Handle the event.
+     *
+     * @param EventInterface $event
+     */
+    public function handle(EventInterface $event)
+    {
+        $project = func_get_arg(1)['project'];
+
+        var_dump('before_write');
+    }
+}

src/Module/Events/Step/EmitAfterConfigEvent.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Couscous\Module\Events\Step;
+
+use Couscous\Event\EventManager;
+use Couscous\Model\Project;
+use Couscous\Step;
+
+/**
+ * Fire the event couscous.step.after_config.
+ *
+ * @author Bob Mulder <bobmulder@outlook.com>
+ */
+class EmitAfterConfigEvent implements Step
+{
+    public function __invoke(Project $project)
+    {
+        $emitter = EventManager::emitter();
+        $emitter->emit('couscous.step.after_config', ['project' => $project]);
+    }
+}