alex/canvasManagement
1
0
Fork 0
mirror of https://github.com/alexmickelson/canvasManagement.git synced 2026-03-25 23:28:33 -06:00
Code Issues Packages Projects Releases Wiki Activity

pivoting to local yaml files for state

Browse Source
This commit is contained in:
Alex Mickelson
2023-07-18 23:02:48 -06:00
parent d691f817b7
commit 04274bd6c5
15 changed files with 343 additions and 273 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@@ -2,3 +2,4 @@ obj/
bin/ bin/
.env .env
*.env *.env
storage/

150
Management.Test/Services/CanvasServiceTests.cs
View File

@@ -1,86 +1,86 @@
using CanvasModel.Courses; // using CanvasModel.Courses;
using CanvasModel.EnrollmentTerms; // using CanvasModel.EnrollmentTerms;
using FluentAssertions; // using FluentAssertions;
using Moq; // using Moq;
using RestSharp; // using RestSharp;
using System.Net; // using System.Net;
namespace Management.Test; // namespace Management.Test;
public class CanvasServiceTests // public class CanvasServiceTests
{ // {
[Test] // [Test]
public async Task CanReadCanvasSemesters() // public async Task CanReadCanvasSemesters()
{ // {
var expectedTerms = new EnrollmentTermModel[] { // var expectedTerms = new EnrollmentTermModel[] {
new EnrollmentTermModel( // new EnrollmentTermModel(
Id: 1, // Id: 1,
Name: "one", // Name: "one",
StartAt: new DateTime(2022, 1, 1), // StartAt: new DateTime(2022, 1, 1),
EndAt: new DateTime(2022, 2, 1) // EndAt: new DateTime(2022, 2, 1)
), // ),
}; // };
Mock<IWebRequestor> mockRequestor = getTermsMock(expectedTerms); // Mock<IWebRequestor> mockRequestor = getTermsMock(expectedTerms);
var service = new CanvasService(mockRequestor.Object); // var service = new CanvasService(mockRequestor.Object);
var canvasTerms = await service.GetTerms(); // var canvasTerms = await service.GetTerms();
canvasTerms.Should().BeEquivalentTo(expectedTerms); // canvasTerms.Should().BeEquivalentTo(expectedTerms);
} // }
[Test] // [Test]
public async Task CanGetActiveTerms() // public async Task CanGetActiveTerms()
{ // {
var expectedTerms = new EnrollmentTermModel[] { // var expectedTerms = new EnrollmentTermModel[] {
new EnrollmentTermModel( // new EnrollmentTermModel(
Id: 1, // Id: 1,
Name: "one", // Name: "one",
StartAt: new DateTime(2022, 5, 1), // StartAt: new DateTime(2022, 5, 1),
EndAt: new DateTime(2022, 7, 1) // EndAt: new DateTime(2022, 7, 1)
), // ),
new EnrollmentTermModel( // new EnrollmentTermModel(
Id: 2, // Id: 2,
Name: "two", // Name: "two",
StartAt: new DateTime(2022, 7, 1), // StartAt: new DateTime(2022, 7, 1),
EndAt: new DateTime(2022, 9, 1) // EndAt: new DateTime(2022, 9, 1)
), // ),
new EnrollmentTermModel( // new EnrollmentTermModel(
Id: 3, // Id: 3,
Name: "three", // Name: "three",
StartAt: new DateTime(2022, 9, 1), // StartAt: new DateTime(2022, 9, 1),
EndAt: new DateTime(2022, 10, 1) // EndAt: new DateTime(2022, 10, 1)
), // ),
new EnrollmentTermModel( // new EnrollmentTermModel(
Id: 4, // Id: 4,
Name: "four", // Name: "four",
StartAt: new DateTime(2022, 10, 1), // StartAt: new DateTime(2022, 10, 1),
EndAt: new DateTime(2022, 11, 1) // EndAt: new DateTime(2022, 11, 1)
), // ),
}; // };
Mock<IWebRequestor> mockRequestor = getTermsMock(expectedTerms); // Mock<IWebRequestor> mockRequestor = getTermsMock(expectedTerms);
var service = new CanvasService(mockRequestor.Object); // var service = new CanvasService(mockRequestor.Object);
var queryDate = new DateTime(2022, 6, 1); // var queryDate = new DateTime(2022, 6, 1);
var canvasTerms = await service.GetCurrentTermsFor(queryDate); // var canvasTerms = await service.GetCurrentTermsFor(queryDate);
canvasTerms.Count().Should().Be(3); // canvasTerms.Count().Should().Be(3);
var termIds = canvasTerms.Select(t => t.Id); // var termIds = canvasTerms.Select(t => t.Id);
var expectedIds = new int[] { 1, 2, 3 }; // var expectedIds = new int[] { 1, 2, 3 };
termIds.Should().BeEquivalentTo(expectedIds); // termIds.Should().BeEquivalentTo(expectedIds);
} // }
private static Mock<IWebRequestor> getTermsMock(EnrollmentTermModel[] expectedTerms) // private static Mock<IWebRequestor> getTermsMock(EnrollmentTermModel[] expectedTerms)
{ // {
var data = new RedundantEnrollmentTermsResponse(EnrollmentTerms: expectedTerms); // var data = new RedundantEnrollmentTermsResponse(EnrollmentTerms: expectedTerms);
var response = new RestResponse<RedundantEnrollmentTermsResponse>(); // var response = new RestResponse<RedundantEnrollmentTermsResponse>();
response.Data = data; // response.Data = data;
var mockRequestor = new Mock<IWebRequestor>(); // var mockRequestor = new Mock<IWebRequestor>();
mockRequestor // mockRequestor
.Setup(s => s.GetAsync<RedundantEnrollmentTermsResponse>(It.IsAny<RestRequest>())) // .Setup(s => s.GetAsync<RedundantEnrollmentTermsResponse>(It.IsAny<RestRequest>()))
.ReturnsAsync(response); // .ReturnsAsync(response);
return mockRequestor; // return mockRequestor;
} // }
} // }

