Small refactoring and added test for the plugin components.

Signed-off-by: Dennis Labordus <[email protected]>

Author: Dennis Labordus

src/locamation/LocamationLNEdit.ts

@@ -26,11 +26,14 @@ export class LocamationVMUEditElement extends LitElement {
   @property()
   nsdoc!: Nsdoc;
 
+  get inputs(): WizardInput[] {
+    return Array.from(this.shadowRoot!.querySelectorAll(wizardInputSelector));
+  }
+
   save(): WizardAction[] {
-    const inputs: WizardInput[] = Array.from(this.shadowRoot!.querySelectorAll(wizardInputSelector));
     const locamationPrivate = getPrivate(this.logicalNode);
 
-    if (!this.fieldsChanged(locamationPrivate, inputs) || !this.checkValidityInputs(inputs)) {
+    if (!this.fieldsChanged(locamationPrivate, this.inputs) || !this.checkValidityInputs(this.inputs)) {
       return [];
     }
 
@@ -39,19 +42,19 @@ export class LocamationVMUEditElement extends LitElement {
       title: get('locamation.vmu.updateAction', {lnName: lnHeader(this.logicalNode, this.nsdoc)}),
     };
 
-    complexAction.actions.push(...createEditorAction(locamationPrivate, 'IDENTIFIER', getInputFieldValue(inputs, 'identifier')));
+    complexAction.actions.push(...createEditorAction(locamationPrivate, 'IDENTIFIER', getInputFieldValue(this.inputs, 'identifier')));
     if (hasPrivateElement(this.logicalNode, 'SUM')) {
-      complexAction.actions.push(...createEditorAction(locamationPrivate, 'SUM', getInputFieldValue(inputs, 'sum')));
+      complexAction.actions.push(...createEditorAction(locamationPrivate, 'SUM', getInputFieldValue(this.inputs, 'sum')));
     } else {
-      complexAction.actions.push(...createEditorAction(locamationPrivate, 'CHANNEL', getInputFieldValue(inputs, 'channel')));
+      complexAction.actions.push(...createEditorAction(locamationPrivate, 'CHANNEL', getInputFieldValue(this.inputs, 'channel')));
     }
-    complexAction.actions.push(...createEditorAction(locamationPrivate, 'TRANSFORM-PRIMARY', getInputFieldValue(inputs, 'transformPrimary')));
-    complexAction.actions.push(...createEditorAction(locamationPrivate, 'TRANSFORM-SECONDARY', getInputFieldValue(inputs, 'transformSecondary')));
+    complexAction.actions.push(...createEditorAction(locamationPrivate, 'TRANSFORM-PRIMARY', getInputFieldValue(this.inputs, 'transformPrimary')));
+    complexAction.actions.push(...createEditorAction(locamationPrivate, 'TRANSFORM-SECONDARY', getInputFieldValue(this.inputs, 'transformSecondary')));
 
     return complexAction.actions.length ? [complexAction] : [];
   }
 
-  private fieldsChanged(locamationPrivate: Element, inputs: WizardInput[]): boolean {
+  private fieldsChanged(locamationPrivate: Element | null, inputs: WizardInput[]): boolean {
     const oldIdentifier= getPrivateTextValue(locamationPrivate, 'IDENTIFIER');
     const oldChannel = getPrivateTextValue(locamationPrivate, 'CHANNEL');
     const oldSum = getPrivateTextValue(locamationPrivate, 'SUM');

src/locamation/foundation.ts

@@ -22,7 +22,7 @@ export function lnHeader(ln: Element, nsDoc: Nsdoc): string {
 
   const data = nsDoc.getDataDescription(ln);
 
-  return `${prefix != null ? `${prefix} - ` : ``} ${data.label} ${inst ? ` - ${inst}` : ``}`;
+  return `${prefix != null ? `${prefix} - ` : ``}${data.label}${inst ? ` - ${inst}` : ``}`;
 }
 
 export function lDeviceHeader(lDevice: Element): string {
@@ -34,9 +34,9 @@ export function lDeviceHeader(lDevice: Element): string {
 
 export function iedHeader(ied: Element): string {
   const name = getNameAttribute(ied);
-  const description = getDescriptionAttribute(ied);
+  const desc = getDescriptionAttribute(ied);
 
-  return `${name}${description !== undefined ? ' (' + description + ')' : ''}`;
+  return `${name}${desc ? ' (' + desc + ')' : ''}`;
 }
 
 
@@ -60,30 +60,35 @@ export function addPrefixAndNamespaceToDocument(element: Element): void {
   }
 }
 
-export function getPrivate(element: Element): Element {
+export function getPrivate(element: Element): Element | null {
   return element.querySelector(`Private[type="${LOCAMATION_PRIVATE}"]`)!;
 }
 
-export function createEditorAction(locamationPrivate: Element, fieldType: string, value: string | null): SimpleAction[] {
-  let privateField = Array.from(locamationPrivate.querySelectorAll(`P[type="${fieldType}"]`))
-    .filter(element => element.namespaceURI === LOCAMATION_NS)
-    .pop();
-  if (!privateField) {
-    // Make sure the namespace is configured on the root element with the known prefix.
-    addPrefixAndNamespaceToDocument(locamationPrivate);
-
-    privateField = locamationPrivate.ownerDocument.createElementNS(LOCAMATION_NS, "P");
-    privateField.setAttribute("type", fieldType);
-    privateField.textContent = value;
-    return [{new: {parent: locamationPrivate, element: privateField}}];
-  }
+export function createEditorAction(locamationPrivate: Element | null, fieldType: string, value: string | null): SimpleAction[] {
+  if (locamationPrivate) {
+    let privateField = Array.from(locamationPrivate.querySelectorAll(`P[type="${fieldType}"]`))
+      .filter(element => element.namespaceURI === LOCAMATION_NS)
+      .pop();
+    if (!privateField) {
+      // Make sure the namespace is configured on the root element with the known prefix.
+      addPrefixAndNamespaceToDocument(locamationPrivate);
+
+      privateField = locamationPrivate.ownerDocument.createElementNS(LOCAMATION_NS, "P");
+      privateField.setAttribute("type", fieldType);
+      privateField.textContent = value;
+      return [{new: {parent: locamationPrivate, element: privateField}}];
+    }
 
-  const newPrivateField = cloneElement(privateField, {});
-  newPrivateField.textContent = value;
-  return [{old: {element: privateField}, new: {element: newPrivateField}}];
+    if (privateField.textContent !== value) {
+      const newPrivateField = cloneElement(privateField, {});
+      newPrivateField.textContent = value;
+      return [{old: {element: privateField}, new: {element: newPrivateField}}];
+    }
+  }
+  return [];
 }
 
-export function hasPrivateElement(locamationPrivate: Element, type: string): boolean {
+export function hasPrivateElement(locamationPrivate: Element | null, type: string): boolean {
   if (locamationPrivate) {
     return Array.from(locamationPrivate.querySelectorAll(`P[type="${type}"]`))
       .filter(element => element.namespaceURI === LOCAMATION_NS)
@@ -92,7 +97,7 @@ export function hasPrivateElement(locamationPrivate: Element, type: string): boo
   return false;
 }
 
-export function getPrivateTextValue(locamationPrivate: Element, type: string): string | null {
+export function getPrivateTextValue(locamationPrivate: Element | null, type: string): string | null {
   if (locamationPrivate) {
     const privateElement =
       Array.from(locamationPrivate.querySelectorAll(`P[type="${type}"]`))