Map adaptivity element in MBZ and integrate MoodlePluginModAdleradapt…

…ivity (#416) * Restructured ElementJson interface hierarchy * Adapted types of elements in ReadDsl.cs and XmlFactories to new type hierarchy * Renamed "DSL" to "ATF" in Generator * Implemented the logic for mapping the adaptivity elements to question.xml * Added new factory for adaptivity activity * Added generation of new section in Moodle for BaseLearningElements * Added new contextId for MBZ * Fixed format error that occurred when restoring moodle course * Fixed some typos in generation of ATF * Added, adjusted and fixed corresponding tests --------- Co-authored-by: Niklas Stich <[email protected]>
ProjektAdLer · Oct 27, 2023 · b710d78 · b710d78
1 parent d965553
commit b710d78
Show file tree

Hide file tree

Showing 113 changed files with 3,386 additions and 1,507 deletions.
diff --git a/AuthoringTool/Startup.cs b/AuthoringTool/Startup.cs
@@ -25,7 +25,7 @@
 using ElectronWrapper;
 using FluentValidation;
 using Generator.API;
-using Generator.DSL;
+using Generator.ATF;
 using Generator.WorldExport;
 using Microsoft.AspNetCore.Localization;
 using Microsoft.Extensions.Caching.Memory;
@@ -182,7 +182,7 @@ internal static void ConfigurePresentationLogic(IServiceCollection services)
         services.AddScoped<IPresentationLogic, PresentationLogic>();
         services.AddScoped<ILearningWorldPresenter, LearningWorldPresenter>();
         services.AddScoped(p =>
-            (ILearningWorldPresenterOverviewInterface) p.GetService(typeof(ILearningWorldPresenter))!);
+            (ILearningWorldPresenterOverviewInterface)p.GetService(typeof(ILearningWorldPresenter))!);
         services.AddScoped<ILearningSpacePresenter, LearningSpacePresenter>();
         services.AddSingleton<IAuthoringToolWorkspaceViewModel, AuthoringToolWorkspaceViewModel>();
         services.AddScoped<IErrorService, ErrorService>();
@@ -209,8 +209,8 @@ internal static void ConfigureGenerator(IServiceCollection services)
     {
         services.AddSingleton<IWorldGenerator, WorldGenerator>();
         services.AddSingleton<IBackupFileGenerator, BackupFileGenerator>();
-        services.AddSingleton<ICreateDsl, CreateDsl>();
-        services.AddSingleton<IReadDsl, ReadDsl>();
+        services.AddSingleton<ICreateAtf, CreateAtf>();
+        services.AddSingleton<IReadAtf, ReadAtf>();
     }
 
     internal static void ConfigureApiAccess(IServiceCollection services)
@@ -264,7 +264,7 @@ internal static void ConfigureUtilities(IServiceCollection services)
     internal static void ConfigureCommands(IServiceCollection services)
     {
         services.AddSingleton<ICommandStateManager, CommandStateManager>();
-        services.AddSingleton<IOnUndoRedo>(p => (CommandStateManager) p.GetService<ICommandStateManager>()!);
+        services.AddSingleton<IOnUndoRedo>(p => (CommandStateManager)p.GetService<ICommandStateManager>()!);
     }
 
     internal static void ConfigureCommandFactories(IServiceCollection services)
@@ -301,7 +301,7 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env, ILoggerF
         app.UseStaticFiles();
 
         // Add localization cultures
-        var supportedCultures = new[] {"de-DE", "en-DE"};
+        var supportedCultures = new[] { "de-DE", "en-DE" };
         var localizationOptions = new RequestLocalizationOptions()
             .SetDefaultCulture(supportedCultures[0])
             .AddSupportedCultures(supportedCultures)

diff --git a/AuthoringToolTest/StartupUt.cs b/AuthoringToolTest/StartupUt.cs
@@ -17,7 +17,7 @@
 using BusinessLogic.Validation;
 using BusinessLogic.Validation.Validators;
 using DataAccess.Persistence;
-using Generator.DSL;
+using Generator.ATF;
 using Generator.WorldExport;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Caching.Memory;
