From 7774c3c83c2fac48ca0e1cf1f5d64ea61f0a26b2 Mon Sep 17 00:00:00 2001
From: Kristof De Langhe <kristof.delanghe@atmire.com>
Date: Fri, 12 Jul 2019 15:11:38 +0200
Subject: [PATCH] 63669: Content Source valid check + JSDocs

---
 .../collection-source.component.html          |  4 +-
 .../collection-source.component.ts            | 41 ++++++++++++++++++-
 src/app/core/shared/content-source.model.ts   |  4 ++
 3 files changed, 46 insertions(+), 3 deletions(-)

diff --git a/src/app/+collection-page/edit-collection-page/collection-source/collection-source.component.html b/src/app/+collection-page/edit-collection-page/collection-source/collection-source.component.html
index 2017f172c5..71f03e2a9f 100644
--- a/src/app/+collection-page/edit-collection-page/collection-source/collection-source.component.html
+++ b/src/app/+collection-page/edit-collection-page/collection-source/collection-source.component.html
@@ -11,7 +11,7 @@
       class="fas fa-undo-alt"></i>
       <span class="d-none d-sm-inline">&nbsp;{{"item.edit.metadata.reinstate-button" | translate}}</span>
     </button>
-    <button class="btn btn-primary" [disabled]="!(hasChanges() | async)"
+    <button class="btn btn-primary" [disabled]="!(hasChanges() | async) || !isValid()"
             (click)="onSubmit()"><i
       class="fas fa-save"></i>
       <span class="d-none d-sm-inline">&nbsp;{{"item.edit.metadata.save-button" | translate}}</span>
@@ -46,7 +46,7 @@
       class="fas fa-undo-alt"></i>
       <span class="d-none d-sm-inline">&nbsp;{{"item.edit.metadata.reinstate-button" | translate}}</span>
     </button>
-    <button class="btn btn-primary" [disabled]="!(hasChanges() | async)"
+    <button class="btn btn-primary" [disabled]="!(hasChanges() | async) || !isValid()"
             (click)="onSubmit()"><i
       class="fas fa-save"></i>
       <span class="d-none d-sm-inline">&nbsp;{{"item.edit.metadata.save-button" | translate}}</span>
diff --git a/src/app/+collection-page/edit-collection-page/collection-source/collection-source.component.ts b/src/app/+collection-page/edit-collection-page/collection-source/collection-source.component.ts
index a9696a23f0..68e54c8a8d 100644
--- a/src/app/+collection-page/edit-collection-page/collection-source/collection-source.component.ts
+++ b/src/app/+collection-page/edit-collection-page/collection-source/collection-source.component.ts
@@ -194,6 +194,9 @@ export class CollectionSourceComponent extends AbstractTrackableComponent implem
     super(objectUpdatesService, notificationsService, translate);
   }
 
+  /**
+   * Initialize properties to setup the Field Update and Form
+   */
   ngOnInit(): void {
     this.notificationsPrefix = 'collection.edit.tabs.source.notifications.';
     this.discardTimeOut = this.EnvConfig.collection.edit.undoTimeout;
@@ -216,6 +219,9 @@ export class CollectionSourceComponent extends AbstractTrackableComponent implem
     this.initializeOriginalContentSource();
   }
 
+  /**
+   * Initialize the Field Update and subscribe on it to fire updates to the form whenever it changes
+   */
   initializeOriginalContentSource() {
     const initialContentSource = cloneDeep(this.contentSource);
     this.objectUpdatesService.initialize(this.url, [initialContentSource], new Date());
@@ -272,21 +278,41 @@ export class CollectionSourceComponent extends AbstractTrackableComponent implem
     }
   }
 
+  /**
+   * Fired whenever the form receives an update and makes sure the Content Source and field update is up-to-date with the changes
+   * @param event
+   */
   onChange(event) {
     this.updateContentSourceField(event.model);
     this.saveFieldUpdate();
   }
 
+  /**
+   * Submit the edited Content Source to the REST API, re-initialize the field update and display a notification
+   */
   onSubmit() {
     // TODO: Fetch field update and send to REST API
     this.initializeOriginalContentSource();
     this.notificationsService.success(this.getNotificationTitle('saved'), this.getNotificationContent('saved'));
   }
 
+  /**
+   * Cancel the edit and return to the previous page
+   */
   onCancel() {
     this.location.back();
   }
 
+  /**
+   * Is the current form valid to be submitted ?
+   */
+  isValid(): boolean {
+    return !this.contentSource.enabled || this.formGroup.valid;
+  }
+
+  /**
+   * Switch the external source on or off and fire a field update
+   */
   changeExternalSource() {
     this.contentSource.enabled = !this.contentSource.enabled;
     this.updateContentSource();
@@ -303,6 +329,9 @@ export class CollectionSourceComponent extends AbstractTrackableComponent implem
     }
   }
 
+  /**
+   * Loop over all inputs and update the Content Source with their value
+   */
   updateContentSource() {
     this.formModel.forEach(
       (fieldModel: DynamicFormGroupModel | DynamicInputModel) => {
@@ -318,16 +347,26 @@ export class CollectionSourceComponent extends AbstractTrackableComponent implem
     this.saveFieldUpdate();
   }
 
+  /**
+   * Update the Content Source with the value from a DynamicInputModel
+   * @param fieldModel
+   */
   updateContentSourceField(fieldModel: DynamicInputModel) {
-    if (hasValue(fieldModel)) {
+    if (hasValue(fieldModel.value)) {
       this.contentSource[fieldModel.id] = fieldModel.value;
     }
   }
 
+  /**
+   * Save the current Content Source to the Object Updates cache
+   */
   saveFieldUpdate() {
     this.objectUpdatesService.saveAddFieldUpdate(this.url, cloneDeep(this.contentSource));
   }
 
+  /**
+   * Make sure open subscriptions are closed
+   */
   ngOnDestroy(): void {
     this.updateSub.unsubscribe();
   }
diff --git a/src/app/core/shared/content-source.model.ts b/src/app/core/shared/content-source.model.ts
index 4c523b80e1..c6d6c03fab 100644
--- a/src/app/core/shared/content-source.model.ts
+++ b/src/app/core/shared/content-source.model.ts
@@ -1,5 +1,8 @@
 import { v4 as uuid } from 'uuid';
 
+/**
+ * A model class that holds information about the Content Source of a Collection
+ */
 export class ContentSource {
   /**
    * Unique identifier
@@ -32,6 +35,7 @@ export class ContentSource {
   harvest = 3;
 
   constructor() {
+    // TODO: Remove this once the Content Source is fetched from the REST API and a custom generated UUID is not necessary anymore
     this.uuid = uuid();
   }
 }