186
Management.Web/Pages/Index.razor
View File

@@ -3,196 +3,18 @@
@using Management.Web.Shared.Semester @using Management.Web.Shared.Semester
@using CanvasModel.Courses @using CanvasModel.Courses
@using Microsoft.AspNetCore.Components.Server.ProtectedBrowserStorage @using Microsoft.AspNetCore.Components.Server.ProtectedBrowserStorage
@using LocalModels
@inject CanvasService canvas @inject CanvasService canvas
@inject CoursePlanner planner @inject CoursePlanner planner
@inject ProtectedLocalStorage BrowserStorage @inject ProtectedLocalStorage BrowserStorage
@inject YamlManager yamlManager
@code @code
{ {
private string semesterConfigurationKey = "semesterCalendarConfiguration";
private IEnumerable<EnrollmentTermModel>? terms { get; set; } = null;
private bool loadingCourses = false;
private IEnumerable<CourseModel>? courses {get; set;} = null;
private ulong? _selectedTermId { get; set; }
private ulong? selectedTermId {
get => _selectedTermId;
set
{
_selectedTermId = value;
updateCourses();
}
}
private EnrollmentTermModel? selectedTerm
{
get => terms?.FirstOrDefault(t => t.Id == selectedTermId);
}
private ulong? selectedCourseId {
get => planner.Course?.Id;
set
{
planner.Course = courses?.First(c => c.Id == value);
updateModules();
}
}
private List<DayOfWeek> days { get; set; } = new();
private bool saved { get; set; } = false;
protected override async Task OnInitializedAsync()
{
terms = await canvas.GetCurrentTermsFor();
readTermFromConfig();
readDaysFromConfig();
}
protected override async Task OnAfterRenderAsync(bool firstRender)
{
if(firstRender)
{
var storedConfiguration = await BrowserStorage.GetAsync<SemesterCalendarConfig>(semesterConfigurationKey);
if (storedConfiguration.Success)
{
planner.SemesterCalendar = storedConfiguration.Value;
}
else
{
Console.WriteLine("no stored configuration");
}
StateHasChanged();
}
}
private async Task updateCourses()
{
if(selectedTermId != null)
{
loadingCourses = true;
courses = await canvas.GetCourses((ulong)selectedTermId);
loadingCourses = false;
}
else
courses = null;
StateHasChanged();
}
private async Task updateModules()
{
if(planner.Course != null)
{
planner.Modules = await canvas.GetModules(planner.Course.Id);
}
StateHasChanged();
}
private void readTermFromConfig()
{
if (terms == null || planner.SemesterCalendar == null) return;
foreach (var term in terms)
{
var termInConfiguration = planner.SemesterCalendar.StartDate == term.StartAt;
if (termInConfiguration)
{
selectedTermId = term.Id;
}
}
}
private void readDaysFromConfig()
{
if (terms == null || planner.SemesterCalendar == null) return;
days = planner.SemesterCalendar.Days.ToList();
}
public async void HandleSave()
{
saved = true;
planner.SetConfiguration(
selectedTerm ?? throw new Exception("cannot save configuration without selecting term"),
days.ToArray()
);
await BrowserStorage.SetAsync(
semesterConfigurationKey,
planner.SemesterCalendar ?? throw new Exception("Semester Calendar configuration not properly configured")
);
}
} }
<PageTitle>Index</PageTitle> <PageTitle>Index</PageTitle>
@if (terms != null) <CurrentFiles />
{
<div class="row justify-content-center">
<div class="col-auto">
<label for="termselect">Select Term:</label>
<select id="termselect" class="form-select" @bind="selectedTermId">
@foreach (var term in terms)
{
<option value="@term.Id">@term.Name</option>
}
</select>
</div>
</div>
}
@if (selectedTerm is not null)
{
<h5 class="text-center mt-3">Select Days Of Week</h5>
<div class="row m-3">
@foreach (DayOfWeek day in (DayOfWeek[])Enum.GetValues(typeof(DayOfWeek)))
{
<div class="col">
<button class="@(
days.Contains(day)
? "btn btn-secondary"
: "btn btn-outline-secondary"
)" @onclick="() => {
if(days.Contains(day))
days.Remove(day);
else
days.Add(day);
}" disabled="@saved">
@day
</button>
</div>
}
@if(loadingCourses)
{
<Spinner />
}
</div>
@if(courses != null) <InitializeYamlFromCanvas />
{
<div class="row justify-content-center m-3">
<div class="col-auto">
<label for="courseselect">Select Course:</label>
<select id="courseselect" class="form-select" @bind="selectedCourseId">
@foreach (var course in courses)
{
<option value="@course.Id">@course.Name</option>
}
</select>
</div>
</div>
}
<div class="row justify-content-center">
<div class="col-auto">
<button @onclick="@HandleSave" class="btn btn-primary">
Save
</button>
</div>
</div>
}
@if(planner.Modules != null)
{
<div>@JsonSerializer.Serialize(planner.Modules)</div>
}
@if (planner.SemesterCalendar is not null)
{
<div class="text-center">Config complete</div>
}

