From e7e89cbb7a1047ed0ec4cc868b55ab48c6976c90 Mon Sep 17 00:00:00 2001
From: Caroline Desprat <cdesprat@icij.org>
Date: Mon, 4 Nov 2024 15:51:00 +0000
Subject: [PATCH] refactor: move files to task directories

---
 components.d.ts                               |   4 +-
 src/components/ExtractingForm.vue             | 230 ------------------
 src/components/FindNamedEntitiesForm.vue      | 197 ---------------
 .../ExtractingFormOcrControl.vue              |   0
 .../ExtractingLanguageFormControl.vue         |   0
 .../ExtractingFormOcrControl.spec.js          |   2 +-
 .../ExtractingLanguageFormControl.spec.js     |   2 +-
 .../TaskDocuments/TaskDocumentsForm.spec.js}  |   4 +-
 .../FindNamedEntitiesForm.spec.js             |   0
 9 files changed, 6 insertions(+), 433 deletions(-)
 delete mode 100644 src/components/ExtractingForm.vue
 delete mode 100644 src/components/FindNamedEntitiesForm.vue
 rename src/components/{ => Task/TaskDocuments}/ExtractingFormOcrControl.vue (100%)
 rename src/components/{ => Task/TaskDocuments}/ExtractingLanguageFormControl.vue (100%)
 rename tests/unit/specs/components/{ => Task/TaskDocuments}/ExtractingFormOcrControl.spec.js (94%)
 rename tests/unit/specs/components/{ => Task/TaskDocuments}/ExtractingLanguageFormControl.spec.js (95%)
 rename tests/unit/specs/components/{ExtractingForm.spec.js => Task/TaskDocuments/TaskDocumentsForm.spec.js} (96%)
 rename tests/unit/specs/components/{ => Task/TaskEntities}/FindNamedEntitiesForm.spec.js (100%)

