feat(wizards/subfunction): add create wizard

src/editors/substation/function-editor.ts

@@ -5,11 +5,30 @@ import {
   property,
   customElement,
   state,
+  query,
 } from 'lit-element';
 
 import '../../action-pane.js';
 import './sub-function-editor.js';
-import { getChildElementsByTagName } from '../../foundation.js';
+import {
+  getChildElementsByTagName,
+  newWizardEvent,
+  SCLTag,
+  tags,
+} from '../../foundation.js';
+import { translate } from 'lit-translate';
+import { emptyWizard, wizards } from '../../wizards/wizard-library.js';
+import { Menu } from '@material/mwc-menu';
+import { ListItem } from '@material/mwc-list/mwc-list-item';
+import { IconButton } from '@material/mwc-icon-button';
+
+function childTags(element: Element | null | undefined): SCLTag[] {
+  if (!element) return [];
+
+  return tags[<SCLTag>element.tagName].children.filter(
+    child => wizards[child].create !== emptyWizard
+  );
+}
 
 /** Pane rendering `Function` element with its children */
 @customElement('function-editor')
@@ -26,6 +45,19 @@ export class FunctionEditor extends LitElement {
     return `${name}${desc ? ` - ${desc}` : ''}${type ? ` (${type})` : ''}`;
   }
 
+  @query('mwc-menu') addMenu!: Menu;
+  @query('mwc-icon-button[icon="playlist_add"]') addButton!: IconButton;
+
+  private openCreateWizard(tagName: string): void {
+    const wizard = wizards[<SCLTag>tagName].create(this.element!);
+
+    if (wizard) this.dispatchEvent(newWizardEvent(wizard));
+  }
+
+  firstUpdated(): void {
+    this.addMenu.anchor = <HTMLElement>this.addButton;
+  }
+
   private renderSubFunctions(): TemplateResult {
     const subfunctions = getChildElementsByTagName(this.element, 'SubFunction');
     return html` ${subfunctions.map(
@@ -36,13 +68,42 @@ export class FunctionEditor extends LitElement {
     )}`;
   }
 
