Merge pull request #3243 from nasa/iso-date-format

Merging new ISODateFormatter

src/plugins/ISOTimeFormat/ISOTimeFormat.js

@@ -0,0 +1,47 @@
+/*****************************************************************************
+ * Open MCT, Copyright (c) 2014-2020, United States Government
+ * as represented by the Administrator of the National Aeronautics and Space
+ * Administration. All rights reserved.
+ *
+ * Open MCT is licensed under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * Open MCT includes source code licensed under additional open source
+ * licenses. See the Open Source Licenses file (LICENSES.md) included with
+ * this source code distribution or the Licensing information page available
+ * at runtime from the About dialog for additional information.
+ *****************************************************************************/
+
+export default class ISOTimeFormat {
+    constructor() {
+        this.key = 'iso';
+    }
+
+    format(value) {
+        if (value !== undefined) {
+            return new Date(value).toISOString();
+        } else {
+            return value;
+        }
+    }
+
+    parse(text) {
+        if (typeof text === 'number' || text === undefined) {
+            return text;
+        }
+
+        return Date.parse(text);
+    }
+
+    validate(text) {
+        return !isNaN(Date.parse(text));
+    }
+}

src/plugins/ISOTimeFormat/plugin.js

@@ -0,0 +1,29 @@
+/*****************************************************************************
+ * Open MCT, Copyright (c) 2014-2020, United States Government
+ * as represented by the Administrator of the National Aeronautics and Space
+ * Administration. All rights reserved.
+ *
+ * Open MCT is licensed under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * Open MCT includes source code licensed under additional open source
+ * licenses. See the Open Source Licenses file (LICENSES.md) included with
+ * this source code distribution or the Licensing information page available
+ * at runtime from the About dialog for additional information.
+ *****************************************************************************/
+
+import ISOTimeFormat from './ISOTimeFormat';
+
+export default function () {
+    return function install(openmct) {
+        openmct.telemetry.addFormat(new ISOTimeFormat());
+    };
+}

src/plugins/ISOTimeFormat/pluginSpec.js

@@ -0,0 +1,55 @@
+/*****************************************************************************
+ * Open MCT, Copyright (c) 2014-2020, United States Government
+ * as represented by the Administrator of the National Aeronautics and Space
+ * Administration. All rights reserved.
+ *
+ * Open MCT is licensed under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ *
+ * Open MCT includes source code licensed under additional open source
+ * licenses. See the Open Source Licenses file (LICENSES.md) included with
+ * this source code distribution or the Licensing information page available
+ * at runtime from the About dialog for additional information.
+ *****************************************************************************/
+
+import ISOTimeFormat from './ISOTimeFormat.js';
+
+describe("the plugin", () => {
+    const ISO_KEY = 'iso';
+    const JUNK = "junk";
+    const MOON_LANDING_TIMESTAMP = -14256000000;
+    const MOON_LANDING_DATESTRING = '1969-07-20T00:00:00.000Z';
+    let isoFormatter;
+
+    beforeEach(() => {
+        isoFormatter = new ISOTimeFormat();
+    });
+
+    describe("creates a new ISO based formatter", function () {
+
+        it("with the key 'iso'", () => {
+            expect(isoFormatter.key).toBe(ISO_KEY);
+        });
+
+        it("that will format a timestamp in ISO standard format", () => {
+            expect(isoFormatter.format(MOON_LANDING_TIMESTAMP)).toBe(MOON_LANDING_DATESTRING);
+        });
+
+        it("that will parse an ISO Date String into milliseconds", () => {
+            expect(isoFormatter.parse(MOON_LANDING_DATESTRING)).toBe(MOON_LANDING_TIMESTAMP);
+        });
+
+        it("that will validate correctly", () => {
+            expect(isoFormatter.validate(MOON_LANDING_DATESTRING)).toBe(true);
+            expect(isoFormatter.validate(JUNK)).toBe(false);
+        });
+    });
+});

src/plugins/plugins.js

@@ -24,6 +24,7 @@ define([
     'lodash',
     './utcTimeSystem/plugin',
     './localTimeSystem/plugin',
+    './ISOTimeFormat/plugin',
     '../../example/generator/plugin',
     './autoflow/AutoflowTabularPlugin',
     './timeConductor/plugin',
@@ -61,6 +62,7 @@ define([
     _,
     UTCTimeSystem,
     LocalTimeSystem,
+    ISOTimeFormat,
     GeneratorPlugin,
     AutoflowPlugin,
     TimeConductorPlugin,
@@ -184,6 +186,7 @@ define([
     plugins.URLTimeSettingsSynchronizer = URLTimeSettingsSynchronizer.default;
     plugins.NotificationIndicator = NotificationIndicator.default;
     plugins.NewFolderAction = NewFolderAction.default;
+    plugins.ISOTimeFormat = ISOTimeFormat.default;
     plugins.DefaultRootName = DefaultRootName.default;
 
     return plugins;