mirror of
https://github.com/nasa/openmct.git
synced 2024-12-23 23:12:23 +00:00
[Common UI] Add JSDoc, remove UUIDService
Add JSDoc to Create-related classes and remove the UUIDService (replaced by third-party lib) to reduce amount of code to cover and prepare for code review, as part of ongoing transition of common user interface elements, WTD-574.
This commit is contained in:
parent
242d40fab2
commit
b97e2d0324
platform/commonUI/browse
@ -72,11 +72,7 @@
|
||||
{
|
||||
"key": "creationService",
|
||||
"implementation": "creation/CreationService.js",
|
||||
"depends": [ "persistenceService", "uuidService", "$q", "$log" ]
|
||||
},
|
||||
{
|
||||
"key": "uuidService",
|
||||
"implementation": "creation/UUIDService.js"
|
||||
"depends": [ "persistenceService", "$q", "$log" ]
|
||||
}
|
||||
],
|
||||
"actions": [
|
||||
|
40
platform/commonUI/browse/lib/uuid.js
Normal file
40
platform/commonUI/browse/lib/uuid.js
Normal file
@ -0,0 +1,40 @@
|
||||
/*global define*/
|
||||
|
||||
|
||||
/*
|
||||
Adapted from:
|
||||
Math.uuid.js (v1.4)
|
||||
http://www.broofa.com
|
||||
mailto:robert@broofa.com
|
||||
|
||||
Copyright (c) 2010 Robert Kieffer
|
||||
Dual licensed under the MIT and GPL licenses.
|
||||
*/
|
||||
define(
|
||||
function () {
|
||||
'use strict';
|
||||
return function generateUUID() {
|
||||
var chars = ['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'],
|
||||
uuid = new Array(36),
|
||||
rnd = 0,
|
||||
r,
|
||||
i,
|
||||
offset = Math.floor(Date.now()) % 0xF;
|
||||
for (i = 0; i < 36; i = i + 1) {
|
||||
if (i === 8 || i === 13 || i === 18 || i === 23) {
|
||||
uuid[i] = '-';
|
||||
} else if (i === 14) {
|
||||
uuid[i] = '4';
|
||||
} else {
|
||||
if (rnd <= 0x02) {
|
||||
rnd = 0x2000000 + Math.floor(Math.random() * 0x1000000);
|
||||
}
|
||||
r = rnd % 0xf;
|
||||
rnd = Math.floor(rnd / 16);
|
||||
uuid[i] = chars[(i === 19) ? ((r % 0x3) + 0x8) : r];
|
||||
}
|
||||
}
|
||||
return uuid.join('');
|
||||
};
|
||||
}
|
||||
);
|
@ -24,6 +24,14 @@ define(
|
||||
properties = type.getProperties();
|
||||
|
||||
return {
|
||||
/**
|
||||
* Get the form model for this wizard; this is a description
|
||||
* that will be rendered to an HTML form. See the
|
||||
* platform/forms bundle
|
||||
*
|
||||
* @return {FormModel} formModel the form model to
|
||||
* show in the create dialog
|
||||
*/
|
||||
getFormModel: function () {
|
||||
var parentRow = Object.create(parent),
|
||||
sections = [];
|
||||
@ -51,9 +59,19 @@ define(
|
||||
name: "Create a New " + type.getName()
|
||||
};
|
||||
},
|
||||
/**
|
||||
* Based on a populated form, get the domain object which
|
||||
* should be used as a parent for the newly-created object.
|
||||
* @return {DomainObject}
|
||||
*/
|
||||
getLocation: function (formValue) {
|
||||
return formValue.createParent || parent;
|
||||
},
|
||||
/**
|
||||
* Create the domain object model for a newly-created object,
|
||||
* based on user input read from a formModel.
|
||||
* @return {object} the domain object' model
|
||||
*/
|
||||
createModel: function (formValue) {
|
||||
// Clone
|
||||
var newModel = JSON.parse(JSON.stringify(model));
|
||||
|
@ -4,8 +4,8 @@
|
||||
* Module defining CreateService. Created by vwoeltje on 11/10/14.
|
||||
*/
|
||||
define(
|
||||
[],
|
||||
function () {
|
||||
["../../lib/uuid"],
|
||||
function (uuid) {
|
||||
"use strict";
|
||||
|
||||
var NON_PERSISTENT_WARNING =
|
||||
@ -14,10 +14,11 @@ define(
|
||||
"Could not add to composition; no composition in ";
|
||||
|
||||
/**
|
||||
*
|
||||
* The creation service is responsible for instantiating and
|
||||
* persisting new domain objects. This is
|
||||
* @constructor
|
||||
*/
|
||||
function CreationService(persistenceService, uuidService, $q, $log) {
|
||||
function CreationService(persistenceService, $q, $log) {
|
||||
|
||||
function doPersist(space, id, model) {
|
||||
return persistenceService.createObject(
|
||||
@ -66,7 +67,7 @@ define(
|
||||
if (persistence) {
|
||||
space = persistence.getSpace();
|
||||
return $q.when(
|
||||
uuidService.getUUID()
|
||||
uuid()
|
||||
).then(function (id) {
|
||||
return doPersist(space, id, model);
|
||||
}).then(function (id) {
|
||||
|
@ -1,29 +0,0 @@
|
||||
/*global define,Promise*/
|
||||
|
||||
/**
|
||||
* Module defining UUIDService. Created by vwoeltje on 11/12/14.
|
||||
*/
|
||||
define(
|
||||
[],
|
||||
function () {
|
||||
"use strict";
|
||||
|
||||
/**
|
||||
*
|
||||
* @constructor
|
||||
*/
|
||||
function UUIDService() {
|
||||
var counter = Date.now();
|
||||
|
||||
return {
|
||||
getUUID: function () {
|
||||
counter += 1;
|
||||
return counter.toString(36);
|
||||
}
|
||||
|
||||
};
|
||||
}
|
||||
|
||||
return UUIDService;
|
||||
}
|
||||
);
|
Loading…
Reference in New Issue
Block a user