+  private renderAddButtons(): TemplateResult[] {
+    return childTags(this.element).map(
+      child =>
+        html`<mwc-list-item value="${child}"
+          ><span>${child}</span></mwc-list-item
+        >`
+    );
+  }
+
   render(): TemplateResult {
     return html`<action-pane
       label="${this.header}"
       icon="functions"
       secondary
       highlighted
-      >${this.renderSubFunctions()}</action-pane
-    >`;
+    >
+      <abbr
+        slot="action"
+        style="position:relative;"
+        title="${translate('add')}"
+      >
+        <mwc-icon-button
+          icon="playlist_add"
+          @click=${() => (this.addMenu.open = true)}
+        ></mwc-icon-button
+        ><mwc-menu
+          corner="BOTTOM_RIGHT"
+          menuCorner="END"
+          @selected=${(e: Event) => {
+            const tagName = (<ListItem>(<Menu>e.target).selected).value;
+            this.openCreateWizard(tagName);
+          }}
+          >${this.renderAddButtons()}</mwc-menu
+        >
+      </abbr>
+      ${this.renderSubFunctions()}
+    </action-pane>`;
   }
 }

src/wizards/function.ts

@@ -16,7 +16,9 @@ interface ContentOptions {
   reservedNames: string[];
 }
 
-function contentFunctionWizard(content: ContentOptions): TemplateResult[] {
+export function contentFunctionWizard(
+  content: ContentOptions
+): TemplateResult[] {
   return [
     html`<wizard-textfield
       label="name"

src/wizards/subfunction.ts

@@ -0,0 +1,56 @@
+import { get } from 'lit-translate';
+
+import {
+  createElement,
+  getValue,
+  Wizard,
+  WizardActor,
+  WizardInputElement,
+} from '../foundation.js';
+import { contentFunctionWizard } from './function.js';
+
+function createSubFunctionAction(parent: Element): WizardActor {
+  return (inputs: WizardInputElement[]) => {
+    const subFunctionAttrs: Record<string, string | null> = {};
+    const subFunctionKeys = ['name', 'desc', 'type'];
+    subFunctionKeys.forEach(key => {
+      subFunctionAttrs[key] = getValue(inputs.find(i => i.label === key)!);
+    });
+
+    const subFunction = createElement(
+      parent.ownerDocument,
+      'SubFunction',
+      subFunctionAttrs
+    );
+
+    return [{ new: { parent, element: subFunction } }];
+  };
+}
+
+export function createSubFunctionWizard(parent: Element): Wizard {
+  const name = '';
+  const desc = null;
+  const type = null;
+  const reservedNames = Array.from(parent.querySelectorAll('SubFunction')).map(
+    fUnction => fUnction.getAttribute('name')!
+  );
+
+  return [
+    {
+      title: get('wizard.title.add', { tagName: 'SubFunction' }),
+      primary: {
+        icon: 'save',
+        label: get('save'),
+        action: createSubFunctionAction(parent),
+      },
+      content: [
+        ...contentFunctionWizard({
+          name,
+          desc,
+          type,
+          reservedNames,
+        }),
+      ],
+    },
+  ];
+}

src/wizards/wizard-library.ts

@@ -25,6 +25,7 @@ import { editTrgOpsWizard } from './trgops.js';
 import { createDaWizard } from './da.js';
 import { editDAIWizard } from './dai.js';
 import { createFunctionWizard } from './function.js';
+import { createSubFunctionWizard } from './subfunction.js';
 
 type SclElementWizard = (
   element: Element,
@@ -476,7 +477,7 @@ export const wizards: Record<
   },
   SubFunction: {
     edit: emptyWizard,
-    create: emptyWizard,
+    create: createSubFunctionWizard,
   },
   SubNetwork: {
     edit: editSubNetworkWizard,

test/integration/editors/substation/function-editor.test.ts

@@ -0,0 +1,87 @@
+import { fixture, html, expect } from '@open-wc/testing';
+
+import '../../../mock-wizard-editor.js';
+import { MockWizardEditor } from '../../../mock-wizard-editor.js';
+
+import '../../../../src/editors/substation/function-editor.js';
+import { FunctionEditor } from '../../../../src/editors/substation/function-editor.js';
+import { WizardTextField } from '../../../../src/wizard-textfield.js';
+
+describe('function-editor wizarding editing integration', () => {
+  describe('open create wizard for element SubFunction', () => {
+    let doc: XMLDocument;
+    let parent: MockWizardEditor;
+    let element: FunctionEditor | null;
+
+    let nameField: WizardTextField;
+    let primaryAction: HTMLElement;
+
+    beforeEach(async () => {
+      doc = await fetch('/test/testfiles/zeroline/functions.scd')
+        .then(response => response.text())
+        .then(str => new DOMParser().parseFromString(str, 'application/xml'));
+      parent = <MockWizardEditor>(
+        await fixture(
+          html`<mock-wizard-editor
+            ><function-editor
+              .element=${doc.querySelector('Function')}
+            ></function-editor
+          ></mock-wizard-editor>`
+        )
+      );
+
+      element = parent.querySelector('function-editor');
+
+      (<HTMLElement>(
+        element?.shadowRoot?.querySelector('mwc-list-item[value="SubFunction"]')
+      )).click();
+      await parent.updateComplete;
+
+      nameField = <WizardTextField>(
+        parent.wizardUI.dialog?.querySelector('wizard-textfield[label="name"]')
+      );
+
+      primaryAction = <HTMLElement>(
+        parent.wizardUI.dialog?.querySelector(
+          'mwc-button[slot="primaryAction"]'
+        )
+      );
+    });
+
+    it('does not add SubFunction if name attribute is not unique', async () => {
+      expect(
+        doc.querySelector(
+          'Substation > Function > SubFunction[name="mySubFunc"]'
+        )
+      ).to.exist;
+
+      nameField.value = 'mySubFunc';
+      primaryAction.click();
+      await parent.updateComplete;
+
+      expect(
+        doc.querySelectorAll(
+          'Substation > Function > SubFunction[name="mySubFunc"]'
+        ).length
+      ).to.equal(1);
+    });
+
+    it('does add SubFunction if name attribute is unique', async () => {
+      expect(
+        doc.querySelector(
+          'Substation > Function > SubFunction[name="someNewFunction"]'
+        )
+      ).to.not.exist;
+
+      nameField.value = 'someNewFunction';
+      await parent.updateComplete;
+      primaryAction.click();
+
+      expect(
+        doc.querySelector(
+          'Substation > Function > SubFunction[name="someNewFunction"]'
+        )
+      ).to.exist;
+    });
+  });
+});

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

@@ -9,6 +9,52 @@ snapshots["web component rendering Function element with complete attribute set
   secondary=""
   tabindex="0"
 >
+  <abbr
+    slot="action"
+    style="position:relative;"
+    title="[add]"
+  >
+    <mwc-icon-button icon="playlist_add">
+    </mwc-icon-button>
+    <mwc-menu
+      corner="BOTTOM_RIGHT"
+      menucorner="END"
+    >
+      <mwc-list-item
+        aria-disabled="false"
+        mwc-list-item=""
+        role="menuitem"
+        tabindex="0"
+        value="LNode"
+      >
+        <span>
+          LNode
+        </span>
+      </mwc-list-item>
+      <mwc-list-item
+        aria-disabled="false"
+        mwc-list-item=""
+        role="menuitem"
+        tabindex="-1"
+        value="SubFunction"
+      >
+        <span>
+          SubFunction
+        </span>
+      </mwc-list-item>
+      <mwc-list-item
+        aria-disabled="false"
+        mwc-list-item=""
+        role="menuitem"
+        tabindex="-1"
+        value="ConductingEquipment"
+      >
+        <span>
+          ConductingEquipment
+        </span>
+      </mwc-list-item>
+    </mwc-menu>
+  </abbr>
   <sub-function-editor>
   </sub-function-editor>
 </action-pane>
@@ -23,6 +69,52 @@ snapshots["web component rendering Function element with missing desc and type a
   secondary=""
   tabindex="0"
 >
+  <abbr
+    slot="action"
+    style="position:relative;"
+    title="[add]"
+  >
+    <mwc-icon-button icon="playlist_add">
+    </mwc-icon-button>
+    <mwc-menu
+      corner="BOTTOM_RIGHT"
+      menucorner="END"
+    >
+      <mwc-list-item
+        aria-disabled="false"
+        mwc-list-item=""
+        role="menuitem"
+        tabindex="0"
+        value="LNode"
+      >
+        <span>
+          LNode
+        </span>
+      </mwc-list-item>
+      <mwc-list-item
+        aria-disabled="false"
+        mwc-list-item=""
+        role="menuitem"
+        tabindex="-1"
+        value="SubFunction"
+      >
+        <span>
+          SubFunction
+        </span>
+      </mwc-list-item>
+      <mwc-list-item
+        aria-disabled="false"
+        mwc-list-item=""
+        role="menuitem"
+        tabindex="-1"
+        value="ConductingEquipment"
+      >
+        <span>
+          ConductingEquipment
+        </span>
+      </mwc-list-item>
+    </mwc-menu>
+  </abbr>
   <sub-function-editor>
   </sub-function-editor>
 </action-pane>

test/unit/wizards/__snapshots__/function.test.snap.js

@@ -1,7 +1,7 @@
 /* @web/test-runner snapshot v1 */
 export const snapshots = {};
 
-snapshots["Wizards for SCL ReportControl element define an create wizard that looks like the the latest snapshot"] = 
+snapshots["Wizards for SCL Function element define an create wizard that looks like the the latest snapshot"] = 
 `<mwc-dialog
   defaultaction="close"
   heading="[wizard.title.add]"
@@ -48,5 +48,5 @@ snapshots["Wizards for SCL ReportControl element define an create wizard that lo
   </mwc-button>
 </mwc-dialog>
 `;
-/* end snapshot Wizards for SCL ReportControl element define an create wizard that looks like the the latest snapshot */
+/* end snapshot Wizards for SCL Function element define an create wizard that looks like the the latest snapshot */