Add KPI matrix component

.editorconfig

@@ -473,7 +473,7 @@ dotnet_diagnostic.ide0041.severity = error
 dotnet_diagnostic.ide0042.severity = error
 dotnet_diagnostic.ide0044.severity = error
 dotnet_diagnostic.ide0045.severity = error
-dotnet_diagnostic.ide0046.severity = error
+dotnet_diagnostic.ide0046.severity = none
 dotnet_diagnostic.ide0047.severity = error
 dotnet_diagnostic.ide0048.severity = error
 dotnet_diagnostic.ide0049.severity = error

Epsilon.Abstractions/Component/CompetenceComponentFetcher.cs

@@ -2,7 +2,7 @@ namespace Epsilon.Abstractions.Component;
 
 public abstract class CompetenceComponentFetcher<TComponent> : ICompetenceComponentFetcher<TComponent> where TComponent : ICompetenceComponent
 {
-    public async Task<ICompetenceComponent> FetchUnknown() => await Fetch();
+    public async Task<ICompetenceComponent> FetchUnknown(DateTime startDate, DateTime endDate) => await Fetch(startDate, endDate);
 
-    public abstract Task<TComponent> Fetch();
+    public abstract Task<TComponent> Fetch(DateTime startDate, DateTime endDate);
 }

Epsilon.Abstractions/Component/CompetenceProfile.cs

@@ -1,4 +1,4 @@
-using DocumentFormat.OpenXml;
+using DocumentFormat.OpenXml.Packaging;
 using DocumentFormat.OpenXml.Wordprocessing;
 using Epsilon.Abstractions.Model;
 using Epsilon.Canvas.Abstractions.Model;
@@ -15,7 +15,7 @@ public record CompetenceProfile(
     IEnumerable<DecayingAveragePerSkill> DecayingAveragesPerSkill
 ) : ICompetenceWordComponent
 {
-    public OpenXmlElement ToWord()
+    public void AddToWordDocument(MainDocumentPart mainDocumentPart)
     {
         // TODO: This is simply an example to show the capability of the component architecture
         var body = new Body();
@@ -31,6 +31,6 @@ public OpenXmlElement ToWord()
             );
         }
 
-        return body;
+        mainDocumentPart.Document.AppendChild(body);
     }
 }

Epsilon.Abstractions/Component/ICompetenceComponentFetcher.cs

@@ -2,11 +2,11 @@
 
 public interface ICompetenceComponentFetcher
 {
-    public Task<ICompetenceComponent> FetchUnknown();
+    public Task<ICompetenceComponent> FetchUnknown(DateTime startDate, DateTime endDate);
 }
 
 public interface ICompetenceComponentFetcher<TComponent> : ICompetenceComponentFetcher
     where TComponent : ICompetenceComponent
 {
-    public Task<TComponent> Fetch();
+    public Task<TComponent> Fetch(DateTime startDate, DateTime endDate);
 }

Epsilon.Abstractions/Component/ICompetenceWordComponent.cs

@@ -1,8 +1,8 @@
-using DocumentFormat.OpenXml;
+using DocumentFormat.OpenXml.Packaging;
 
 namespace Epsilon.Abstractions.Component;
 
 public interface ICompetenceWordComponent : ICompetenceComponent
 {
-    public OpenXmlElement ToWord();
+    public void AddToWordDocument(MainDocumentPart mainDocumentPart);
 }

Epsilon.Abstractions/Component/KpiMatrixAssignment.cs

@@ -0,0 +1,6 @@
+namespace Epsilon.Abstractions.Component;
+
+public record KpiMatrixAssignment(
+    string Name,
+    IEnumerable<KpiMatrixOutcome> Outcomes
+);

Epsilon.Abstractions/Component/KpiMatrixCollection.cs

