From 4cbcc7398459d7a2de027292fa0522c7fa592935 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C3=ABl=20Minelli?= <michael@minelli.me>
Date: Tue, 12 Sep 2023 17:10:51 +0200
Subject: [PATCH] Rename enonce and exercice to assignment and exercise
---
...EnonceHelper.ts => SharedAssignmentHelper.ts} | 16 ++++++++--------
...ExerciceHelper.ts => SharedExerciseHelper.ts} | 10 +++++-----
types/Dojo/{EnonceFile.ts => AssignmentFile.ts} | 6 +++---
.../{DojoResponse.ts => DojoBackendResponse.ts} | 4 ++--
types/Dojo/ExerciceCheckerError.ts | 13 -------------
types/Dojo/ExerciseCheckerError.ts | 13 +++++++++++++
...ciceResultsFile.ts => ExerciseResultsFile.ts} | 4 ++--
7 files changed, 33 insertions(+), 33 deletions(-)
rename helpers/Dojo/{SharedEnonceHelper.ts => SharedAssignmentHelper.ts} (75%)
rename helpers/Dojo/{SharedExerciceHelper.ts => SharedExerciseHelper.ts} (87%)
rename types/Dojo/{EnonceFile.ts => AssignmentFile.ts} (68%)
rename types/Dojo/{DojoResponse.ts => DojoBackendResponse.ts} (62%)
delete mode 100644 types/Dojo/ExerciceCheckerError.ts
create mode 100644 types/Dojo/ExerciseCheckerError.ts
rename types/Dojo/{ExerciceResultsFile.ts => ExerciseResultsFile.ts} (70%)
diff --git a/helpers/Dojo/SharedEnonceHelper.ts b/helpers/Dojo/SharedAssignmentHelper.ts
similarity index 75%
rename from helpers/Dojo/SharedEnonceHelper.ts
rename to helpers/Dojo/SharedAssignmentHelper.ts
index f8ae6c4..7c87bc2 100644
--- a/helpers/Dojo/SharedEnonceHelper.ts
+++ b/helpers/Dojo/SharedAssignmentHelper.ts
@@ -1,17 +1,17 @@
import Ajv, { ErrorObject, JTDSchemaType } from 'ajv/dist/jtd';
import fs from 'fs';
import JSON5 from 'json5';
-import EnonceFile from '../../types/Dojo/EnonceFile';
+import AssignmentFile from '../../types/Dojo/AssignmentFile';
-class SharedEnonceHelper {
- private validateDescriptionFileV1(resultsFilePathOrStr: string, isFile: boolean = true): { results: EnonceFile | undefined, isValid: boolean, errors: Array<ErrorObject | string> | null | undefined } {
+class SharedAssignmentHelper {
+ private validateDescriptionFileV1(resultsFilePathOrStr: string, isFile: boolean = true): { results: AssignmentFile | undefined, isValid: boolean, errors: Array<ErrorObject | string> | null | undefined } {
const ajv = new Ajv();
- const schema: JTDSchemaType<EnonceFile> = {
+ const schema: JTDSchemaType<AssignmentFile> = {
properties : {
- dojoEnonceVersion: { type: 'uint32' },
- version : { type: 'uint32' },
+ dojoAssignmentVersion: { type: 'uint32' },
+ version : { type: 'uint32' },
immutable: {
elements: {
@@ -53,7 +53,7 @@ class SharedEnonceHelper {
}
}
- validateDescriptionFile(resultsFilePathOrStr: string, isFile: boolean = true, version: number = 1): { results: EnonceFile | undefined, isValid: boolean, errors: Array<ErrorObject | string> | null | undefined } {
+ validateDescriptionFile(resultsFilePathOrStr: string, isFile: boolean = true, version: number = 1): { results: AssignmentFile | undefined, isValid: boolean, errors: Array<ErrorObject | string> | null | undefined } {
switch ( version ) {
case 1:
return this.validateDescriptionFileV1(resultsFilePathOrStr, isFile);
@@ -68,4 +68,4 @@ class SharedEnonceHelper {
}
-export default new SharedEnonceHelper();
\ No newline at end of file
+export default new SharedAssignmentHelper();
\ No newline at end of file
diff --git a/helpers/Dojo/SharedExerciceHelper.ts b/helpers/Dojo/SharedExerciseHelper.ts
similarity index 87%
rename from helpers/Dojo/SharedExerciceHelper.ts
rename to helpers/Dojo/SharedExerciseHelper.ts
index 9fc4633..13672a8 100644
--- a/helpers/Dojo/SharedExerciceHelper.ts
+++ b/helpers/Dojo/SharedExerciseHelper.ts
@@ -1,14 +1,14 @@
import Ajv, { ErrorObject, JTDSchemaType } from 'ajv/dist/jtd';
import fs from 'fs';
-import ExerciceResultsFile from '../../types/Dojo/ExerciceResultsFile';
+import ExerciseResultsFile from '../../types/Dojo/ExerciseResultsFile';
import JSON5 from 'json5';
-class SharedExerciceHelper {
- validateResultFile(resultsFilePathOrStr: string, isFile: boolean = true): { results: ExerciceResultsFile | undefined, isValid: boolean, errors: Array<ErrorObject<string, Record<string, any>, unknown> | string> | null | undefined } {
+class SharedExerciseHelper {
+ validateResultFile(resultsFilePathOrStr: string, isFile: boolean = true): { results: ExerciseResultsFile | undefined, isValid: boolean, errors: Array<ErrorObject<string, Record<string, any>, unknown> | string> | null | undefined } {
const ajv = new Ajv();
- const schema: JTDSchemaType<ExerciceResultsFile> = {
+ const schema: JTDSchemaType<ExerciseResultsFile> = {
properties : {
success: { type: 'boolean' }
},
@@ -62,4 +62,4 @@ class SharedExerciceHelper {
}
-export default new SharedExerciceHelper();
\ No newline at end of file
+export default new SharedExerciseHelper();
\ No newline at end of file
diff --git a/types/Dojo/EnonceFile.ts b/types/Dojo/AssignmentFile.ts
similarity index 68%
rename from types/Dojo/EnonceFile.ts
rename to types/Dojo/AssignmentFile.ts
index c12dacb..04de8ba 100644
--- a/types/Dojo/EnonceFile.ts
+++ b/types/Dojo/AssignmentFile.ts
@@ -1,8 +1,8 @@
import ImmutableFileDescriptor from './ImmutableFileDescriptor';
-interface EnonceFile {
- dojoEnonceVersion: number,
+interface AssignmentFile {
+ dojoAssignmentVersion: number,
version: number,
immutable: Array<ImmutableFileDescriptor>
@@ -13,4 +13,4 @@ interface EnonceFile {
}
-export default EnonceFile;
\ No newline at end of file
+export default AssignmentFile;
\ No newline at end of file
diff --git a/types/Dojo/DojoResponse.ts b/types/Dojo/DojoBackendResponse.ts
similarity index 62%
rename from types/Dojo/DojoResponse.ts
rename to types/Dojo/DojoBackendResponse.ts
index cc0cffd..6c6eed9 100644
--- a/types/Dojo/DojoResponse.ts
+++ b/types/Dojo/DojoBackendResponse.ts
@@ -1,4 +1,4 @@
-interface DojoResponse<T> {
+interface DojoBackendResponse<T> {
timestamp: string;
code: number;
description: string;
@@ -7,4 +7,4 @@ interface DojoResponse<T> {
}
-export default DojoResponse;
\ No newline at end of file
+export default DojoBackendResponse;
\ No newline at end of file
diff --git a/types/Dojo/ExerciceCheckerError.ts b/types/Dojo/ExerciceCheckerError.ts
deleted file mode 100644
index f530f8a..0000000
--- a/types/Dojo/ExerciceCheckerError.ts
+++ /dev/null
@@ -1,13 +0,0 @@
-enum ExerciceCheckerError {
- EXERCICE_ENONCE_GET_ERROR = 200,
- DOCKER_COMPOSE_RUN_ERROR = 201,
- DOCKER_COMPOSE_LOGS_ERROR = 202,
- DOCKER_COMPOSE_DOWN_ERROR = 203,
- EXERCICE_RESULTS_FOLDER_TOO_BIG = 204,
- EXERCICE_RESULTS_FILE_NOT_FOUND = 205,
- EXERCICE_RESULTS_FILE_SCHEMA_NOT_VALID = 206,
- UPLOAD = 207
-}
-
-
-export default ExerciceCheckerError;
\ No newline at end of file
diff --git a/types/Dojo/ExerciseCheckerError.ts b/types/Dojo/ExerciseCheckerError.ts
new file mode 100644
index 0000000..21bb0d9
--- /dev/null
+++ b/types/Dojo/ExerciseCheckerError.ts
@@ -0,0 +1,13 @@
+enum ExerciseCheckerError {
+ EXERCISE_ASSIGNMENT_GET_ERROR = 200,
+ DOCKER_COMPOSE_RUN_ERROR = 201,
+ DOCKER_COMPOSE_LOGS_ERROR = 202,
+ DOCKER_COMPOSE_DOWN_ERROR = 203,
+ EXERCISE_RESULTS_FOLDER_TOO_BIG = 204,
+ EXERCISE_RESULTS_FILE_NOT_FOUND = 205,
+ EXERCISE_RESULTS_FILE_SCHEMA_NOT_VALID = 206,
+ UPLOAD = 207
+}
+
+
+export default ExerciseCheckerError;
\ No newline at end of file
diff --git a/types/Dojo/ExerciceResultsFile.ts b/types/Dojo/ExerciseResultsFile.ts
similarity index 70%
rename from types/Dojo/ExerciceResultsFile.ts
rename to types/Dojo/ExerciseResultsFile.ts
index da27489..98bc83a 100644
--- a/types/Dojo/ExerciceResultsFile.ts
+++ b/types/Dojo/ExerciseResultsFile.ts
@@ -1,4 +1,4 @@
-interface ExerciceResultsFile {
+interface ExerciseResultsFile {
success: boolean;
successfulTests?: number;
@@ -9,4 +9,4 @@ interface ExerciceResultsFile {
}
-export default ExerciceResultsFile;
\ No newline at end of file
+export default ExerciseResultsFile;
\ No newline at end of file
--
GitLab