986 edit wizard process

src/editors/substation/process-editor.ts

@@ -8,6 +8,8 @@ import {
   state,
 } from 'lit-element';
 
+import { translate } from 'lit-translate';
+
 import '@material/mwc-icon';
 import '@material/mwc-icon-button';
 import '@material/mwc-menu';
@@ -22,7 +24,9 @@ import './substation-editor.js';
 import './process-editor.js';
 
 import { styles } from './foundation.js';
-import { getChildElementsByTagName } from '../../foundation.js';
+import { newWizardEvent, getChildElementsByTagName } from '../../foundation.js';
+
+import { wizards } from '../../wizards/wizard-library.js';
 
 @customElement('process-editor')
 export class ProcessEditor extends LitElement {
@@ -44,6 +48,11 @@ export class ProcessEditor extends LitElement {
     return `${name} ${desc ? `—${desc}` : ''}`;
   }
 
+  private openEditWizard(): void {
+    const wizard = wizards['Process'].edit(this.element);
+    if (wizard) this.dispatchEvent(newWizardEvent(wizard));
+  }
+
   private renderConductingEquipments(): TemplateResult {
     const ConductingEquipments = getChildElementsByTagName(
       this.element,
@@ -143,6 +152,12 @@ export class ProcessEditor extends LitElement {
 
   render(): TemplateResult {
     return html`<action-pane label=${this.header}>
+      <abbr slot="action" title="${translate('edit')}">
+        <mwc-icon-button
+          icon="edit"
+          @click=${() => this.openEditWizard()}
+        ></mwc-icon-button>
+      </abbr>
       ${this.renderConductingEquipments()}${this.renderGeneralEquipments()}${this.renderFunctions()}${this.renderLNodes()}
       ${this.renderLines()} ${this.renderSubstations()}${this.renderProcesses()}
     </action-pane>`;

src/wizards/process.ts

@@ -0,0 +1,102 @@
+import { html, TemplateResult } from 'lit-element';
+import { get, translate } from 'lit-translate';
+
+import {
+  cloneElement,
+  createElement,
+  getChildElementsByTagName,
+  getValue,
+  SimpleAction,
+  Wizard,
+  WizardActor,
+  WizardInputElement,
+} from '../foundation.js';
+
+function updateProcessAction(element: Element): WizardActor {
+  return (inputs: WizardInputElement[]): SimpleAction[] => {
+    const tapProcessAttrs: Record<string, string | null> = {};
+    const tapProcessKeys = ['name', 'desc', 'type'];
+    tapProcessKeys.forEach(key => {
+      tapProcessAttrs[key] = getValue(inputs.find(i => i.label === key)!);
+    });
+
+    if (
+      tapProcessKeys.some(
+        key => tapProcessAttrs[key] !== element.getAttribute(key)
+      )
+    ) {
+      const newElement = cloneElement(element, tapProcessAttrs);
+      return [
+        {
+          old: { element },
+          new: { element: newElement },
+        },
+      ];
+    }
+    return [];
+  };
+}
+
+interface ContentOptions {
+  name: string | null;
+  desc: string | null;
+  type: string | null;
+  reservedNames: string[];
+}
+
+export function contentProcessWizard(
+  content: ContentOptions
+): TemplateResult[] {
+  return [
+    html`<wizard-textfield
+      label="name"
+      .maybeValue=${content.name}
+      helper="${translate('scl.name')}"
+      required
+      validationMessage="${translate('textfield.required')}"
+      .reservedValues=${content.reservedNames}
+      dialogInitialFocus
+    ></wizard-textfield>`,
+    html`<wizard-textfield
+      label="desc"
+      .maybeValue=${content.desc}
+      nullable
+      helper="${translate('scl.desc')}"
+    ></wizard-textfield>`,
+    html`<wizard-textfield
+      label="type"
+      .maybeValue=${content.type}
+      helper="${translate('scl.type')}"
+    ></wizard-textfield>`,
+  ];
+}
+
+export function editProcessWizard(element: Element): Wizard {
+  const name = element.getAttribute('name');
+  const desc = element.getAttribute('desc');
+  const type = element.getAttribute('type');
+  const reservedNames: string[] = getChildElementsByTagName(
+    element.parentElement!,
+    'Process'
+  )
+    .filter(sibling => sibling !== element)
+    .map(sibling => sibling.getAttribute('name')!);
+  return [
+    {
+      title: get('wizard.title.edit', { tagName: 'Process' }),
+      primary: {
+        icon: 'save',
+        label: get('save'),
+        action: updateProcessAction(element),
+      },
+      content: [
+        ...contentProcessWizard({
+          name,
+          desc,
+          type,
+          reservedNames,
+        }),
+      ],
+    },
+  ];
+}

src/wizards/wizard-library.ts

@@ -50,6 +50,7 @@ import {
 } from './transformerWinding.js';
 import { createTapChangerWizard, editTapChangerWizard } from './tapchanger.js';
 import { createLineWizard, editLineWizard } from './line.js';
+import { editProcessWizard } from './process.js';
 
 type SclElementWizard = (
   element: Element,
@@ -388,7 +389,7 @@ export const wizards: Record<
     create: emptyWizard,
   },
   Process: {
-    edit: emptyWizard,
+    edit: editProcessWizard,
     create: emptyWizard,
   },
   ProtNs: {

test/integration/editors/substation/process-editor-wizard-editing.test.ts

@@ -0,0 +1,130 @@
+import { expect, fixture, html } from '@open-wc/testing';
+
+import '../../../mock-wizard-editor.js';
+import { MockWizardEditor } from '../../../mock-wizard-editor.js';
+
+import '../../../../src/editors/substation/process-editor.js';
+import { ProcessEditor } from '../../../../src/editors/substation/process-editor.js';
+import { WizardTextField } from '../../../../src/wizard-textfield.js';
+
+describe('process-editor wizarding editing integration', () => {
+  let doc: XMLDocument;
+  let parent: MockWizardEditor;
+  let element: ProcessEditor | null;
+
+  describe('edit wizard', () => {
+    let nameField: WizardTextField;
+    let descField: WizardTextField;
+    let typeField: WizardTextField;
+
+    let primaryAction: HTMLElement;
+    let secondaryAction: HTMLElement;
+
+    beforeEach(async () => {
+      doc = await fetch('/test/testfiles/editors/substation/Process.scd')
+        .then(response => response.text())
+        .then(str => new DOMParser().parseFromString(str, 'application/xml'));
+      parent = <MockWizardEditor>(
+        await fixture(
+          html`<mock-wizard-editor
+            ><process-editor
+              .element=${doc.querySelector('Process[name="ProcessGenConduct"]')}
+            ></process-editor
+          ></mock-wizard-editor>`
+        )
+      );
+      element = parent.querySelector('process-editor');
+      await (<HTMLElement>(
+        element?.shadowRoot?.querySelector('mwc-icon-button[icon="edit"]')
+      )).click();
+      await parent.updateComplete;
+
+      nameField = <WizardTextField>(
+        parent.wizardUI.dialog?.querySelector('wizard-textfield[label="name"]')
+      );
+
+      typeField = <WizardTextField>(
+        parent.wizardUI.dialog?.querySelector('wizard-textfield[label="type"]')
+      );
+
+      secondaryAction = <HTMLElement>(
+        parent.wizardUI.dialog?.querySelector(
+          'mwc-button[slot="secondaryAction"]'
+        )
+      );
+      primaryAction = <HTMLElement>(
+        parent.wizardUI.dialog?.querySelector(
+          'mwc-button[slot="primaryAction"]'
+        )
+      );
+    });
+    it('closes on secondary action', async () => {
+      secondaryAction.click();
+      await new Promise(resolve => setTimeout(resolve, 100)); // await animation
+      expect(parent.wizardUI.dialog).to.not.exist;
+    });
+
+    it('does not change name attribute if not unique within parent element', async () => {
+      const oldName = nameField.value;
+      nameField.value = 'ProcProcSubAA1';
+      primaryAction.click();
+      await parent.updateComplete;
+      expect(
+        doc
+          .querySelector('Process[name="ProcessGenConduct"]')
+          ?.getAttribute('name')
+      ).to.equal(oldName);
+    });
+
+    it('changes name attribute on primary action', async () => {
+      nameField.value = 'newName';
+      primaryAction.click();
+      await parent.updateComplete;
+      expect(doc.querySelector('Process')?.getAttribute('name')).to.equal(
+        'newName'
+      );
+    });
+
+    it('changes desc attribute on primary action', async () => {
+      descField = <WizardTextField>(
+        parent.wizardUI.dialog?.querySelector('wizard-textfield[label="desc"]')
+      );
+      await new Promise(resolve => setTimeout(resolve, 100)); // await animation
+      descField.nullSwitch!.click();
+      await parent.updateComplete;
+      descField.value = 'newDesc';
+      console.log(descField.value);
+      primaryAction.click();
+      await parent.updateComplete;
+      expect(
+        doc
+          .querySelector('Process[name="ProcessGenConduct"]')
+          ?.getAttribute('desc')
+      ).to.equal('newDesc');
+    });
+
+    it('deletes desc attribute if wizard-textfield is deactivated', async () => {
+      await new Promise(resolve => setTimeout(resolve, 100)); // await animation
+      descField.nullSwitch!.click();
+      await parent.updateComplete;
+      await primaryAction.click();
+      await parent.updateComplete;
+      expect(
+        doc
+          .querySelector('Process[name="ProcessGenConduct"]')
+          ?.getAttribute('desc')
+      ).to.be.null;
+    });
+
+    it('changes type attribute on primary action', async () => {
+      typeField.value = 'newType';
+      primaryAction.click();
+      await parent.updateComplete;
+      expect(
+        doc
+          .querySelector('Process[name="ProcessGenConduct"]')
+          ?.getAttribute('type')
+      ).to.equal('newType');
+    });
+  });
+});

test/integration/editors/substation/zeroline-pane.test.ts

@@ -6,7 +6,6 @@ import { MockWizardEditor } from '../../../mock-wizard-editor.js';
 import '../../../../src/editors/substation/zeroline-pane.js';
 import { FilteredList } from '../../../../src/filtered-list.js';
 import { ZerolinePane } from '../../../../src/editors/substation/zeroline-pane.js';
-
 import { WizardTextField } from '../../../../src/wizard-textfield.js';
 import { IconButton } from '@material/mwc-icon-button';
 import { ListItem } from '@material/mwc-list/mwc-list-item';

test/unit/editors/substation/__snapshots__/process-editor.test.snap.js

@@ -6,6 +6,13 @@ snapshots["web component rendering Process element rendering LNode, GeneralEquip
   label="ProcessGenConduct "
   tabindex="0"
 >
+  <abbr
+    slot="action"
+    title="[edit]"
+  >
+    <mwc-icon-button icon="edit">
+    </mwc-icon-button>
+  </abbr>
   <conducting-equipment-editor showfunctions="">
   </conducting-equipment-editor>
   <general-equipment-editor showfunctions="">
@@ -25,6 +32,13 @@ snapshots["web component rendering Process element hides LNode and Function chil
   label="ProcessGenConduct "
   tabindex="0"
 >
+  <abbr
+    slot="action"
+    title="[edit]"
+  >
+    <mwc-icon-button icon="edit">
+    </mwc-icon-button>
+  </abbr>
   <conducting-equipment-editor>
   </conducting-equipment-editor>
   <general-equipment-editor>
@@ -38,6 +52,13 @@ snapshots["web component rendering Process element rendering Substation and Proc
   label="ProcProcSubAA1 "
   tabindex="0"
 >
+  <abbr
+    slot="action"
+    title="[edit]"
+  >
+    <mwc-icon-button icon="edit">
+    </mwc-icon-button>
+  </abbr>
   <substation-editor showfunctions="">
   </substation-editor>
   <process-editor showfunctions="">
@@ -51,6 +72,13 @@ snapshots["web component rendering Process element rendering a Line child looks
   label="ProcessLine "
   tabindex="0"
 >
+  <abbr
+    slot="action"
+    title="[edit]"
+  >
+    <mwc-icon-button icon="edit">
+    </mwc-icon-button>
+  </abbr>
   <line-editor showfunctions="">
   </line-editor>
 </action-pane>