@@ -0,0 +1,196 @@
+using DocumentFormat.OpenXml;
+using DocumentFormat.OpenXml.Packaging;
+using DocumentFormat.OpenXml.Wordprocessing;
+
+namespace Epsilon.Abstractions.Component;
+
+[CompetenceComponentName("kpi_matrix")]
+public record KpiMatrixCollection(
+    IEnumerable<KpiMatrixAssignment> KpiMatrixAssignments,
+    IDictionary<string, KpiMatrixOutcomeGradeStatus> GradeStatus
+) : ICompetenceWordComponent
+{
+    public static readonly IDictionary<string, KpiMatrixOutcomeGradeStatus> DefaultGradeStatus = new Dictionary<string, KpiMatrixOutcomeGradeStatus>
+    {
+        {
+            "Mastered", new KpiMatrixOutcomeGradeStatus("Mastered", "44F656")
+        },
+        {
+            "Insufficient", new KpiMatrixOutcomeGradeStatus("Insufficient", "FA1818")
+        },
+        {
+            "NotGradedAssessed", new KpiMatrixOutcomeGradeStatus("Not graded, Assignment assessed", "FAFF00")
+        },
+        {
+            "NotGradedNotAssessed", new KpiMatrixOutcomeGradeStatus("Not graded, Assignment not assessed", "9F2B68")
+        },
+    };
+
+    public void AddToWordDocument(MainDocumentPart mainDocumentPart)
+    {
+        var body = new Body();
+        // Create a table, with rows for the outcomes and columns for the assignments.
+        var table = new Table();
+
+        var assignments = KpiMatrixAssignments.OrderBy(static ass => ass.Name).ToList();
+
+        // Set table properties for formatting.
+        table.AppendChild(new TableProperties(
+            new TableWidth
+            {
+                Width = "0", Type = TableWidthUnitValues.Auto,
+            }));
+
+        // Calculate the header row height based on the longest assignment name.
+        var headerRowHeight = 0;
+        if (KpiMatrixAssignments.Any())
+        {
+            headerRowHeight = assignments.Max(static a => a.Name.Length) * 111;
+        }
+
+        // Create the table header row.
+        var headerRow = new TableRow();
+        headerRow.AppendChild(new TableRowProperties(new TableRowHeight
+        {
+            Val = (UInt32Value)(uint)headerRowHeight,
+        }));
+
+        // Empty top-left cell.
+        headerRow.AppendChild(CreateTableCellWithBorders("2500", new Paragraph(new Run(new Text("")))));
+
+        foreach (var assignment in assignments)
+        {
+            var cell = CreateTableCellWithBorders("100");
+            cell.FirstChild.Append(new TextDirection
+            {
+                Val = TextDirectionValues.TopToBottomLeftToRightRotated,
+            });
+
+            cell.Append(new Paragraph(new Run(new Text(assignment.Name))));
+            cell.FirstChild.Append(new Shading
+            {
+                Fill = assignments.IndexOf(assignment) % 2 == 0
+                    ? "FFFFFF"
+                    : "d3d3d3",
+            });
+            headerRow.AppendChild(cell);
+        }
+
+        table.AppendChild(headerRow);
+
+        var listOfOutcomes = new Dictionary<int, KpiMatrixOutcome>();
+        foreach (var assignment in KpiMatrixAssignments)
+        {
+            foreach (var outcome in assignment.Outcomes)
+            {
+                listOfOutcomes.TryAdd(outcome.Id, outcome);
+            }
+        }
+
+        // Add the outcome rows.
+        foreach (var outcome in listOfOutcomes.OrderByDescending(static o => o.Value.Title))
+        {
+            var row = new TableRow();
+
+            // Add the outcome title cell.
+            row.AppendChild(CreateTableCellWithBorders("2500", new Paragraph(new Run(new Text(outcome.Value.Title)))));
+
+            // Add the assignment cells.
+            foreach (var assignment in assignments)
+            {
+                var outcomeAssignment = assignment.Outcomes.FirstOrDefault(o => o.Id == outcome.Key);
+                var cell = CreateTableCellWithBorders("100");
+
+                // Set cell color based on GradeStatus.
+                var fillColor = outcomeAssignment != null
+                    ? outcomeAssignment.KpiMatrixOutcomeGradeStatus.Color
+                    //When no item is present give the cell alternating background color
+                    : assignments.IndexOf(assignment) % 2 == 0
+                        ? "FFFFFF"
+                        : "d3d3d3";
+
+                cell.FirstChild.Append(new Shading
+                {
+                    Fill = fillColor,
+                });
+
+                // Add an empty text element since we're using color instead of text.
+                cell.Append(new Paragraph(new Run(new Text(""))));
+                row.AppendChild(cell);
+            }
+
+            table.AppendChild(row);
+        }
+
+        body.AppendChild(GetLegend());
+        body.Append(new Paragraph(new Run(new Text(""))));
+        body.AppendChild(table);
+
+        mainDocumentPart.Document.AppendChild(body);
+    }
+
+    private OpenXmlElement GetLegend()
+    {
+        var table = new Table();
+        foreach (var status in GradeStatus)
+        {
+            var row = new TableRow();
+            var cellName = CreateTableCellWithBorders("200");
+            cellName.Append(new Paragraph(new Run(new Text(status.Value.Status))));
+
+            var cellValue = CreateTableCellWithBorders("200");
+            cellValue.Append(new Paragraph(new Run(new Text(""))));
+            cellValue.FirstChild.Append(new Shading
+            {
+                Fill = status.Value.Color,
+            });
+            row.AppendChild(cellName);
+            row.AppendChild(cellValue);
+            table.AppendChild(row);
+        }
+
+        return table;
+    }
+
+
+    private static TableCell CreateTableCellWithBorders(string? width, params OpenXmlElement[] elements)
+    {
+        var cell = new TableCell();
+        var cellProperties = new TableCellProperties();
+        var borders = new TableCellBorders(
+            new LeftBorder
+            {
+                Val = BorderValues.Single,
+            },
+            new RightBorder
+            {
+                Val = BorderValues.Single,
+            },
+            new TopBorder
+            {
+                Val = BorderValues.Single,
+            },
+            new BottomBorder
+            {
+                Val = BorderValues.Single,
+            });
+
+        foreach (var element in elements)
+        {
+            cell.Append(element);
+        }
+
+        if (width != null)
+        {
+            cellProperties.Append(new TableCellWidth
+            {
+                Type = TableWidthUnitValues.Dxa, Width = width,
+            });
+        }
+
+        cellProperties.Append(borders);
+        cell.PrependChild(cellProperties);
+
+        return cell;
+    }
+}

