Refactor validateInputs

Author: jahn96

src/CodeSnippetEditor.tsx

@@ -33,6 +33,7 @@ import { CodeSnippetWidget } from './CodeSnippetWidget';
 import { SUPPORTED_LANGUAGES } from './CodeSnippetLanguages';
 import { CodeSnippetEditorTags } from './CodeSnippetEditorTags';
 import { saveOverWriteFile } from './CodeSnippetInputDialog';
+import { validateInputs } from './CodeSnippetUtilities';
 
 /**
  * CSS style classes
@@ -266,7 +267,7 @@ export class CodeSnippetEditor extends ReactWidget {
               `.${CODE_SNIPPET_EDITOR}-${this._codeSnippetEditorMetaData.id} .${CODE_SNIPPET_EDITOR_LANG_INPUT}`
             ) as HTMLSelectElement).value;
 
-            const validity = this.validateInputs(name, description, language);
+            const validity = validateInputs(name, description, language);
             if (validity) {
               this.updateSnippet().then((value) => {
                 if (value) {
@@ -342,37 +343,12 @@ export class CodeSnippetEditor extends ReactWidget {
       `.${CODE_SNIPPET_EDITOR}-${this._codeSnippetEditorMetaData.id} .${CODE_SNIPPET_EDITOR_LANG_INPUT}`
     ) as HTMLSelectElement).value;
 
-    const validity = this.validateInputs(name, description, language);
+    const validity = validateInputs(name, description, language);
     if (validity) {
       this.updateSnippet();
     }
   }
 
-  private validateInputs(
-    name: string,
-    description: string,
-    language: string
-  ): boolean {
-    let status = true;
-    let message = '';
-    if (name === '') {
-      message += 'Name must be filled out\n';
-      status = false;
-    }
-    if (language === '') {
-      message += 'Language must be filled out';
-      status = false;
-    }
-    if (!SUPPORTED_LANGUAGES.includes(language)) {
-      message += 'Language must be one of the options';
-      status = false;
-    }
-    if (status === false) {
-      alert(message);
-    }
-    return status;
-  }
-
   async updateSnippet(): Promise<boolean> {
     const name = (document.querySelector(
       `.${CODE_SNIPPET_EDITOR}-${this._codeSnippetEditorMetaData.id} .${CODE_SNIPPET_EDITOR_NAME_INPUT}`

src/CodeSnippetInputDialog.ts

@@ -13,7 +13,7 @@ import { ICodeSnippet, CodeSnippetService } from './CodeSnippetService';
 import { CodeSnippetWidget } from './CodeSnippetWidget';
 import { SUPPORTED_LANGUAGES } from './CodeSnippetLanguages';
 import { showMessage } from './ConfirmMessage';
-// import { showCodeSnippetForm } from './CodeSnippetForm'; //CodeSnippetForm } from './CodeSnippetForm';
+import { validateInputs } from './CodeSnippetUtilities';
 
 import checkSVGstr from '../style/icon/jupyter_checkmark.svg';
 
@@ -106,7 +106,10 @@ export function showInputDialog(
       return null;
     }
 
-    if (validateForm(result) === false) {
+    if (
+      validateInputs(result.value[0], result.value[1], result.value[2]) ===
+      false
+    ) {
       showInputDialog(
         codeSnippetWidget,
         tags,
@@ -221,34 +224,6 @@ export function isValidFileName(name: string): boolean {
   return name.length > 0 && !validNameExp.test(name);
 }
 
-/**
- * Test whether user typed in all required inputs.
- */
-export function validateForm(input: Dialog.IResult<string[]>): boolean {
-  let status = true;
-  let message = '';
-  const name = input.value[0];
-  const language = input.value[2];
-
-  if (name === '') {
-    message += 'Name must be filled out\n';
-    status = false;
-  }
-  if (language === '') {
-    message += 'Language must be filled out\n';
-    status = false;
-  }
-  if (!SUPPORTED_LANGUAGES.includes(language)) {
-    message += 'Language must be one of the options';
-    status = false;
-  }
-  // TODO: change it to a better UI
-  if (status === false) {
-    alert(message);
-  }
-  return status;
-}
-
 /**
  * A widget used to get input data.
  */

src/CodeSnippetUtilities.ts

@@ -0,0 +1,29 @@
+import { SUPPORTED_LANGUAGES } from './CodeSnippetLanguages';
+
+/**
+ * Test whether user typed in all required inputs.
+ */
+export function validateInputs(
+  name: string,
+  description: string,
+  language: string
+): boolean {
+  let status = true;
+  let message = '';
+  if (name === '') {
+    message += 'Name must be filled out\n';
+    status = false;
+  }
+  if (language === '') {
+    message += 'Language must be filled out';
+    status = false;
+  }
+  if (!SUPPORTED_LANGUAGES.includes(language)) {
+    message += 'Language must be one of the options';
+    status = false;
+  }
+  if (status === false) {
+    alert(message);
+  }
+  return status;
+}