@@ -135,7 +135,7 @@ public void Startup_ConfigureServices_CanResolveAllBusinessLogicServices(Type re
 
     private static readonly Type[] ConfigureGeneratorRequiredTypes =
     {
-        typeof(IWorldGenerator), typeof(IBackupFileGenerator), typeof(ICreateDsl), typeof(IReadDsl)
+        typeof(IWorldGenerator), typeof(IBackupFileGenerator), typeof(ICreateAtf), typeof(IReadAtf)
     };
 
     [Test]

diff --git a/BusinessLogic/API/IWorldGenerator.cs b/BusinessLogic/API/IWorldGenerator.cs
@@ -5,7 +5,7 @@ namespace BusinessLogic.API;
 public interface IWorldGenerator
 {
     /// <summary>
-    /// Creates the DSL document, reads it, creates the needed folder structure for the backup, fills the folders with
+    /// Creates the ATF document, reads it, creates the needed folder structure for the backup, fills the folders with
     /// the needed xml-files and saves it to the desired location as .mbz file. 
     /// </summary>
     /// <param name="learningWorld"></param> Information about the learningWorld, topics, spaces and elements

diff --git a/Generator/API/WorldGenerator.cs b/Generator/API/WorldGenerator.cs
@@ -2,7 +2,7 @@
 using AutoMapper;
 using BusinessLogic.API;
 using BusinessLogic.Entities;
-using Generator.DSL;
+using Generator.ATF;
 using Generator.WorldExport;
 using PersistEntities;
 
@@ -11,17 +11,17 @@ namespace Generator.API;
 public class WorldGenerator : IWorldGenerator
 {
     private readonly IFileSystem _fileSystem;
-    public readonly ICreateDsl CreateDsl;
-    public readonly IReadDsl ReadDsl;
+    public readonly ICreateAtf CreateAtf;
+    public readonly IReadAtf ReadAtf;
 
     internal IMapper Mapper;
 
-    public WorldGenerator(IBackupFileGenerator backupFileGenerator, ICreateDsl createDsl, IReadDsl readDsl,
+    public WorldGenerator(IBackupFileGenerator backupFileGenerator, ICreateAtf createAtf, IReadAtf readAtf,
         IMapper mapper, IFileSystem fileSystem)
     {
         BackupFile = backupFileGenerator;
-        CreateDsl = createDsl;
-        ReadDsl = readDsl;
+        CreateAtf = createAtf;
+        ReadAtf = readAtf;
         Mapper = mapper;
         _fileSystem = fileSystem;
     }
@@ -34,9 +34,9 @@ public void ConstructBackup(LearningWorld learningWorld, string filepath)
     {
         try
         {
-            var dslPath = CreateDsl.GenerateAndExportLearningWorldJson(Mapper.Map<LearningWorldPe>(learningWorld));
-            ReadDsl.ReadLearningWorld(dslPath);
-            BackupFile.WriteXmlFiles((ReadDsl as ReadDsl)!);
+            var atfPath = CreateAtf.GenerateAndExportLearningWorldJson(Mapper.Map<LearningWorldPe>(learningWorld));
+            ReadAtf.ReadLearningWorld(atfPath);
+            BackupFile.WriteXmlFiles((ReadAtf as ReadAtf)!);
             BackupFile.WriteBackupFile(filepath);
         }
         finally

diff --git a/Generator/ATF/AdaptivityElement/AdaptivityContentJson.cs b/Generator/ATF/AdaptivityElement/AdaptivityContentJson.cs
@@ -0,0 +1,16 @@
+using System.Text.Json.Serialization;
+
+namespace Generator.ATF.AdaptivityElement;
+
+public class AdaptivityContentJson : IAdaptivityContentJson
+{
+    [JsonConstructor]
+    public AdaptivityContentJson(string introText, List<IAdaptivityTaskJson> adaptivityTasks)
+    {
+        IntroText = introText;
+        AdaptivityTasks = adaptivityTasks;
+    }
+
+    public string IntroText { get; set; }
+    public List<IAdaptivityTaskJson> AdaptivityTasks { get; set; }
+}
diff --git a/...daptivityElement/AdaptivityElementJson.cs → ...daptivityElement/AdaptivityElementJson.cs b/...daptivityElement/AdaptivityElementJson.cs → ...daptivityElement/AdaptivityElementJson.cs
@@ -1,6 +1,6 @@
 using System.Text.Json.Serialization;
 
-namespace Generator.DSL.AdaptivityElement;
+namespace Generator.ATF.AdaptivityElement;
 
 public class AdaptivityElementJson : IAdaptivityElementJson
 {

diff --git a/...aptivityElement/AdaptivityQuestionJson.cs → ...aptivityElement/AdaptivityQuestionJson.cs b/...aptivityElement/AdaptivityQuestionJson.cs → ...aptivityElement/AdaptivityQuestionJson.cs
@@ -1,11 +1,12 @@
 using System.Text.Json.Serialization;
 
-namespace Generator.DSL.AdaptivityElement;
+namespace Generator.ATF.AdaptivityElement;
 
 public class AdaptivityQuestionJson : IAdaptivityQuestionJson
 {
     [JsonConstructor]
-    public AdaptivityQuestionJson(string questionType, int questionId, string questionUuid, int questionDifficulty,
+    public AdaptivityQuestionJson(ResponseType questionType, int questionId, string questionUuid,
+        int questionDifficulty,
         string questionText, List<IAdaptivityRuleJson> adaptivityRules, List<IChoiceJson> choices)
     {
         QuestionType = questionType;
@@ -17,7 +18,9 @@ public AdaptivityQuestionJson(string questionType, int questionId, string questi
         Choices = choices;
     }
 
-    public string QuestionType { get; set; }
+    [JsonConverter(typeof(JsonStringEnumConverter))]
+    public ResponseType QuestionType { get; set; }
+
     public int QuestionId { get; set; }
     public string QuestionUUID { get; set; }
     public int QuestionDifficulty { get; set; }

diff --git a/...L/AdaptivityElement/AdaptivityRuleJson.cs → ...F/AdaptivityElement/AdaptivityRuleJson.cs b/...L/AdaptivityElement/AdaptivityRuleJson.cs → ...F/AdaptivityElement/AdaptivityRuleJson.cs
@@ -1,6 +1,6 @@
 using System.Text.Json.Serialization;
 
-namespace Generator.DSL.AdaptivityElement;
+namespace Generator.ATF.AdaptivityElement;
 
 public class AdaptivityRuleJson : IAdaptivityRuleJson
 {

diff --git a/...L/AdaptivityElement/AdaptivityTaskJson.cs → ...F/AdaptivityElement/AdaptivityTaskJson.cs b/...L/AdaptivityElement/AdaptivityTaskJson.cs → ...F/AdaptivityElement/AdaptivityTaskJson.cs
@@ -1,12 +1,12 @@
 using System.Text.Json.Serialization;
 
-namespace Generator.DSL.AdaptivityElement;
+namespace Generator.ATF.AdaptivityElement;
 
 public class AdaptivityTaskJson : IAdaptivityTaskJson
 {
     [JsonConstructor]
     public AdaptivityTaskJson(int taskId, string taskUuid, string taskTitle, bool optional,
-        int requiredDifficulty, List<IAdaptivityQuestionJson> adaptivityQuestions)
+        int? requiredDifficulty, List<IAdaptivityQuestionJson> adaptivityQuestions)
     {
         TaskId = taskId;
         TaskUUID = taskUuid;
@@ -20,6 +20,6 @@ public AdaptivityTaskJson(int taskId, string taskUuid, string taskTitle, bool op
     public string TaskUUID { get; set; }
     public string TaskTitle { get; set; }
     public bool Optional { get; set; }
-    public int RequiredDifficulty { get; set; }
+    public int? RequiredDifficulty { get; set; }
     public List<IAdaptivityQuestionJson> AdaptivityQuestions { get; set; }
 }
diff --git a/...rator/DSL/AdaptivityElement/ChoiceJson.cs → ...rator/ATF/AdaptivityElement/ChoiceJson.cs b/...rator/DSL/AdaptivityElement/ChoiceJson.cs → ...rator/ATF/AdaptivityElement/ChoiceJson.cs
@@ -1,6 +1,6 @@
 using System.Text.Json.Serialization;
 
-namespace Generator.DSL.AdaptivityElement;
+namespace Generator.ATF.AdaptivityElement;
 
 public class ChoiceJson : IChoiceJson
 {

diff --git a/...SL/AdaptivityElement/CommentActionJson.cs → ...TF/AdaptivityElement/CommentActionJson.cs b/...SL/AdaptivityElement/CommentActionJson.cs → ...TF/AdaptivityElement/CommentActionJson.cs
@@ -1,6 +1,6 @@
 using System.Text.Json.Serialization;
 
-namespace Generator.DSL.AdaptivityElement;
+namespace Generator.ATF.AdaptivityElement;
 
 public class CommentActionJson : IAdaptivityActionJson
 {

diff --git a/Generator/ATF/AdaptivityElement/ContentReferenceActionJson.cs b/Generator/ATF/AdaptivityElement/ContentReferenceActionJson.cs
@@ -0,0 +1,14 @@
+namespace Generator.ATF.AdaptivityElement;
+
+public class ContentReferenceActionJson : IAdaptivityActionJson
+{
+    public ContentReferenceActionJson(int elementId, string? hintText)
+    {
+        ElementId = elementId;
+        HintText = hintText;
+    }
+
+    public int ElementId { get; set; }
+
+    public string? HintText { get; set; }
+}
diff --git a/Generator/ATF/AdaptivityElement/ElementReferenceActionJson.cs b/Generator/ATF/AdaptivityElement/ElementReferenceActionJson.cs
@@ -0,0 +1,14 @@
+namespace Generator.ATF.AdaptivityElement;
+
+public class ElementReferenceActionJson : IAdaptivityActionJson
+{
+    public ElementReferenceActionJson(int elementId, string? hintText)
+    {
+        ElementId = elementId;
+        HintText = hintText;
+    }
+
+    public int ElementId { get; set; }
+
+    public string? HintText { get; set; }
+}
diff --git a/...daptivityElement/IAdaptivityActionJson.cs → ...daptivityElement/IAdaptivityActionJson.cs b/...daptivityElement/IAdaptivityActionJson.cs → ...daptivityElement/IAdaptivityActionJson.cs
@@ -1,6 +1,6 @@
 using System.Text.Json.Serialization;
 
-namespace Generator.DSL.AdaptivityElement;
+namespace Generator.ATF.AdaptivityElement;
 
 [JsonDerivedType(typeof(CommentActionJson), typeDiscriminator: JsonTypes.CommentActionType)]
 [JsonDerivedType(typeof(ElementReferenceActionJson), typeDiscriminator: JsonTypes.ElementReferenceActionType)]

diff --git a/...aptivityElement/IAdaptivityContentJson.cs → ...aptivityElement/IAdaptivityContentJson.cs b/...aptivityElement/IAdaptivityContentJson.cs → ...aptivityElement/IAdaptivityContentJson.cs
@@ -1,11 +1,10 @@
 using System.Text.Json.Serialization;
 
-namespace Generator.DSL.AdaptivityElement;
+namespace Generator.ATF.AdaptivityElement;
 
 [JsonDerivedType(typeof(AdaptivityContentJson), typeDiscriminator: JsonTypes.AdaptivityContentType)]
 public interface IAdaptivityContentJson
 {
     string IntroText { get; set; }
-    bool ShuffleTasks { get; set; }
-    List<IAdaptivityTaskJson> AdaptivityTask { get; set; }
+    List<IAdaptivityTaskJson> AdaptivityTasks { get; set; }
 }
diff --git a/...aptivityElement/IAdaptivityElementJson.cs → ...aptivityElement/IAdaptivityElementJson.cs b/...aptivityElement/IAdaptivityElementJson.cs → ...aptivityElement/IAdaptivityElementJson.cs
@@ -1,4 +1,4 @@
-namespace Generator.DSL.AdaptivityElement;
+namespace Generator.ATF.AdaptivityElement;
 
 public interface IAdaptivityElementJson : IInternalElementJson
 {

diff --git a/...ptivityElement/IAdaptivityQuestionJson.cs → ...ptivityElement/IAdaptivityQuestionJson.cs b/...ptivityElement/IAdaptivityQuestionJson.cs → ...ptivityElement/IAdaptivityQuestionJson.cs
@@ -1,11 +1,11 @@
 using System.Text.Json.Serialization;
 
-namespace Generator.DSL.AdaptivityElement;
+namespace Generator.ATF.AdaptivityElement;
 
 [JsonDerivedType(typeof(AdaptivityQuestionJson), typeDiscriminator: JsonTypes.AdaptivityQuestionType)]
 public interface IAdaptivityQuestionJson
 {
-    string QuestionType { get; set; }
+    ResponseType QuestionType { get; set; }
     int QuestionId { get; set; }
     string QuestionUUID { get; set; }
     int QuestionDifficulty { get; set; }

diff --git a/.../AdaptivityElement/IAdaptivityRuleJson.cs → .../AdaptivityElement/IAdaptivityRuleJson.cs b/.../AdaptivityElement/IAdaptivityRuleJson.cs → .../AdaptivityElement/IAdaptivityRuleJson.cs
@@ -1,6 +1,6 @@
 using System.Text.Json.Serialization;
 
-namespace Generator.DSL.AdaptivityElement;
+namespace Generator.ATF.AdaptivityElement;
 
 [JsonDerivedType(typeof(AdaptivityRuleJson), typeDiscriminator: JsonTypes.CorrectnessTriggerType)]
 public interface IAdaptivityRuleJson

diff --git a/.../AdaptivityElement/IAdaptivityTaskJson.cs → .../AdaptivityElement/IAdaptivityTaskJson.cs b/.../AdaptivityElement/IAdaptivityTaskJson.cs → .../AdaptivityElement/IAdaptivityTaskJson.cs
@@ -1,6 +1,6 @@
 using System.Text.Json.Serialization;
 
-namespace Generator.DSL.AdaptivityElement;
+namespace Generator.ATF.AdaptivityElement;
 
 [JsonDerivedType(typeof(AdaptivityTaskJson), typeDiscriminator: JsonTypes.AdaptivityTaskType)]
 public interface IAdaptivityTaskJson
@@ -9,6 +9,6 @@ public interface IAdaptivityTaskJson
     string TaskUUID { get; set; }
     string TaskTitle { get; set; }
     bool Optional { get; set; }
-    int RequiredDifficulty { get; set; }
+    int? RequiredDifficulty { get; set; }
     List<IAdaptivityQuestionJson> AdaptivityQuestions { get; set; }
 }
diff --git a/...ator/DSL/AdaptivityElement/IChoiceJson.cs → ...ator/ATF/AdaptivityElement/IChoiceJson.cs b/...ator/DSL/AdaptivityElement/IChoiceJson.cs → ...ator/ATF/AdaptivityElement/IChoiceJson.cs
@@ -1,6 +1,6 @@
 using System.Text.Json.Serialization;
 
-namespace Generator.DSL.AdaptivityElement;
+namespace Generator.ATF.AdaptivityElement;
 
 [JsonDerivedType(typeof(ChoiceJson), typeDiscriminator: JsonTypes.AdaptivityQuestionAnswerType)]
 public interface IChoiceJson

diff --git a/Generator/DSL/BaseLearningElementJson.cs → Generator/ATF/BaseLearningElementJson.cs b/Generator/DSL/BaseLearningElementJson.cs → Generator/ATF/BaseLearningElementJson.cs
@@ -1,6 +1,6 @@
 using System.Text.Json.Serialization;
 
-namespace Generator.DSL;
+namespace Generator.ATF;
 
 public class BaseLearningElementJson : IBaseLearningElementJson
 {