Epsilon.Abstractions/Component/KpiMatrixOutcome.cs

@@ -0,0 +1,7 @@
+
+namespace Epsilon.Abstractions.Component;
+public record KpiMatrixOutcome(
+    int Id,
+    string Title,
+    KpiMatrixOutcomeGradeStatus KpiMatrixOutcomeGradeStatus
+);

Epsilon.Abstractions/Component/KpiMatrixOutcomeGradeStatus.cs

@@ -0,0 +1,6 @@
+namespace Epsilon.Abstractions.Component;
+
+public record KpiMatrixOutcomeGradeStatus(
+    string Status,
+    string Color
+);

Epsilon.Abstractions/Component/PersonaPage.cs

@@ -0,0 +1,25 @@
+using System.Text;
+using DocumentFormat.OpenXml.Packaging;
+using DocumentFormat.OpenXml.Wordprocessing;
+
+namespace Epsilon.Abstractions.Component;
+
+[CompetenceComponentName("persona")]
+public record PersonaPage(string PersonaHtml) : ICompetenceWordComponent
+{
+    public void AddToWordDocument(MainDocumentPart mainDocumentPart)
+    {
+        var personaHtmlBuffer = Encoding.UTF8.GetPreamble().Concat(Encoding.UTF8.GetBytes($"<html>{PersonaHtml}</html>")).ToArray();
+        using var personaHtmlStream = new MemoryStream(personaHtmlBuffer);
+
+        var formatImportPart = mainDocumentPart.AddAlternativeFormatImportPart(AlternativeFormatImportPartType.Html);
+        formatImportPart.FeedData(personaHtmlStream);
+
+        mainDocumentPart.Document.AppendChild(new Body(
+            new AltChunk
+            {
+                Id = mainDocumentPart.GetIdOfPart(formatImportPart),
+            }
+        ));
+    }
+}