diff --git a/components.d.ts b/components.d.ts
index 1238a2a962..aee982f88c 100644
--- a/components.d.ts
+++ b/components.d.ts
@@ -295,8 +295,8 @@ declare module 'vue' {
     EntitySectionTitle: typeof import('./src/components/Entity/EntitySection/EntitySectionTitle.vue')['default']
     Extensions: typeof import('./src/components/Extensions.vue')['default']
     ExtractingForm: typeof import('./src/components/ExtractingForm.vue')['default']
-    ExtractingFormOcrControl: typeof import('./src/components/ExtractingFormOcrControl.vue')['default']
-    ExtractingLanguageFormControl: typeof import('./src/components/ExtractingLanguageFormControl.vue')['default']
+    ExtractingFormOcrControl: typeof import('./src/components/Task/TaskDocuments/ExtractingFormOcrControl.vue')['default']
+    ExtractingLanguageFormControl: typeof import('./src/components/Task/TaskDocuments/ExtractingLanguageFormControl.vue')['default']
     FilterAbstract: typeof import('./src/components/Filter/types/FilterAbstract.vue')['default']
     FilterBoilerplate: typeof import('./src/components/Filter/FilterBoilerplate.vue')['default']
     FilterDate: typeof import('./src/components/Filter/types/FilterDate.vue')['default']
diff --git a/src/components/ExtractingForm.vue b/src/components/ExtractingForm.vue
deleted file mode 100644
index c5c4a6427f..0000000000
--- a/src/components/ExtractingForm.vue
+++ /dev/null
@@ -1,230 +0,0 @@
-<template>
-  <form class="extracting-form position-relative" @submit.prevent="submitExtract">
-    <div v-if="showProjectSelector" class="extracting-form__group mb-4">
-      <fa icon="database" class="position-absolute mt-1 ms-1" size="lg" />
-      <div class="ms-4 ps-3">
-        <p class="fw-bold">{{ $t('indexing.projectIndexationSelection') }}</p>
-        <project-selector v-model="defaultProject" />
-      </div>
-    </div>
-    <div class="extracting-form__group mb-4">
-      <fa icon="folder-open" class="position-absolute mt-1 ms-1" size="lg" />
-      <div class="ms-4 ps-3">
-        <p class="fw-bold mb-0">{{ $t('indexing.folderSelection') }}</p>
-        <p class="small mb-2">{{ $t('indexing.folderSelectionDescription') }}</p>
-        <form-control-path v-model:path="path" :source-path="sourcePath" hide-folder-icon />
-      </div>
-    </div>
-    <div class="extracting-form__group mb-4">
-      <fa icon="globe" class="position-absolute mt-1 ms-1" size="lg" />
-      <div class="ms-4 ps-3">
-        <p class="fw-bold">{{ $t('indexing.extractLanguage') }}</p>
-        <extracting-language-form-control v-model="language" />
-      </div>
-    </div>
-
-    <div class="extracting-form__group mb-4">
-      <b-form-checkbox v-model="ocr" name="check-button" :disabled="!hasTesseract" switch>
-        <div class="fw-bold ms-1">
-          {{ $t('indexing.extractWithOcrLabel') }}
-        </div>
-        <div class="extracting-form__group__help ms-1 small">
-          <span>
-            {{ $t('indexing.extractWithOcrHelp') }}
-          </span>
-        </div>
-      </b-form-checkbox>
-      <div v-show="showOcrMessage" class="ms-4 ps-3">
-        <extracting-form-ocr-control
-          :iso-lang="language"
-          :text-languages="textLanguages"
-          :ocr-languages="ocrLanguages"
-          :has-tesseract="hasTesseract"
-          :is-ready="isReady"
-        />
-      </div>
-    </div>
-    <div class="extracting-form__group mb-4">
-      <b-form-checkbox v-model="filter" name="check-button" switch>
-        <div class="fw-bold ms-1">
-          {{ $t('indexing.extractOnlyNewLabel') }}
-        </div>
-        <div class="extracting-form__group__help ms-1 small">
-          <span>
-            {{ $t('indexing.extractOnlyNewHelp') }}
-          </span>
-        </div>
-      </b-form-checkbox>
-    </div>
-    <div class="extracting-form__footer mt-4 row no-gutters">
-      <slot name="footer" :disabled="isWaitingForSubmitExtract">
-        <div class="col text-end">
-          <b-overlay :show="isWaitingForSubmitExtract" opacity="0.6" rounded spinner-small class="d-inline-flex">
-            <b-button variant="action" class="ms-2" type="submit" :disabled="isWaitingForSubmitExtract">
-              {{ $t('indexing.go') }}
-            </b-button>
-          </b-overlay>
-        </div>
-      </slot>
-    </div>
-  </form>
-</template>
-
-<script>
-import { uniqueId, castArray } from 'lodash'
-import { waitFor } from 'vue-wait'
-
-import ExtractingLanguageFormControl from '@/components/ExtractingLanguageFormControl'
-import ExtractingFormOcrControl from '@/components/ExtractingFormOcrControl'
-import FormControlPath from '@/components/Form/FormControl/FormControlPath'
-import ProjectSelector from '@/components/ProjectSelector'
-
-/**
- * A form to start indexing documents in the data directory.
- */
-export default {
-  name: 'ExtractingForm',
-  components: {
-    ExtractingLanguageFormControl,
-    FormControlPath,
-    ExtractingFormOcrControl,
-    ProjectSelector
-  },
-  props: {
-    /**
-     * Force hiding the project selector input
-     */
-    hideProjectSelector: {
-      type: Boolean,
-      default: false
-    },
-    /**
-     * Project name to select in the input instead of default project
-     */
-    projectName: {
-      type: String,
-      default: null
-    }
-  },
-  data() {
-    return {
-      textLanguages: [],
-      ocrLanguages: [],
-      hasTesseract: true
-    }
-  },
-  computed: {
-    ocr: {
-      set(value) {
-        this.$store.commit('indexing/formOcr', value)
-      },
-      get() {
-        return this.$store.state.indexing.form.ocr
-      }
-    },
-    filter: {
-      set(value) {
-        this.$store.commit('indexing/formFilter', value)
-      },
-      get() {
-        return this.$store.state.indexing.form.filter
-      }
-    },
-    path: {
-      set(value) {
-        this.$store.commit('indexing/formPath', value)
-      },
-      get() {
-        return this.$store.state.indexing.form.path
-      }
-    },
-    language: {
-      set(value) {
-        this.$store.commit('indexing/formLanguage', value)
-      },
-      get() {
-        return this.$store.state.indexing.form.language
-      }
-    },
-    defaultProject: {
-      set(value) {
-        this.$store.commit('indexing/formDefaultProject', value)
-      },
-      get() {
-        return this.$store.state.indexing.form.defaultProject || this.$config.get('defaultProject')
-      }
-    },
-    sourcePath() {
-      const project = this.$core.findProject(this.defaultProject)
-      const sourcePath = project?.sourcePath?.split('file://').pop() ?? this.$config.get('dataDir')
-      return decodeURI(sourcePath)
-    },
-    isWaitingForSubmitExtract() {
-      return this.$wait.is('submitExtract')
-    },
-    waitOcrIdentifier() {
-      return uniqueId('extracting-form-ocr-control-')
-    },
-    isReady() {
-      return !this.$wait.is(this.waitOcrIdentifier)
-    },
-    showOcrMessage() {
-      return !this.hasTesseract || !!this.ocr
-    },
-    showProjectSelector() {
-      return !this.hideProjectSelector && (this.hasSeveralProjects || this.nonDefaultProjectSelected)
-    },
-    hasSeveralProjects: {
-      cache: false,
-      get() {
-        return this.$core.projects.length > 1
-      }
-    },
-    nonDefaultProjectSelected() {
-      return this.defaultProject !== this.$config.get('defaultProject')
-    }
-  },
-  async mounted() {
-    if (this.$core.findProject(this.projectName)) {
-      this.defaultProject = this.projectName
-    }
-    await this.loadLanguages()
-    // This trick ensure the default project is not null
-    // when submiting the form
-    this.$store.commit('indexing/formDefaultProject', this.defaultProject)
-  },
-  methods: {
-    dispatchExtract: waitFor('submitExtract', function () {
-      return this.$store.dispatch('indexing/submitExtract')
-    }),
-    async loadLanguages() {
-      this.$wait.start(this.waitOcrIdentifier)
-      try {
-        const [textLanguages, ocrLanguages] = await Promise.all([
-          this.$core.api.textLanguages(),
-          this.$core.api.ocrLanguages()
-        ])
-        this.textLanguages = castArray(textLanguages)
-        this.ocrLanguages = castArray(ocrLanguages)
-      } catch (e) {
-        this.hasTesseract = e.response.status !== 503
-
-        if (this.hasTesseract) {
-          this.$toast.error(this.$t('extractingLanguageFormControl.failedToRetrieveLanguages'))
-        }
-      }
-      this.$wait.end(this.waitOcrIdentifier)
-    },
-    async submitExtract() {
-      try {
-        await this.dispatchExtract()
-        this.$emit('submit', { error: false })
-      } catch (error) {
-        this.$emit('submit', { error })
-      } finally {
-        this.$store.commit('indexing/resetExtractForm')
-      }
-    }
-  }
-}
-</script>
diff --git a/src/components/FindNamedEntitiesForm.vue b/src/components/FindNamedEntitiesForm.vue
deleted file mode 100644
index 25eb23ea4d..0000000000
--- a/src/components/FindNamedEntitiesForm.vue
+++ /dev/null
@@ -1,197 +0,0 @@
-<template>
-  <v-wait for="load ner pipelines">
-    <template #waiting>
-      <fa icon="circle-notch" spin size="2x" class="d-flex mx-auto my-5 text-tertiary" />
-    </template>
-    <form class="find-named-entities-form position-relative" @submit.prevent="submitFindNamedEntities">
-      <div v-if="showProjectSelector" class="find-named-entities-form__group mb-4">
-        <fa icon="database" class="position-absolute mt-1 ms-1" size="lg" />
-        <div class="ms-4 ps-3">
-          <p class="fw-bold">
-            {{ $t('indexing.findNamedEntitiesProjectSelection') }}
-          </p>
-          <project-selector v-model="defaultProject" />
-        </div>
-      </div>
-      <div class="find-named-entities-form__group mb-4">
-        <fa icon="tags" class="position-absolute mt-1 ms-1" size="lg" />
-        <div class="ms-4 ps-3">
-          <p class="find-named-entities-form__header fw-bold mb-0">
-            {{ $t('indexing.findNamedEntitiesHeader') }}
-          </p>
-          <div class="find-named-entities-form__body form-group mb-4">
-            <p class="mb-2 small">
-              {{ $t('indexing.findNamedEntitiesSubheader') }}
-            </p>
-            <fieldset class="list-group">
-              <div
-                v-for="(translationReference, pip) in pipelines"
-                :key="pip"
-                class="list-group-item bg-transparent border-light find-named-entities-form__body__pipeline"
-              >
-                <b-form-radio v-model="pipeline" name="pipeline" :value="pip.toUpperCase()">
-                  {{ $t(`${translationReference}`) }}
-                  <div v-if="pip.toUpperCase() === 'CORENLP'" class="font-italic small">
-                    {{ $t('indexing.default') }}
-                  </div>
-                </b-form-radio>
-              </div>
-            </fieldset>
-          </div>
-        </div>
-      </div>
-      <div class="find-named-entities-form__offline form-group">
-        <b-form-checkbox v-model="offline" switch>
-          <div class="fw-bold ms-1">
-            {{ $t('indexing.syncModelsLabel') }}
-          </div>
-          <div class="ms-1 small">
-            {{ $t('indexing.syncModels') }}
-          </div>
-        </b-form-checkbox>
-      </div>
-      <div class="find-named-entities-form__footer mt-4 row no-gutters">
-        <slot name="footer" :disabled="disabled">
-          <div class="col text-end">
-            <b-button variant="action" class="fw-bold" type="submit" :disabled="disabled">
-              {{ $t('indexing.go') }}
-            </b-button>
-          </div>
-        </slot>
-      </div>
-    </form>
-  </v-wait>
-</template>
-
-<script>
-import { lowerCase, startCase, values } from 'lodash'
-
-import ProjectSelector from '@/components/ProjectSelector'
-import utils from '@/mixins/utils'
-
-/**
- * A form to start indexing named entities in indexed documents.
- */
-export default {
-  name: 'FindNamedEntitiesForm',
-  components: {
-    ProjectSelector
-  },
-  filters: {
-    lowerCase,
-    startCase
-  },
-  mixins: [utils],
-  props: {
-    /**
-     * Project name to select in the input instead of default project
-     */
-    projectName: {
-      type: String,
-      default: null
-    },
-    /**
-     * Force hiding the project selector input
-     */
-    hideProjectSelector: {
-      type: Boolean,
-      default: false
-    }
-  },
-  data() {
-    return {
-      pipelines: []
-    }
-  },
-  computed: {
-    disabled() {
-      return !this.pipeline && (!this.$wait.waiting('load ner pipelines') || !this.$wait.waiting('launch ner task'))
-    },
-    offline: {
-      set(value) {
-        this.$store.commit('indexing/formOffline', value)
-      },
-      get() {
-        return this.$store.state.indexing.form.offline
-      }
-    },
-    pipeline: {
-      set(value) {
-        this.$store.commit('indexing/formPipeline', value)
-      },
-      get() {
-        return this.$store.state.indexing.form.pipeline?.toUpperCase()
-      }
-    },
-    defaultProject: {
-      set(value) {
-        this.$store.commit('indexing/formDefaultProject', value)
-      },
-      get() {
-        return this.projectName || this.$store.state.indexing.form.defaultProject || this.$config.get('defaultProject')
-      }
-    },
-    showProjectSelector() {
-      return !this.hideProjectSelector && (this.hasSeveralProjects || this.nonDefaultProjectSelected)
-    },
-    hasSeveralProjects: {
-      cache: false,
-      get() {
-        return this.$core.projects.length > 1
-      }
-    },
-    nonDefaultProjectSelected() {
-      return this.defaultProject !== this.$config.get('defaultProject')
-    }
-  },
-  async mounted() {
-    if (this.$core.findProject(this.projectName)) {
-      this.defaultProject = this.projectName
-    }
-    this.$wait.start('load ner pipelines')
-    const pipelines = await this.$store.dispatch('indexing/getNerPipelines')
-    this.pipelines = this.handlePipelinesTranslation(values(pipelines).map(lowerCase))
-    this.$wait.end('load ner pipelines')
-  },
-  methods: {
-    async submitFindNamedEntities() {
-      try {
-        this.$wait.start('launch ner task')
-        await this.$store.dispatch('indexing/submitFindNamedEntities')
-        this.$emit('submit', { error: false })
-      } catch (error) {
-        this.$emit('submit', { error })
-      } finally {
-        this.$wait.end('launch ner task')
-        this.$store.commit('indexing/resetFindNamedEntitiesForm')
-      }
-    },
-    handlePipelinesTranslation(pipelines) {
-      const translationsMap = {}
-      pipelines.forEach((pip) => {
-        translationsMap[pip] = `indexing.pipelineOptions.${pip}`
-      })
-      return translationsMap
-    }
-  }
-}
-</script>
-
-<style lang="scss" scoped>
-.find-named-entities-form {
-  &__header h4 {
-    font-size: 1.2em;
-    font-weight: bolder;
-  }
-
-  &__subheader {
-    font-style: italic;
-  }
-
-  &__body {
-    &__pipeline {
-      color: inherit;
-    }
-  }
-}
-</style>
diff --git a/src/components/ExtractingFormOcrControl.vue b/src/components/Task/TaskDocuments/ExtractingFormOcrControl.vue
similarity index 100%
rename from src/components/ExtractingFormOcrControl.vue
rename to src/components/Task/TaskDocuments/ExtractingFormOcrControl.vue
diff --git a/src/components/ExtractingLanguageFormControl.vue b/src/components/Task/TaskDocuments/ExtractingLanguageFormControl.vue
similarity index 100%
rename from src/components/ExtractingLanguageFormControl.vue
rename to src/components/Task/TaskDocuments/ExtractingLanguageFormControl.vue
diff --git a/tests/unit/specs/components/ExtractingFormOcrControl.spec.js b/tests/unit/specs/components/Task/TaskDocuments/ExtractingFormOcrControl.spec.js
similarity index 94%
rename from tests/unit/specs/components/ExtractingFormOcrControl.spec.js
rename to tests/unit/specs/components/Task/TaskDocuments/ExtractingFormOcrControl.spec.js
index 901185f7a4..63079087c6 100644
--- a/tests/unit/specs/components/ExtractingFormOcrControl.spec.js
+++ b/tests/unit/specs/components/Task/TaskDocuments/ExtractingFormOcrControl.spec.js
@@ -2,7 +2,7 @@ import { mount } from '@vue/test-utils'
 
 import { flushPromises } from '~tests/unit/tests_utils'
 import CoreSetup from '~tests/unit/CoreSetup'
-import ExtractingFormOcrControl from '@/components/ExtractingFormOcrControl'
+import ExtractingFormOcrControl from '@/components/Task/TaskDocuments/ExtractingFormOcrControl'
 
 const OCR_LANGUAGES = [
   { name: 'CHINESE', iso6392: 'zho' },
diff --git a/tests/unit/specs/components/ExtractingLanguageFormControl.spec.js b/tests/unit/specs/components/Task/TaskDocuments/ExtractingLanguageFormControl.spec.js
similarity index 95%
rename from tests/unit/specs/components/ExtractingLanguageFormControl.spec.js
rename to tests/unit/specs/components/Task/TaskDocuments/ExtractingLanguageFormControl.spec.js
index 9800faf9c3..e6f1f426bb 100644
--- a/tests/unit/specs/components/ExtractingLanguageFormControl.spec.js
+++ b/tests/unit/specs/components/Task/TaskDocuments/ExtractingLanguageFormControl.spec.js
@@ -2,7 +2,7 @@ import { mount } from '@vue/test-utils'
 
 import { flushPromises } from '~tests/unit/tests_utils'
 import CoreSetup from '~tests/unit/CoreSetup'
-import ExtractingLanguageFormControl from '@/components/ExtractingLanguageFormControl'
+import ExtractingLanguageFormControl from '@/components/Task/TaskDocuments/ExtractingLanguageFormControl'
 
 const TEXT_LANGUAGES = [
   { name: 'CHINESE', iso6392: 'zho' },
diff --git a/tests/unit/specs/components/ExtractingForm.spec.js b/tests/unit/specs/components/Task/TaskDocuments/TaskDocumentsForm.spec.js
similarity index 96%
rename from tests/unit/specs/components/ExtractingForm.spec.js
rename to tests/unit/specs/components/Task/TaskDocuments/TaskDocumentsForm.spec.js
index 89ac213d8f..461a96b3c0 100644
--- a/tests/unit/specs/components/ExtractingForm.spec.js
+++ b/tests/unit/specs/components/Task/TaskDocuments/TaskDocumentsForm.spec.js
@@ -2,8 +2,8 @@ import { shallowMount } from '@vue/test-utils'
 
 import CoreSetup from '~tests/unit/CoreSetup'
 import ExtractingForm from '@/components/ExtractingForm'
-
-describe('ExtractingForm.vue', () => {
+// TODO file renamed but the tests have to be rewritten
+describe('TaskDocumentsForm.vue', () => {
   let api, wrapper, core
 
   const props = {
diff --git a/tests/unit/specs/components/FindNamedEntitiesForm.spec.js b/tests/unit/specs/components/Task/TaskEntities/FindNamedEntitiesForm.spec.js
similarity index 100%
rename from tests/unit/specs/components/FindNamedEntitiesForm.spec.js
rename to tests/unit/specs/components/Task/TaskEntities/FindNamedEntitiesForm.spec.js