3
Management.Web/Program.cs
View File

@@ -20,7 +20,8 @@ builder.Services.AddSingleton<IWebRequestor, WebRequestor>();
builder.Services.AddSingleton<CanvasService, CanvasService>(); builder.Services.AddSingleton<CanvasService, CanvasService>();
builder.Services.AddSingleton<CoursePlanner>(); builder.Services.AddSingleton<CoursePlanner>();
builder.Services.AddSingleton<AssignmentDragContainer>(); builder.Services.AddSingleton<AssignmentDragContainer>();
builder.Services.AddScoped<StorageManagement>(); builder.Services.AddScoped<BrowserStorageManagement>();
builder.Services.AddScoped<YamlManager>();
var app = builder.Build(); var app = builder.Build();

21
Management.Web/Shared/CurrentFiles.razor Normal file
View File

@@ -0,0 +1,21 @@
@using LocalModels
@inject YamlManager yamlManager
@code
{
public IEnumerable<LocalCourse> localCourses { get; set; }
protected override async Task OnInitializedAsync()
{
localCourses = await yamlManager.LoadSavedCourses();
}
}
@if(localCourses != null)
{
<h3>Stored Courses</h3>
@foreach (var course in localCourses)
{
<div>@course.Name</div>
}
}

153
Management.Web/Shared/InitializeYamlFromCanvas.razor Normal file
View File

