feat(plugins): better api by moving some bootstrapper code directly into aurelia

EisenbergEffect · EisenbergEffect · commit f76baf084f38 · 2015-08-03T13:58:48.000-04:00
diff --git a/src/aurelia.js b/src/aurelia.js
@@ -58,6 +58,18 @@ function loadResources(container, resourcesToLoad, appResources){
   return viewEngine.importViewResources(importIds, names, appResources);
 }
 
+function runTasks(aurelia, tasks){
+  let current, next = () => {
+    if(current = tasks.shift()){
+      return Promise.resolve(current(aurelia)).then(next);
+    }
+
+    return Promise.resolve();
+  };
+
+  return next();
+}
+
 /**
  * The framework core that provides the main Aurelia object.
  *
@@ -74,11 +86,13 @@ export class Aurelia {
   use:Plugins;
 
   constructor(loader?:Loader, container?:Container, resources?:ResourceRegistry){
+    this.resourcesToLoad = {};
+    this.preStartTasks = [];
+    this.postStartTasks = [];
     this.loader = loader || new window.AureliaLoader();
     this.container = container || new Container();
     this.resources = resources || new ResourceRegistry();
     this.use = new Plugins(this);
-    this.resourcesToLoad = {};
 
     this.withInstance(Aurelia, this);
     this.withInstance(Loader, this.loader);
@@ -167,6 +181,30 @@ export class Aurelia {
     return this;
   }
 
+  /**
+   * Adds an async function that runs before the plugins are run.
+   *
+   * @method addPreStartTask
+   * @param {Function} task The function to run before start.
+   * @return {Aurelia} Returns the current Aurelia instance.
+   */
+  addPreStartTask(task:Function):Aurelia{
+    this.preStartTasks.push(task);
+    return this;
+  }
+
+  /**
+   * Adds an async function that runs after the plugins are run.
+   *
+   * @method addPostStartTask
+   * @param {Function} task The function to run after start.
+   * @return {Aurelia} Returns the current Aurelia instance.
+   */
+  addPostStartTask(task:Function):Aurelia{
+    this.postStartTasks.push(task);
+    return this;
+  }
+
   /**
    * Loads plugins, then resources, and then starts the Aurelia instance.
    *
@@ -183,22 +221,26 @@ export class Aurelia {
 
     preventActionlessFormSubmit();
 
-    return this.use._process().then(() => {
-      if(!this.container.hasHandler(BindingLanguage)){
-        var message = 'You must configure Aurelia with a BindingLanguage implementation.';
-        logger.error(message);
-        throw new Error(message);
-      }
-
-      if(!this.container.hasHandler(Animator)){
-        Animator.configureDefault(this.container);
-      }
-
-      return loadResources(this.container, this.resourcesToLoad, this.resources).then(() => {
-        logger.info('Aurelia Started');
-        var evt = new window.CustomEvent('aurelia-started', { bubbles: true, cancelable: true });
-        document.dispatchEvent(evt);
-        return this;
+    return runTasks(this, this.preStartTasks).then(() => {
+      return this.use._process().then(() => {
+        if(!this.container.hasHandler(BindingLanguage)){
+          var message = 'You must configure Aurelia with a BindingLanguage implementation.';
+          logger.error(message);
+          throw new Error(message);
+        }
+
+        if(!this.container.hasHandler(Animator)){
+          Animator.configureDefault(this.container);
+        }
+
+        return loadResources(this.container, this.resourcesToLoad, this.resources);
+      }).then(() => {
+        return runTasks(this, this.postStartTasks).then(() => {
+          logger.info('Aurelia Started');
+          var evt = new window.CustomEvent('aurelia-started', { bubbles: true, cancelable: true });
+          document.dispatchEvent(evt);
+          return this;
+        });
       });
     });
   }
diff --git a/src/plugins.js b/src/plugins.js
@@ -33,6 +33,8 @@ export class Plugins {
     this.aurelia = aurelia;
     this.info = [];
     this.processed = false;
+
+    aurelia.addPreStartTask(() => System.normalize('aurelia-bootstrapper').then(bootstrapperName => this.bootstrapperName = bootstrapperName));
   }
 
   /**
@@ -55,6 +57,122 @@ export class Plugins {
     return this;
   }
 
+  /**
+   * Plugs in the default binding language from aurelia-templating-binding.
+   *
+   * @method defaultBindingLanguage
+   * @return {Plugins} Returns the current Plugins instance.
+  */
+  defaultBindingLanguage():Plugins{
+    this.aurelia.addPreStartTask(() => {
+      return System.normalize('aurelia-templating-binding', this.bootstrapperName).then(name => {
+        this.aurelia.use.plugin(name);
+      });
+    });
+
+    return this;
+  };
+
+  /**
+   * Plugs in the router from aurelia-templating-router.
+   *
+   * @method router
+   * @return {Plugins} Returns the current Plugins instance.
+  */
+  router():Plugins{
+    this.aurelia.addPreStartTask(() => {
+      return System.normalize('aurelia-templating-router', this.bootstrapperName).then(name => {
+        this.aurelia.use.plugin(name);
+      });
+    });
+
+    return this;
+  }
+
+  /**
+   * Plugs in the default history implementation from aurelia-history-browser.
+   *
+   * @method history
+   * @return {Plugins} Returns the current Plugins instance.
+  */
+  history():Plugins{
+    this.aurelia.addPreStartTask(() => {
+      return System.normalize('aurelia-history-browser', this.bootstrapperName).then(name => {
+        this.aurelia.use.plugin(name);
+      });
+    });
+
+    return this;
+  }
+
+  /**
+   * Plugs in the default templating resources (if, repeat, show, compose, etc.) from aurelia-templating-resources.
+   *
+   * @method defaultResources
+   * @return {Plugins} Returns the current Plugins instance.
+  */
+  defaultResources():Plugins{
+    this.aurelia.addPreStartTask(() => {
+      return System.normalize('aurelia-templating-resources', this.bootstrapperName).then(name => {
+        System.map['aurelia-templating-resources'] = name;
+        this.aurelia.use.plugin(name);
+      });
+    });
+
+    return this;
+  }
+
+  /**
+   * Plugs in the event aggregator from aurelia-event-aggregator.
+   *
+   * @method eventAggregator
+   * @return {Plugins} Returns the current Plugins instance.
+  */
+  eventAggregator():Plugins{
+    this.aurelia.addPreStartTask(() => {
+      return System.normalize('aurelia-event-aggregator', this.bootstrapperName).then(name => {
+        System.map['aurelia-event-aggregator'] = name;
+        this.aurelia.use.plugin(name);
+      });
+    });
+
+    return this;
+  }
+
+  /**
+   * Sets up the Aurelia configuration. This is equivalent to calling `.defaultBindingLanguage().defaultResources().history().router().eventAggregator();`
+   *
+   * @method standardConfiguration
+   * @return {Plugins} Returns the current Plugins instance.
+  */
+  standardConfiguration():Plugins{
+    return this.aurelia.use
+      .defaultBindingLanguage()
+      .defaultResources()
+      .history()
+      .router()
+      .eventAggregator();
+  }
+
+  /**
+   * Plugs in the ConsoleAppender and sets the log level to debug.
+   *
+   * @method developmentLogging
+   * @return {Plugins} Returns the current Plugins instance.
+  */
+  developmentLogging():Plugins{
+    this.aurelia.addPreStartTask(() => {
+      return System.normalize('aurelia-logging-console', this.bootstrapperName).then(name => {
+        return this.aurelia.loader.loadModule(name).then(m => {
+          TheLogManager.addAppender(new m.ConsoleAppender());
+          TheLogManager.setLevel(TheLogManager.logLevel.debug);
+        });
+      });
+    });
+
+    return this;
+  }
+
   _process(){
     var aurelia = this.aurelia,
         loader = aurelia.loader,
diff --git a/test/plugin.spec.js b/test/plugin.spec.js
@@ -6,7 +6,7 @@ describe('the plugin loader', () => {
     aureliaMock;
 
   beforeEach(() => {
-    aureliaMock = jasmine.createSpyObj('aureliaMock', ['loader']);
+    aureliaMock = jasmine.createSpyObj('aureliaMock', ['loader', 'addPreStartTask']);
     plugins = new Plugins(aureliaMock);
   });
 
