From f70fca081e961a997d5b8da6a12e678f207c067d Mon Sep 17 00:00:00 2001
From: Victor Woeltjen <victor.woeltjen@nasa.gov>
Date: Wed, 14 Jan 2015 16:33:30 -0800
Subject: [PATCH 1/5] [Framework] Add specs for built-in extension for run

Add tests for a built-in extension type to framework to allow app.run
to be invoked via bundle extensions. This supports stylesheet
injection, which should happen on load but isn't triggered
from any particular part of the page. WTD-591.
---
 .../framework/test/register/CustomRegistrarsSpec.js   | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/platform/framework/test/register/CustomRegistrarsSpec.js b/platform/framework/test/register/CustomRegistrarsSpec.js
index d70b7d4f2e..106253ca6c 100644
--- a/platform/framework/test/register/CustomRegistrarsSpec.js
+++ b/platform/framework/test/register/CustomRegistrarsSpec.js
@@ -20,7 +20,8 @@ define(
                     "directive",
                     "service",
                     "constant",
-                    "config"
+                    "config",
+                    "run"
                 ]);
 
                 mockLog = jasmine.createSpyObj("$log", [
@@ -39,6 +40,7 @@ define(
                 expect(customRegistrars.services).toBeTruthy();
                 expect(customRegistrars.routes).toBeTruthy();
                 expect(customRegistrars.constants).toBeTruthy();
+                expect(customRegistrars.runs).toBeTruthy();
             });
 
             it("invokes built-in functions on the app", function () {
@@ -58,6 +60,11 @@ define(
                 expect(mockApp.constant.calls.length).toEqual(0);
                 customRegistrars.constants([{ key: "a", value: "b" }, { key: "b", value: "c" }, { key: "c", value: "d" }]);
                 expect(mockApp.constant.calls.length).toEqual(3);
+
+                expect(mockApp.run.calls.length).toEqual(0);
+                customRegistrars.runs([jasmine.createSpy("a"), jasmine.createSpy("a"), jasmine.createSpy("a")]);
+                expect(mockApp.run.calls.length).toEqual(3);
+
             });
 
             it("warns when keys are not defined, then skips", function () {
@@ -81,6 +88,8 @@ define(
                 customRegistrars.constants([{ }, { }, { }]);
                 expect(mockApp.constant.calls.length).toEqual(0);
                 expect(mockLog.warn.calls.length).toEqual(9);
+
+                // Notably, keys are not needed for run calls
             });
 
             it("allows routes to be registered", function () {

From 04ee5bbbb589fc6ec183bcff60299df130f06274 Mon Sep 17 00:00:00 2001
From: Victor Woeltjen <victor.woeltjen@nasa.gov>
Date: Wed, 14 Jan 2015 16:41:14 -0800
Subject: [PATCH 2/5] [Framework] Implement runs category-of-extension

Implement 'runs' as a built-in category of extension, to support
bundle addition of functions to run when the application first
starts. Specifically supports loading of stylesheets, WTD-591.
---
 .../framework/src/register/CustomRegistrars.js | 18 +++++++++++++++++-
 .../test/register/CustomRegistrarsSpec.js      |  8 ++++++++
 2 files changed, 25 insertions(+), 1 deletion(-)

diff --git a/platform/framework/src/register/CustomRegistrars.js b/platform/framework/src/register/CustomRegistrars.js
index 9c3fc0a225..9f6717367a 100644
--- a/platform/framework/src/register/CustomRegistrars.js
+++ b/platform/framework/src/register/CustomRegistrars.js
@@ -72,6 +72,21 @@ define(
 
             }
 
+            // Custom registration function for extensions of category "runs"
+            function registerRun(extension) {
+                if (typeof extension === 'function') {
+                    // Prepend dependencies, and schedule to run
+                    app.run((extension.depends || []).concat([extension]));
+                } else {
+                    // If it's not a function, no implementation was given
+                    $log.warn([
+                        "Cannot register run extension from ",
+                        (extension.bundle || {}).path,
+                        "; no implementation."
+                    ].join(""));
+                }
+            }
+
             // Custom registration function for extensions of category "route"
             function registerRoute(extension) {
                 var route = Object.create(extension);
@@ -107,7 +122,7 @@ define(
             // Utility; create a function which converts another function
             // (which acts on single objects) to one which acts upon arrays.
             function mapUpon(func) {
-                return function(array) {
+                return function (array) {
                     return array.map(func);
                 };
             }
@@ -121,6 +136,7 @@ define(
                 directives: mapUpon(new CustomRegistrar("directive")),
                 controllers: mapUpon(new CustomRegistrar("controller")),
                 services: mapUpon(new CustomRegistrar("service")),
+                runs: mapUpon(registerRun),
                 components: registerComponents
             };
         }
diff --git a/platform/framework/test/register/CustomRegistrarsSpec.js b/platform/framework/test/register/CustomRegistrarsSpec.js
index 106253ca6c..f7b13caa94 100644
--- a/platform/framework/test/register/CustomRegistrarsSpec.js
+++ b/platform/framework/test/register/CustomRegistrarsSpec.js
@@ -135,6 +135,14 @@ define(
                 expect(customRegistrars.components).toBeTruthy();
                 customRegistrars.components([]);
             });
+
+            it("warns if no implementation is provided for runs", function () {
+                // Verify precondition
+                expect(mockLog.warn).not.toHaveBeenCalled();
+                customRegistrars.runs([{ something: "that is not a function"}]);
+                expect(mockLog.warn).toHaveBeenCalledWith(jasmine.any(String));
+                expect(mockApp.run).not.toHaveBeenCalled();
+            });
         });
     }
 );
\ No newline at end of file

From fcab62b4980fb876049c7de92cb38e9325cfd176 Mon Sep 17 00:00:00 2001
From: Victor Woeltjen <victor.woeltjen@nasa.gov>
Date: Wed, 14 Jan 2015 17:01:52 -0800
Subject: [PATCH 3/5] [Stylesheets] Add style sheet loader

Add style sheet loader and move style sheets inclusion
out of index.html. WTD-591.
---
 index.html                                    | 17 ----------
 platform/commonUI/general/bundle.json         | 24 ++++++++++++++
 .../commonUI/general/src/StyleSheetLoader.js  | 31 +++++++++++++++++++
 3 files changed, 55 insertions(+), 17 deletions(-)
 create mode 100644 platform/commonUI/general/src/StyleSheetLoader.js

diff --git a/index.html b/index.html
index b2ba8bde66..6b460aefc5 100644
--- a/index.html
+++ b/index.html
@@ -3,23 +3,6 @@
 <head lang="en">
     <meta charset="UTF-8">
     <title></title>
-
-    <link rel="stylesheet"
-          type="text/css",
-          href="platform/commonUI/general/res/css/normalize.min.css">
-
-    <link rel="stylesheet"
-          type="text/css",
-          href="platform/commonUI/general/res/css/theme-espresso.css">
-
-    <link rel="stylesheet"
-          type="text/css",
-          href="platform/commonUI/general/res/css/items.css">
-
-    <link rel="stylesheet"
-          type="text/css",
-          href="platform/commonUI/general/res/css/tree.css">
-
     <script type="text/javascript"
             src="platform/framework/lib/require.js"
             data-main="platform/framework/src/Main.js">
diff --git a/platform/commonUI/general/bundle.json b/platform/commonUI/general/bundle.json
index b8213f8c77..c88684991c 100644
--- a/platform/commonUI/general/bundle.json
+++ b/platform/commonUI/general/bundle.json
@@ -3,6 +3,30 @@
     "description": "General UI elements, meant to be reused across modes.",
     "resources": "res",
     "extensions": {
+        "runs": [
+            {
+                "implementation": "StyleSheetLoader.js",
+                "depends": [ "stylesheets[]", "$document" ]
+            }
+        ],
+        "stylesheets": [
+            {
+                "stylesheetUrl": "css/normalize.min.css",
+                "priority": "mandatory"
+            },
+            {
+                "stylesheetUrl": "css/theme-espresso.css",
+                "priority": 1000
+            },
+            {
+                "stylesheetUrl": "css/items.css",
+                "priority": 901
+            },
+            {
+                "stylesheetUrl": "css/tree.css",
+                "priority": 900
+            }
+        ],
         "templates": [
             {
                 "key": "bottombar",
diff --git a/platform/commonUI/general/src/StyleSheetLoader.js b/platform/commonUI/general/src/StyleSheetLoader.js
new file mode 100644
index 0000000000..da622fe669
--- /dev/null
+++ b/platform/commonUI/general/src/StyleSheetLoader.js
@@ -0,0 +1,31 @@
+/*global define*/
+
+define(
+    ["angular"],
+    function (angular) {
+        "use strict";
+
+        function StyleSheetLoader(stylesheets, $document) {
+            var head = $document.find('head');
+
+            function addStyleSheet(stylesheet) {
+                var link = angular.element('<link>'),
+                    path = [
+                        stylesheet.bundle.path,
+                        stylesheet.bundle.resources,
+                        stylesheet.stylesheetUrl
+                    ].join("/");
+
+                link.attr("rel", "stylesheet");
+                link.attr("type", "text/css");
+                link.attr("href", path);
+
+                head.append(link);
+            }
+
+            stylesheets.forEach(addStyleSheet);
+        }
+
+        return StyleSheetLoader;
+    }
+);
\ No newline at end of file

From 486a9e02e802b7f9ded9441e557b31dab0cb3cb6 Mon Sep 17 00:00:00 2001
From: Victor Woeltjen <victor.woeltjen@nasa.gov>
Date: Wed, 14 Jan 2015 17:07:16 -0800
Subject: [PATCH 4/5] [Stylesheets] Add documentation

Add documentation about using the stylesheets category of extension
added for WTD-591.
---
 platform/commonUI/README.md | 20 +++++++++++++++++---
 1 file changed, 17 insertions(+), 3 deletions(-)

diff --git a/platform/commonUI/README.md b/platform/commonUI/README.md
index f77df6aa2f..567a9e0999 100644
--- a/platform/commonUI/README.md
+++ b/platform/commonUI/README.md
@@ -1,3 +1,17 @@
-This directory contains bundles containing common user interface 
-elements of Open MCT Web; that is, the user interface for the application 
-as a whole (as opposed to for specific features) is implemented here. 
+This directory contains bundles containing common user interface
+elements of Open MCT Web; that is, the user interface for the application
+as a whole (as opposed to for specific features) is implemented here.
+
+# Extensions
+
+This bundles adds a `stylesheets` extension category used to inject CSS
+from bundles. These extensions are declaration-only (no scripted
+implementation is needed or used); a single property, `stylesheetUrl`,
+should be provided, with a path to the relevant CSS file (including
+extension) relative to the resources directory for that bundle.
+
+Links to these CSS files are appended to the head when the application
+is started. These are added in standard priority order (see documentation
+for the framework layer); the order of inclusion of style sheets can
+change the way they are handled/understood by the browser, so priority
+can be used to provide control over this order.
\ No newline at end of file

From ccc30fde3dd6189656f7d46867b11b0459f5c854 Mon Sep 17 00:00:00 2001
From: Victor Woeltjen <victor.woeltjen@nasa.gov>
Date: Wed, 14 Jan 2015 17:23:18 -0800
Subject: [PATCH 5/5] [Stylesheets] Add spec, docs

Add tests and JSDoc to the style sheet loader introduced to
allow bundles to introduce their own CSS files through the
platform's regular extension mechanism; WTD-591.
---
 .../commonUI/general/src/StyleSheetLoader.js  | 27 ++++++---
 .../general/test/StyleSheetLoaderSpec.js      | 57 +++++++++++++++++++
 platform/commonUI/general/test/suite.json     |  3 +-
 3 files changed, 79 insertions(+), 8 deletions(-)
 create mode 100644 platform/commonUI/general/test/StyleSheetLoaderSpec.js

diff --git a/platform/commonUI/general/src/StyleSheetLoader.js b/platform/commonUI/general/src/StyleSheetLoader.js
index da622fe669..0088a76f23 100644
--- a/platform/commonUI/general/src/StyleSheetLoader.js
+++ b/platform/commonUI/general/src/StyleSheetLoader.js
@@ -1,28 +1,41 @@
 /*global define*/
 
 define(
-    ["angular"],
-    function (angular) {
+    [],
+    function () {
         "use strict";
 
+        /**
+         * The StyleSheetLoader adds links to style sheets exposed from
+         * various bundles as extensions of category `stylesheets`.
+         * @constructor
+         * @param {object[]} stylesheets stylesheet extension definitions
+         * @param $document Angular's jqLite-wrapped document element
+         */
         function StyleSheetLoader(stylesheets, $document) {
-            var head = $document.find('head');
+            var head = $document.find('head'),
+                document = $document[0];
 
+            // Procedure for adding a single stylesheet
             function addStyleSheet(stylesheet) {
-                var link = angular.element('<link>'),
+                // Create a link element, and construct full path
+                var link = document.createElement('link'),
                     path = [
                         stylesheet.bundle.path,
                         stylesheet.bundle.resources,
                         stylesheet.stylesheetUrl
                     ].join("/");
 
-                link.attr("rel", "stylesheet");
-                link.attr("type", "text/css");
-                link.attr("href", path);
+                // Initialize attributes on the link
+                link.setAttribute("rel", "stylesheet");
+                link.setAttribute("type", "text/css");
+                link.setAttribute("href", path);
 
+                // Append the link to the head element
                 head.append(link);
             }
 
+            // Add all stylesheets from extensions
             stylesheets.forEach(addStyleSheet);
         }
 
diff --git a/platform/commonUI/general/test/StyleSheetLoaderSpec.js b/platform/commonUI/general/test/StyleSheetLoaderSpec.js
new file mode 100644
index 0000000000..b1977835ff
--- /dev/null
+++ b/platform/commonUI/general/test/StyleSheetLoaderSpec.js
@@ -0,0 +1,57 @@
+/*global define,Promise,describe,it,expect,beforeEach,waitsFor,jasmine*/
+
+define(
+    ["../src/StyleSheetLoader"],
+    function (StyleSheetLoader) {
+        "use strict";
+
+        describe("The style sheet loader", function () {
+            var testStyleSheets,
+                mockDocument,
+                mockPlainDocument,
+                mockHead,
+                mockElement,
+                loader;
+
+            beforeEach(function () {
+                var testBundle = {
+                    path: "a/b",
+                    resources: "c"
+                };
+
+                testStyleSheets = [
+                    { stylesheetUrl: "d.css", bundle: testBundle },
+                    { stylesheetUrl: "e.css", bundle: testBundle },
+                    { stylesheetUrl: "f.css", bundle: testBundle }
+                ];
+
+                mockPlainDocument =
+                    jasmine.createSpyObj("document", ["createElement"]);
+                mockDocument = [ mockPlainDocument ];
+                mockDocument.find = jasmine.createSpy("$document.find");
+                mockHead = jasmine.createSpyObj("head", ["append"]);
+                mockElement = jasmine.createSpyObj("link", ["setAttribute"]);
+
+                mockDocument.find.andReturn(mockHead);
+                mockPlainDocument.createElement.andReturn(mockElement);
+
+                loader = new StyleSheetLoader(testStyleSheets, mockDocument);
+            });
+
+            it("appends one link per stylesheet extension", function () {
+                expect(mockHead.append.calls.length)
+                    .toEqual(testStyleSheets.length);
+            });
+
+            it("appends links to the head", function () {
+                expect(mockDocument.find).toHaveBeenCalledWith('head');
+            });
+
+            it("adjusts link locations", function () {
+                expect(mockElement.setAttribute)
+                    .toHaveBeenCalledWith('href', "a/b/c/d.css");
+            });
+        });
+    }
+);
+
diff --git a/platform/commonUI/general/test/suite.json b/platform/commonUI/general/test/suite.json
index 05169c51b7..0aa52f1503 100644
--- a/platform/commonUI/general/test/suite.json
+++ b/platform/commonUI/general/test/suite.json
@@ -9,5 +9,6 @@
     "controllers/ViewSwitcherController",
     "directives/MCTContainer",
     "directives/MCTDrag",
-    "directives/MCTResize"
+    "directives/MCTResize",
+    "StyleSheetLoader"
 ]
\ No newline at end of file