Epsilon.Abstractions/Service/ICompetenceComponentService.cs

@@ -4,11 +4,11 @@ namespace Epsilon.Abstractions.Service;
 
 public interface ICompetenceComponentService
 {
-    IAsyncEnumerable<ICompetenceComponent> GetComponents();
+    IAsyncEnumerable<ICompetenceComponent> GetComponents(DateTime startDate, DateTime endDate);
 
-    IAsyncEnumerable<TComponent> GetComponents<TComponent>() where TComponent : ICompetenceComponent;
+    IAsyncEnumerable<TComponent> GetComponents<TComponent>(DateTime startDate, DateTime endDate) where TComponent : ICompetenceComponent;
 
-    Task<ICompetenceComponent?> GetComponent(string name);
+    Task<ICompetenceComponent?> GetComponent(string name, DateTime startDate, DateTime endDate);
 
-    Task<TComponent?> GetComponent<TComponent>(string name) where TComponent : class, ICompetenceComponent;
+    Task<TComponent?> GetComponent<TComponent>(string name, DateTime startDate, DateTime endDate) where TComponent : class, ICompetenceComponent;
 }

Epsilon.Abstractions/Service/ICompetenceDocumentService.cs

@@ -2,5 +2,5 @@ namespace Epsilon.Abstractions.Service;
 
 public interface ICompetenceDocumentService
 {
-    Task<Stream> WriteDocument(Stream stream);
+    Task<Stream> WriteDocument(Stream stream, DateTime startDate, DateTime endDate);
 }

Epsilon.Canvas.Abstractions/Model/GraphQl/AssessmentRating.cs

@@ -3,6 +3,7 @@
 namespace Epsilon.Canvas.Abstractions.Model.GraphQl;
 
 public record AssessmentRating(
-    [property: JsonPropertyName("criterion")] Criterion Criterion,
-    [property: JsonPropertyName("points")] double? Points
+    [property: JsonPropertyName("criterion")] Criterion? Criterion,
+    [property: JsonPropertyName("points")] double? Points,
+    [property: JsonPropertyName("outcome")] Outcome? Outcome
 );

Epsilon.Canvas.Abstractions/Model/GraphQl/Assignment.cs

@@ -4,5 +4,6 @@ namespace Epsilon.Canvas.Abstractions.Model.GraphQl;
 
 public record Assignment(
     [property: JsonPropertyName("name")] string? Name, 
-    [property: JsonPropertyName("modules")] IEnumerable<Module>? Modules 
+    [property: JsonPropertyName("modules")] IEnumerable<Module>? Modules ,
+    [property: JsonPropertyName("rubric")] Rubric? Rubric 
 );

Epsilon.Canvas.Abstractions/Model/GraphQl/Criteria.cs

@@ -0,0 +1,7 @@
+using System.Text.Json.Serialization;
+
+namespace Epsilon.Canvas.Abstractions.Model.GraphQl;
+
+public record Criteria(
+    [property: JsonPropertyName("outcome")] Outcome? Outcome 
+    );

Epsilon.Canvas.Abstractions/Model/GraphQl/Criterion.cs

@@ -4,5 +4,5 @@ namespace Epsilon.Canvas.Abstractions.Model.GraphQl;
 
 public record Criterion(
     [property: JsonPropertyName("masteryPoints")] double? MasteryPoints,
-    [property: JsonPropertyName("outcome")] Outcome Outcome
+    [property: JsonPropertyName("outcome")] Outcome? Outcome
 );