Fix for opening files and fixed some tests.

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

Author: Dennis Labordus

src/compas/CompasExistsIn.ts

@@ -26,24 +26,20 @@ export function CompasExistsIn<TBase extends LitElementConstructor>(
     protected updated(_changedProperties: PropertyValues): void {
       super.updated(_changedProperties);
 
-      if (
-        _changedProperties.has('docId') ||
-        _changedProperties.has('docName')
-      ) {
+      if (_changedProperties.has('docId')) {
+        this.existInCompas = undefined;
         this.checkExistInCompas();
       }
     }
 
     callService(docType: string, docId: string) {
+      // Use the versions call to check if any exist, because then the document also exists
+      // And it saves bandwidth not to retrieve the whole document.
       return CompasSclDataService().listVersions(docType, docId);
     }
 
     checkExistInCompas(): void {
-      this.existInCompas = undefined;
-
       if (this.docId) {
-        // Use the versions call to check if any exist, because then the document also exists
-        // And it saves bandwidth not to retrieve the whole document.
         const docType = getTypeFromDocName(this.docName);
         this.callService(docType, this.docId)
           .then(() => (this.existInCompas = true))

src/compas/CompasOpen.ts

@@ -23,18 +23,20 @@ import './CompasScl.js';
 
 /* Event that will be used when a SCL Document is retrieved. */
 export interface DocRetrievedDetail {
+  localFile: boolean;
   doc: Document;
   docName?: string;
 }
 export type DocRetrievedEvent = CustomEvent<DocRetrievedDetail>;
 export function newDocRetrievedEvent(
+  localFile: boolean,
   doc: Document,
   docName?: string
 ): DocRetrievedEvent {
   return new CustomEvent<DocRetrievedDetail>('docRetrieved', {
     bubbles: true,
     composed: true,
-    detail: { doc, docName },
+    detail: { localFile, doc, docName },
   });
 }
 
@@ -51,7 +53,7 @@ export default class CompasOpenElement extends LitElement {
       .getSclDocument(this.selectedType ?? '', id ?? '')
       .catch(reason => createLogEvent(this, reason));
     if (sclDocument instanceof Document) {
-      this.dispatchEvent(newDocRetrievedEvent(sclDocument));
+      this.dispatchEvent(newDocRetrievedEvent(false, sclDocument));
     }
   }
 
@@ -63,7 +65,7 @@ export default class CompasOpenElement extends LitElement {
     const docName = file.name;
     const doc = new DOMParser().parseFromString(text, 'application/xml');
 
-    this.dispatchEvent(newDocRetrievedEvent(doc, docName));
+    this.dispatchEvent(newDocRetrievedEvent(true, doc, docName));
     this.sclFileUI.onchange = null;
   }
 

src/compas/CompasSclTypeSelect.ts

@@ -17,6 +17,7 @@ import {
   SDS_NAMESPACE,
 } from '../compas-services/CompasSclDataService.js';
 import { Select } from '@material/mwc-select';
+import { repeat } from 'lit-html/directives/repeat';
 
 @customElement('compas-scltype-select')
 export class CompasSclTypeSelect extends LitElement {
@@ -37,12 +38,15 @@ export class CompasSclTypeSelect extends LitElement {
   }
 
   getSelectedValue(): string | null {
-    return (<Select>this.shadowRoot!.querySelector('mwc-select'))?.value;
+    return (
+      (<Select>this.shadowRoot!.querySelector('mwc-select'))?.selected?.value ??
+      null
+    );
   }
 
   valid(): boolean {
     const newValue = this.getSelectedValue();
-    return newValue !== null && newValue !== undefined;
+    return !!newValue;
   }
 
   render(): TemplateResult {
@@ -60,20 +64,26 @@ export class CompasSclTypeSelect extends LitElement {
       naturalMenuWidth="true"
       label="${translate('compas.sclType')}"
     >
-      ${this.sclTypes.map(type => {
-        const code =
+      ${repeat(
+        this.sclTypes,
+        type =>
           type.getElementsByTagNameNS(SDS_NAMESPACE, 'Code').item(0)!
-            .textContent ?? '';
-        const description =
-          type.getElementsByTagNameNS(SDS_NAMESPACE, 'Description').item(0)!
-            .textContent ?? '';
-        return html`<mwc-list-item
-          value="${code}"
-          ?selected="${code === this.value}"
-        >
-          <span>${description} (${code})</span>
-        </mwc-list-item>`;
-      })}
+            .textContent ?? '',
+        type => {
+          const code =
+            type.getElementsByTagNameNS(SDS_NAMESPACE, 'Code').item(0)!
+              .textContent ?? '';
+          const description =
+            type.getElementsByTagNameNS(SDS_NAMESPACE, 'Description').item(0)!
+              .textContent ?? '';
+          return html`<mwc-list-item
+            value="${code}"
+            ?selected="${code === this.value}"
+          >
+            <span>${description} (${code})</span>
+          </mwc-list-item>`;
+        }
+      )}
     </mwc-select>`;
   }
 

src/menu/CompasOpen.ts

@@ -1,7 +1,13 @@
 import { html, LitElement } from 'lit-element';
 import { get } from 'lit-translate';
 
-import { newPendingStateEvent, newWizardEvent, Wizard } from '../foundation.js';
+import {
+  newLogEvent,
+  newOpenDocEvent,
+  newPendingStateEvent,
+  newWizardEvent,
+  Wizard,
+} from '../foundation.js';
 
 import { DocRetrievedEvent } from '../compas/CompasOpen.js';
 import { updateDocumentInOpenSCD } from '../compas/foundation.js';
@@ -14,8 +20,17 @@ export default class CompasOpenMenuPlugin extends LitElement {
       plugin: CompasOpenMenuPlugin,
       event: DocRetrievedEvent
     ): Promise<void> {
-      updateDocumentInOpenSCD(plugin, event.detail.doc, event.detail.docName);
-      plugin.dispatchEvent(newWizardEvent());
+      if (event.detail.localFile) {
+        plugin.dispatchEvent(newLogEvent({ kind: 'reset' }));
+        plugin.dispatchEvent(
+          newOpenDocEvent(event.detail.doc, event.detail.docName!, {
+            detail: { docId: undefined },
+          })
+        );
+      } else {
+        updateDocumentInOpenSCD(plugin, event.detail.doc, event.detail.docName);
+        plugin.dispatchEvent(newWizardEvent());
+      }
     }
 
     return [

src/menu/CompasSave.ts

@@ -30,6 +30,7 @@ export default class CompasSaveMenuPlugin extends LitElement {
   compasSaveElement!: CompasSaveElement;
 
   async run(): Promise<void> {
+    await this.compasSaveElement.requestUpdate();
     this.dialog.open = true;
   }
 

src/wizard-textfield.ts

@@ -122,7 +122,8 @@ export class WizardTextField extends TextField {
       this.setCustomValidity(get('textfield.unique'));
       return false;
     }
-    this.setCustomValidity(''); //Reset. Otherwise super.checkValidity always falseM
+    // Reset to prevent super.checkValidity to always return false
+    this.setCustomValidity('');
     return super.checkValidity();
   }
 

test/unit/compas/CompasComment.test.ts

@@ -1,5 +1,4 @@
 import { expect, fixture, html } from '@open-wc/testing';
-import { WizardTextField } from '../../../src/wizard-textfield.js';
 
 import { CompasCommentElement } from '../../../src/compas/CompasComment.js';
 import '../../../src/compas/CompasComment.js';
@@ -10,31 +9,22 @@ describe('compas-comment', () => {
     element = await fixture(html`<compas-comment></compas-comment>`);
   });
 
-  it('will always be valid', () => {
-    // When nothing entered it will be valid.
+  it('will be valid', () => {
+    // When nothing entered it will also be valid.
     expect(element.valid()).to.be.true;
 
-    setValue('Some comments');
+    element.value = 'Some comments';
     expect(element.valid()).to.be.true;
   });
 
   it('will return entered value', () => {
     const value = 'Some comments';
-    setValue(value);
+    element.value = value;
 
     expect(element.value).to.be.equal(value);
   });
 
   it('looks like the latest snapshot', async () => {
     await expect(element).shadowDom.to.equalSnapshot();
   });
-
-  function setValue(value: string) {
-    const item = <WizardTextField>(
-      element
-        .shadowRoot!.querySelectorAll('wizard-textfield[id="comment"]')
-        .item(0)
-    );
-    item.value = value;
-  }
 });

test/unit/compas/CompasExistsIn.test.ts

@@ -1,9 +1,17 @@
-import {customElement, LitElement} from "lit-element";
-import {expect, fixtureSync, html, waitUntil} from "@open-wc/testing";
-import sinon, {SinonStub} from "sinon";
+import { expect, fixtureSync, html, waitUntil } from '@open-wc/testing';
+import sinon, { SinonStub } from 'sinon';
 
-import {NOT_FOUND_ERROR, SERVER_ERROR} from "../../../src/compas-services/foundation.js";
-import {CompasExistsIn, CompasExistsInElement} from "../../../src/compas/CompasExistsIn.js";
+import { customElement, LitElement } from 'lit-element';
+
+import {
+  NOT_FOUND_ERROR,
+  SERVER_ERROR,
+} from '../../../src/compas-services/foundation.js';
+
+import {
+  CompasExistsIn,
+  CompasExistsInElement,
+} from '../../../src/compas/CompasExistsIn.js';
 
 @customElement('mock-compas-exists-in')
 export class MockSetter extends CompasExistsIn(LitElement) {}
@@ -16,7 +24,8 @@ describe('CompasExistsInElement', () => {
     beforeEach(async () => {
       // Overwrite, because this scenario is the only on different.
       element = fixtureSync(
-        html`<mock-compas-exists-in></mock-compas-exists-in>`);
+        html`<mock-compas-exists-in></mock-compas-exists-in>`
+      );
 
       stubCallService = sinon.stub(element, 'callService').callsFake(() => {
         return Promise.reject();
@@ -35,10 +44,16 @@ describe('CompasExistsInElement', () => {
   describe('when service call returns a message', () => {
     beforeEach(async () => {
       element = fixtureSync(
-        html`<mock-compas-exists-in docId="some-id" docName="some-scl.scd"></mock-compas-exists-in>`);
+        html`<mock-compas-exists-in
+          docId="some-id"
+          docName="some-scl.scd"
+        ></mock-compas-exists-in>`
+      );
 
       stubCallService = sinon.stub(element, 'callService').callsFake(() => {
-        const doc = <Document>document.implementation.createDocument("", "", null);
+        const doc = <Document>(
+          document.implementation.createDocument('', '', null)
+        );
         return Promise.resolve(doc);
       });
 
@@ -48,17 +63,21 @@ describe('CompasExistsInElement', () => {
 
     it('the document exists', () => {
       expect(element.existInCompas).to.be.equal(true);
-      sinon.assert.calledOnce(stubCallService)
+      sinon.assert.calledTwice(stubCallService);
     });
   });
 
   describe('when service call returns a not found error', () => {
     beforeEach(async () => {
       element = fixtureSync(
-        html`<mock-compas-exists-in docId="some-id" docName="some-scl.scd"></mock-compas-exists-in>`);
+        html`<mock-compas-exists-in
+          docId="some-id"
+          docName="some-scl.scd"
+        ></mock-compas-exists-in>`
+      );
 
       stubCallService = sinon.stub(element, 'callService').callsFake(() => {
-        return Promise.reject({type: NOT_FOUND_ERROR});
+        return Promise.reject({ type: NOT_FOUND_ERROR });
       });
 
       await element;
@@ -67,25 +86,29 @@ describe('CompasExistsInElement', () => {
 
     it('the document does not exists', () => {
       expect(element.existInCompas).to.be.equal(false);
-      sinon.assert.calledOnce(stubCallService)
+      sinon.assert.calledTwice(stubCallService);
     });
   });
 
   describe('when service call returns a other error', () => {
     beforeEach(async () => {
       element = fixtureSync(
-        html`<mock-compas-exists-in docId="some-id" docName="some-scl.scd"></mock-compas-exists-in>`);
+        html`<mock-compas-exists-in
+          docId="some-id"
+          docName="some-scl.scd"
+        ></mock-compas-exists-in>`
+      );
 
       stubCallService = sinon.stub(element, 'callService').callsFake(() => {
-        return Promise.reject({type: SERVER_ERROR});
+        return Promise.reject({ type: SERVER_ERROR });
       });
 
       await element;
     });
 
     it('boolean stays undefined', () => {
       expect(element.existInCompas).to.be.undefined;
-      sinon.assert.calledOnce(stubCallService)
+      sinon.assert.calledTwice(stubCallService);
     });
   });