@@ -0,0 +1,153 @@
@using CanvasModel.EnrollmentTerms
@using Management.Web.Shared.Semester
@using CanvasModel.Courses
@using Microsoft.AspNetCore.Components.Server.ProtectedBrowserStorage
@using LocalModels
@inject CanvasService canvas
@inject YamlManager yamlManager
@code {
private bool loadingCourses = false;
public IEnumerable<LocalCourse> localCourses { get; set; }
private IEnumerable<EnrollmentTermModel>? terms { get; set; } = null;
private IEnumerable<CourseModel>? courses { get; set;} = null;
private ulong? _selectedTermId { get; set; }
private ulong? selectedTermId
{
get => _selectedTermId;
set
{
_selectedTermId = value;
updateCourses();
}
}
private EnrollmentTermModel? selectedTerm
{
get => terms?.FirstOrDefault(t => t.Id == selectedTermId);
}
private ulong? _selectedCourseId { get; set; }
private ulong? selectedCourseId
{
get => _selectedCourseId;
set
{
_selectedCourseId = value;
}
}
private CourseModel? selectedCourse
{
get => courses?.First(c => c.Id == selectedCourseId);
}
private List<DayOfWeek> days { get; set; } = new();
protected override async Task OnInitializedAsync()
{
terms = await canvas.GetCurrentTermsFor();
}
private async Task YamlTrigger()
{
if(selectedCourse != null)
{
var course = new LocalCourse
{
Modules= new LocalModule[] {},
Name = selectedCourse.Name,
CanvasId = selectedCourse.Id,
DaysOfWeek = days,
};
await yamlManager.SaveCourse(course);
}
await updateCourses();
}
private async Task updateCourses()
{
if(selectedTermId != null)
{
loadingCourses = true;
localCourses = await yamlManager.LoadSavedCourses();
var storedCourseIds = localCourses.Select(c => c.CanvasId);
var allCourses = await canvas.GetCourses((ulong)selectedTermId);
courses = allCourses.Where(c => !storedCourseIds.Contains(c.Id));
loadingCourses = false;
}
else
courses = null;
StateHasChanged();
}
}
@if (terms != null)
{
<div class="row justify-content-center">
<div class="col-auto">
<label for="termselect">Select Term:</label>
<select id="termselect" class="form-select" @bind="selectedTermId">
@foreach (var term in terms)
{
<option value="@term.Id">@term.Name</option>
}
</select>
</div>
</div>
}
@if (selectedTerm is not null)
{
@if(loadingCourses)
{
<Spinner />
}
@if(courses != null)
{
<div class="row justify-content-center m-3">
<div class="col-auto">
<label for="courseselect">Select Course:</label>
<select id="courseselect" class="form-select" @bind="selectedCourseId">
@foreach (var course in courses)
{
<option value="@course.Id">@course.Name</option>
}
</select>
</div>
</div>
}
<h5 class="text-center mt-3">Select Days Of Week</h5>
<div class="row m-3">
@foreach (DayOfWeek day in (DayOfWeek[])Enum.GetValues(typeof(DayOfWeek)))
{
<div class="col">
<button class="@(
days.Contains(day)
? "btn btn-secondary"
: "btn btn-outline-secondary"
)" @onclick="() => {
if(days.Contains(day))
days.Remove(day);
else
days.Add(day);
}">
@day
</button>
</div>
}
</div>
<div class="text-center">
<button
@onclick="YamlTrigger"
class="btn btn-primary"
>
Save Yaml File
</button>
</div>
}

20
Management.Web/Shared/Module/Assignment/NewAssignment.razor
View File

@@ -4,7 +4,7 @@
@code { @code {
[Parameter, EditorRequired] [Parameter, EditorRequired]
public int ModuleIndex { get; set; } public ulong ModuleId { get; set; }
[Parameter] [Parameter]
public EventCallback OnSubmit { get; set; } public EventCallback OnSubmit { get; set; }
@@ -33,8 +33,16 @@
} }
} }
<form @onsubmit:preventDefault="true" @onsubmit="submitHandler"> <div class="modal">
<label for="Assignment Name">Name</label> <div class="modal-dialog">
<input id="moduleName" class="form-control" @bind="Name" /> <div class="modal-content">
<button class="btn btn-primary">Save</button> <div class="modal-body">
</form> <form @onsubmit:preventDefault="true" @onsubmit="submitHandler">
<label for="Assignment Name">Name</label>
<input id="moduleName" class="form-control" @bind="Name" />
<button class="btn btn-primary">Save</button>
</form>
</div>
</div>
</div>
</div>

14
Management.Web/Shared/Module/ModuleDetail.razor
View File

