Merge render events to a single module

Author: sebastian-lenz

lib/application.js

@@ -29,7 +29,7 @@ var loggers_1 = require("./utils/loggers");
 var fs_1 = require("./utils/fs");
 var index_1 = require("./models/index");
 var index_2 = require("./converter/index");
-var Renderer_1 = require("./output/Renderer");
+var renderer_1 = require("./output/renderer");
 var component_1 = require("./utils/component");
 var index_3 = require("./utils/options/index");
 var declaration_1 = require("./utils/options/declaration");
@@ -40,7 +40,7 @@ var Application = (function (_super) {
         _super.call(this, null);
         this.logger = new loggers_1.ConsoleLogger();
         this.converter = this.addComponent('converter', index_2.Converter);
-        this.renderer = this.addComponent('renderer', Renderer_1.Renderer);
+        this.renderer = this.addComponent('renderer', renderer_1.Renderer);
         this.plugins = this.addComponent('plugins', plugins_1.Plugins);
         this.options = this.addComponent('options', index_3.Options);
         this.bootstrap(options);

lib/output/Renderer.js renamed to lib/output/_renderer.js

@@ -3,7 +3,7 @@
  *
  * The [[Renderer]] class is the central controller within this namespace. When invoked it creates
  * an instance of [[BaseTheme]] which defines the layout of the documentation and fires a
- * series of [[OutputEvent]] events. Instances of [[BasePlugin]] can listen to these events and
+ * series of [[RendererEvent]] events. Instances of [[BasePlugin]] can listen to these events and
  * alter the generated output.
  */
 var __extends = (this && this.__extends) || function (d, b) {
@@ -26,7 +26,7 @@ var Path = require("path");
 var FS = require("fs-extra");
 var Handlebars = require("handlebars");
 var ProgressBar = require("progress");
-var OutputEvent_1 = require("./events/OutputEvent");
+var events_1 = require("./events");
 var fs_1 = require("../utils/fs");
 var DefaultTheme_1 = require("./themes/DefaultTheme");
 var components_1 = require("./components");
@@ -65,7 +65,7 @@ var Renderer = (function (_super) {
         if (!this.prepareTheme() || !this.prepareOutputDirectory(outputDirectory)) {
             return;
         }
-        var output = new OutputEvent_1.OutputEvent(Renderer.EVENT_BEGIN);
+        var output = new events_1.RendererEvent(events_1.RendererEvent.BEGIN);
         output.outputDirectory = outputDirectory;
         output.project = project;
         output.settings = this.application.options.getRawValues();
@@ -80,17 +80,17 @@ var Renderer = (function (_super) {
                 _this.renderDocument(output.createPageEvent(mapping));
                 bar.tick();
             });
-            this.trigger(Renderer.EVENT_END, output);
+            this.trigger(events_1.RendererEvent.END, output);
         }
     };
     Renderer.prototype.renderDocument = function (page) {
-        this.trigger(Renderer.EVENT_BEGIN_PAGE, page);
+        this.trigger(events_1.PageEvent.BEGIN, page);
         if (page.isDefaultPrevented) {
             return false;
         }
         page.template = page.template || this.getTemplate(Path.join('templates', page.templateName));
         page.contents = page.template(page);
-        this.trigger(Renderer.EVENT_END_PAGE, page);
+        this.trigger(events_1.PageEvent.END, page);
         if (page.isDefaultPrevented) {
             return false;
         }
@@ -192,10 +192,6 @@ var Renderer = (function (_super) {
         }
         return buffer.toString("utf8", 0);
     };
-    Renderer.EVENT_BEGIN = 'beginRender';
-    Renderer.EVENT_END = 'endRender';
-    Renderer.EVENT_BEGIN_PAGE = 'beginPage';
-    Renderer.EVENT_END_PAGE = 'endPage';
     __decorate([
         component_1.Option({
             name: 'theme',

lib/output/Theme.js renamed to lib/output/_theme.js

@@ -14,7 +14,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
-var Renderer_1 = require("./Renderer");
+var renderer_1 = require("./renderer");
 var components_1 = require("./components");
 var component_1 = require("../utils/component");
 var Theme = (function (_super) {
@@ -34,7 +34,7 @@ var Theme = (function (_super) {
     };
     Theme = __decorate([
         component_1.Component({ name: "rendrer:theme", internal: true }), 
-        __metadata('design:paramtypes', [Renderer_1.Renderer, String])
+        __metadata('design:paramtypes', [renderer_1.Renderer, String])
     ], Theme);
     return Theme;
 })(components_1.RendererComponent);

lib/output/components.js

@@ -7,7 +7,7 @@ var Path = require("path");
 var component_1 = require("../utils/component");
 exports.Component = component_1.Component;
 var index_1 = require("../models/reflections/index");
-var Renderer_1 = require("./Renderer");
+var events_1 = require("./events");
 var RendererComponent = (function (_super) {
     __extends(RendererComponent, _super);
     function RendererComponent() {
@@ -18,19 +18,25 @@ var RendererComponent = (function (_super) {
 exports.RendererComponent = RendererComponent;
 var ContextAwareRendererComponent = (function (_super) {
     __extends(ContextAwareRendererComponent, _super);
-    function ContextAwareRendererComponent(renderer) {
-        _super.call(this, renderer);
-        renderer.on(Renderer_1.Renderer.EVENT_BEGIN, this.onRendererBegin, this);
-        renderer.on(Renderer_1.Renderer.EVENT_BEGIN_PAGE, this.onRendererBeginPage, this);
+    function ContextAwareRendererComponent() {
+        _super.apply(this, arguments);
     }
+    ContextAwareRendererComponent.prototype.initialize = function () {
+        this.listenTo(this.owner, (_a = {},
+            _a[events_1.RendererEvent.BEGIN] = this.onBeginRenderer,
+            _a[events_1.PageEvent.BEGIN] = this.onBeginPage,
+            _a
+        ));
+        var _a;
+    };
     ContextAwareRendererComponent.prototype.getRelativeUrl = function (absolute) {
         var relative = Path.relative(Path.dirname(this.location), Path.dirname(absolute));
         return Path.join(relative, Path.basename(absolute)).replace(/\\/g, '/');
     };
-    ContextAwareRendererComponent.prototype.onRendererBegin = function (event) {
+    ContextAwareRendererComponent.prototype.onBeginRenderer = function (event) {
         this.project = event.project;
     };
-    ContextAwareRendererComponent.prototype.onRendererBeginPage = function (page) {
+    ContextAwareRendererComponent.prototype.onBeginPage = function (page) {
         this.location = page.url;
         this.reflection = page.model instanceof index_1.DeclarationReflection ? page.model : null;
     };

lib/output/events.js

@@ -0,0 +1,46 @@
+var __extends = (this && this.__extends) || function (d, b) {
+    for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p];
+    function __() { this.constructor = d; }
+    d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+};
+var Path = require("path");
+var events_1 = require("../utils/events");
+var RendererEvent = (function (_super) {
+    __extends(RendererEvent, _super);
+    function RendererEvent() {
+        _super.apply(this, arguments);
+    }
+    RendererEvent.prototype.createPageEvent = function (mapping) {
+        var event = new PageEvent(PageEvent.BEGIN);
+        event.project = this.project;
+        event.settings = this.settings;
+        event.url = mapping.url;
+        event.model = mapping.model;
+        event.templateName = mapping.template;
+        event.filename = Path.join(this.outputDirectory, mapping.url);
+        return event;
+    };
+    RendererEvent.BEGIN = 'beginRender';
+    RendererEvent.END = 'endRender';
+    return RendererEvent;
+})(events_1.Event);
+exports.RendererEvent = RendererEvent;
+var PageEvent = (function (_super) {
+    __extends(PageEvent, _super);
+    function PageEvent() {
+        _super.apply(this, arguments);
+    }
+    PageEvent.BEGIN = 'beginPage';
+    PageEvent.END = 'endPage';
+    return PageEvent;
+})(events_1.Event);
+exports.PageEvent = PageEvent;
+var MarkdownEvent = (function (_super) {
+    __extends(MarkdownEvent, _super);
+    function MarkdownEvent() {
+        _super.apply(this, arguments);
+    }
+    MarkdownEvent.PARSE = 'parseMarkdown';
+    return MarkdownEvent;
+})(events_1.Event);
+exports.MarkdownEvent = MarkdownEvent;

lib/output/events/MarkdownEvent.js

@@ -17,7 +17,8 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 var Path = require("path");
 var FS = require("fs-extra");
 var components_1 = require("../components");
-var Renderer_1 = require("../Renderer");
+var events_1 = require("../events");
+var renderer_1 = require("../renderer");
 var AssetsPlugin = (function (_super) {
     __extends(AssetsPlugin, _super);
     function AssetsPlugin() {
@@ -26,13 +27,13 @@ var AssetsPlugin = (function (_super) {
     }
     AssetsPlugin.prototype.initialize = function () {
         this.listenTo(this.owner, (_a = {},
-            _a[Renderer_1.Renderer.EVENT_BEGIN] = this.onRendererBegin,
+            _a[events_1.RendererEvent.BEGIN] = this.onRendererBegin,
             _a
         ));
         var _a;
     };
     AssetsPlugin.prototype.onRendererBegin = function (event) {
-        var fromDefault = Path.join(Renderer_1.Renderer.getDefaultTheme(), 'assets');
+        var fromDefault = Path.join(renderer_1.Renderer.getDefaultTheme(), 'assets');
         var to = Path.join(event.outputDirectory, 'assets');
         if (this.copyDefaultAssets) {
             FS.copySync(fromDefault, to);

lib/output/events/OutputEvent.js

@@ -19,18 +19,14 @@ var index_1 = require("../../models/reflections/index");
 var GroupPlugin_1 = require("../../converter/plugins/GroupPlugin");
 var components_1 = require("../components");
 var fs_1 = require("../../utils/fs");
-var Renderer_1 = require("../Renderer");
+var events_1 = require("../events");
 var JavascriptIndexPlugin = (function (_super) {
     __extends(JavascriptIndexPlugin, _super);
     function JavascriptIndexPlugin() {
         _super.apply(this, arguments);
     }
     JavascriptIndexPlugin.prototype.initialize = function () {
-        this.listenTo(this.owner, (_a = {},
-            _a[Renderer_1.Renderer.EVENT_BEGIN] = this.onRendererBegin,
-            _a
-        ));
-        var _a;
+        this.listenTo(this.owner, events_1.RendererEvent.BEGIN, this.onRendererBegin);
     };
     JavascriptIndexPlugin.prototype.onRendererBegin = function (event) {
         var rows = [];