@@ -11,14 +11,16 @@
<h3 class="text-center">@Module.Name</h3> <h3 class="text-center">@Module.Name</h3>
<button class="btn btn-primary" @onclick="() => showAddAssignment = true">Add Assignment</button> <button
class="btn btn-primary"
@onclick="() => showAddAssignment = true"
>
Add Assignment
</button>
@if (showAddAssignment) @if (showAddAssignment)
{ {
@* <div class="ms-5 "> <NewAssignment ModuleId="Module.Id" OnSubmit="() => showAddAssignment = false" />
<div class="bg-light border rounded m-3 p-3">
<NewAssignment ModuleIndex="ModuleIndex" OnSubmit="() => showAddAssignment = false" />
</div>
</div> *@
} }
<h5>Assignments</h5> <h5>Assignments</h5>

2
Management.Web/Shared/Module/Modules.razor
View File

@@ -4,7 +4,7 @@
@inject CoursePlanner configurationManagement @inject CoursePlanner configurationManagement
@inject ProtectedLocalStorage BrowserStorage @inject ProtectedLocalStorage BrowserStorage
@inject StorageManagement storage @inject BrowserStorageManagement storage
@code { @code {
private bool showNewModule { get; set; } = false; private bool showNewModule { get; set; } = false;

4
Management.Web/Utils/StorageManagement.cs
View File

@@ -1,6 +1,6 @@
using Microsoft.AspNetCore.Components.Server.ProtectedBrowserStorage; using Microsoft.AspNetCore.Components.Server.ProtectedBrowserStorage;
public class StorageManagement public class BrowserStorageManagement
{ {
private string moduleStorageKey = "module storage key"; private string moduleStorageKey = "module storage key";
private string assignmentStorageKey = "assignment storage key"; private string assignmentStorageKey = "assignment storage key";
@@ -10,7 +10,7 @@ public class StorageManagement
private ProtectedLocalStorage storage { get; } private ProtectedLocalStorage storage { get; }
private CanvasService canvas { get; } private CanvasService canvas { get; }
public StorageManagement( public BrowserStorageManagement(
CoursePlanner configurationManagement, CoursePlanner configurationManagement,
ProtectedLocalStorage BrowserStorage, ProtectedLocalStorage BrowserStorage,
CanvasService canvasService CanvasService canvasService

1
Management/Management.csproj
View File

@@ -8,6 +8,7 @@
<ItemGroup> <ItemGroup>
<PackageReference Include="RestSharp" Version="108.0.3" /> <PackageReference Include="RestSharp" Version="108.0.3" />
<PackageReference Include="YamlDotNet" Version="13.1.1" />
</ItemGroup> </ItemGroup>
</Project> </Project>

0
Management/Models/CourseModule.cs → Management/Models/CanvasModels/CourseModule.cs
View File

9
Management/Models/Local/LocalCourse.cs Normal file
View File

@@ -0,0 +1,9 @@
namespace LocalModels;
public record LocalCourse
{
public IEnumerable<LocalModule> Modules { get; init; } = Enumerable.Empty<LocalModule>();
public string Name { get; init; } = string.Empty;
public IEnumerable<DayOfWeek> DaysOfWeek { get; init; } = Enumerable.Empty<DayOfWeek>();
public ulong? CanvasId { get; init; }
}

6
Management/Models/Local/LocalModules.cs Normal file
View File

@@ -0,0 +1,6 @@
namespace LocalModels;
public record LocalModule
{
public string Name { get; init; } = string.Empty;
}

46
Management/Services/YamlManager.cs Normal file
View File

@@ -0,0 +1,46 @@
using LocalModels;
using YamlDotNet.Serialization;
using YamlDotNet.Serialization.NamingConventions;
public class YamlManager
{
public string CourseToYaml(LocalCourse course)
{
var serializer = new SerializerBuilder()
.Build();
var yaml = serializer.Serialize(course);
System.Console.WriteLine(yaml);
return yaml;
}
public LocalCourse ParseCourse(string rawCourse)
{
var deserializer = new DeserializerBuilder()
.Build();
var person = deserializer.Deserialize<LocalCourse>(rawCourse);
return person;
}
public async Task SaveCourse(LocalCourse course)
{
var courseString = CourseToYaml(course);
await File.WriteAllTextAsync($"../storage/{course.Name}.yml", courseString);
}
public async Task<IEnumerable<LocalCourse>> LoadSavedCourses()
{
string path = "../storage/";
if (!Directory.Exists(path))
throw new Exception("storage folder not found");
var fileNames = Directory.GetFiles(path);
var courses = await Task.WhenAll(
fileNames.Select(async n => ParseCourse(await File.ReadAllTextAsync($"../storage/{n}")))
);
return courses;
}
}