Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

All Announcements View #175

Merged
merged 6 commits into from
Jan 20, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions CanvasPlusPlayground.xcodeproj/project.pbxproj
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,10 @@
B7C0A3CB2D2F919F003E5A36 /* PinButton.swift in Sources */ = {isa = PBXBuildFile; fileRef = B7C0A3CA2D2F919F003E5A36 /* PinButton.swift */; };
B7C0A3CD2D3023CA003E5A36 /* PinnedItem.swift in Sources */ = {isa = PBXBuildFile; fileRef = B7C0A3CC2D3023CA003E5A36 /* PinnedItem.swift */; };
B7C0A3CF2D31F339003E5A36 /* PinnedItemCard.swift in Sources */ = {isa = PBXBuildFile; fileRef = B7C0A3CE2D31F339003E5A36 /* PinnedItemCard.swift */; };
B7D7512B2D3D5D8000F7B8B8 /* AllAnnouncementsView.swift in Sources */ = {isa = PBXBuildFile; fileRef = B7D7512A2D3D5D7700F7B8B8 /* AllAnnouncementsView.swift */; };
B7D7512D2D3D652300F7B8B8 /* GetAnnouncementsBatchRequest.swift in Sources */ = {isa = PBXBuildFile; fileRef = B7D7512C2D3D652300F7B8B8 /* GetAnnouncementsBatchRequest.swift */; };
B7D7512F2D3D660B00F7B8B8 /* AllAnnouncementsManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = B7D7512E2D3D660B00F7B8B8 /* AllAnnouncementsManager.swift */; };
B7D751312D3D688C00F7B8B8 /* AnnouncementRow.swift in Sources */ = {isa = PBXBuildFile; fileRef = B7D751302D3D688C00F7B8B8 /* AnnouncementRow.swift */; };
B7D95D772D07C3D3002AD955 /* ICSParser.swift in Sources */ = {isa = PBXBuildFile; fileRef = B7D95D762D07C3D3002AD955 /* ICSParser.swift */; };
B7D95DB72D0A8D78002AD955 /* SettingsView.swift in Sources */ = {isa = PBXBuildFile; fileRef = B7D95DB62D0A8D75002AD955 /* SettingsView.swift */; };
B7E59A102D2002A5001836FE /* Sidebar.swift in Sources */ = {isa = PBXBuildFile; fileRef = B7E59A0F2D2002A3001836FE /* Sidebar.swift */; };
Expand Down Expand Up @@ -254,6 +258,10 @@
B7C0A3CA2D2F919F003E5A36 /* PinButton.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PinButton.swift; sourceTree = "<group>"; };
B7C0A3CC2D3023CA003E5A36 /* PinnedItem.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PinnedItem.swift; sourceTree = "<group>"; };
B7C0A3CE2D31F339003E5A36 /* PinnedItemCard.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PinnedItemCard.swift; sourceTree = "<group>"; };
B7D7512A2D3D5D7700F7B8B8 /* AllAnnouncementsView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AllAnnouncementsView.swift; sourceTree = "<group>"; };
B7D7512C2D3D652300F7B8B8 /* GetAnnouncementsBatchRequest.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GetAnnouncementsBatchRequest.swift; sourceTree = "<group>"; };
B7D7512E2D3D660B00F7B8B8 /* AllAnnouncementsManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AllAnnouncementsManager.swift; sourceTree = "<group>"; };
B7D751302D3D688C00F7B8B8 /* AnnouncementRow.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AnnouncementRow.swift; sourceTree = "<group>"; };
B7D95D762D07C3D3002AD955 /* ICSParser.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ICSParser.swift; sourceTree = "<group>"; };
B7D95DB62D0A8D75002AD955 /* SettingsView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SettingsView.swift; sourceTree = "<group>"; };
B7E59A0F2D2002A3001836FE /* Sidebar.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Sidebar.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -293,6 +301,7 @@
A3049B732D15DBEE002F3166 /* API Requests */ = {
isa = PBXGroup;
children = (
B7D7512C2D3D652300F7B8B8 /* GetAnnouncementsBatchRequest.swift */,
A3049B762D15DC36002F3166 /* GetCourseRequest.swift */,
A3049B742D15DC1C002F3166 /* GetCoursesRequest.swift */,
A3049B782D15E162002F3166 /* GetCourseRootFolder.swift */,
Expand Down Expand Up @@ -338,10 +347,13 @@
A324BA512D079646005F53FA /* Announcements */ = {
isa = PBXGroup;
children = (
B7D7512A2D3D5D7700F7B8B8 /* AllAnnouncementsView.swift */,
B7D7512E2D3D660B00F7B8B8 /* AllAnnouncementsManager.swift */,
9B92A4242C93856100C21CFC /* CourseAnnouncementManager.swift */,
9B6663E22C9853BC0060990E /* HTMLTextView.swift */,
9B9C2E052C93F94C00E4B16B /* CourseAnnouncementDetailView.swift */,
9B9C2E032C93F6CD00E4B16B /* CourseAnnouncementsView.swift */,
B7D751302D3D688C00F7B8B8 /* AnnouncementRow.swift */,
A373DC1F2D1D2B9D00215019 /* Models */,
);
path = Announcements;
Expand Down Expand Up @@ -767,6 +779,7 @@
A3049B7B2D15E2B7002F3166 /* GetFilesInFolderRequest.swift in Sources */,
A3CF88DB2D192194000ACDF3 /* EnrollmentAPI.swift in Sources */,
B7F950322D118EAF004BB470 /* String+StripHTML.swift in Sources */,
B7D7512D2D3D652300F7B8B8 /* GetAnnouncementsBatchRequest.swift in Sources */,
A324BA6A2D0817AB005F53FA /* FoldersPageView.swift in Sources */,
B7A26EE92CCB62A30084704A /* NavigationModel.swift in Sources */,
192EC04A2C963B9000AF8528 /* AssignmentAPI.swift in Sources */,
Expand Down Expand Up @@ -803,6 +816,7 @@
B7E59A142D2004A4001836FE /* CourseListCell.swift in Sources */,
B53D95A22CA0A22A00647EE9 /* PeopleView.swift in Sources */,
A373DC312D28176100215019 /* APIModule.swift in Sources */,
B7D7512F2D3D660B00F7B8B8 /* AllAnnouncementsManager.swift in Sources */,
A3049B752D15DC1C002F3166 /* GetCoursesRequest.swift in Sources */,
B76455042C8DF61B002DF00E /* CourseView.swift in Sources */,
A3049B682D0F3ECA002F3166 /* QuizzesViewModel.swift in Sources */,
Expand Down Expand Up @@ -840,6 +854,7 @@
B7C0A3CB2D2F919F003E5A36 /* PinButton.swift in Sources */,
B7F950392D1279A1004BB470 /* UserAPI.swift in Sources */,
A3049B662D0F3E32002F3166 /* CourseQuizzesView.swift in Sources */,
B7D7512B2D3D5D8000F7B8B8 /* AllAnnouncementsView.swift in Sources */,
A3E7F3892C954E0500DC4300 /* CanvasRequest.swift in Sources */,
A35191412D283589001E415F /* ModulesViewModel.swift in Sources */,
A3E7F3912C99317100DC4300 /* CourseTabsManager.swift in Sources */,
Expand Down Expand Up @@ -876,6 +891,7 @@
A3D161492D169C23004055FB /* APIRequest+Storage.swift in Sources */,
9B6663E32C9853BC0060990E /* HTMLTextView.swift in Sources */,
B7AD550C2CD4257B00FB09BB /* IntelligenceOnboardingView.swift in Sources */,
B7D751312D3D688C00F7B8B8 /* AnnouncementRow.swift in Sources */,
A3049B792D15E162002F3166 /* GetCourseRootFolder.swift in Sources */,
7F8535742C98DE3C0023E384 /* CourseGradeView.swift in Sources */,
A3049B7F2D160C03002F3166 /* GetTabsRequest.swift in Sources */,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
//
// GetAnnouncementsBatchRequest.swift
// CanvasPlusPlayground
//
// Created by Rahul on 1/19/25.
//

import Foundation

struct GetAnnouncementsBatchRequest: CacheableArrayAPIRequest {
typealias Subject = AnnouncementAPI

var path: String { "announcements" }

var queryParameters: [QueryParameter] {
[
("start_date", startDate?.ISO8601Format()),
("end_date", endDate?.ISO8601Format()),
// ("active_only", activeOnly), ONLY FOR TEACHERS
("latest_only", latestOnly),
("per_page", perPage)
]
+ contextCodes.map { ("context_codes[]", $0) }
+ include.map { ("include[]", $0) }
}

// MARK: Query Params
/// At least one context code must be provided here otherwise request fails
let contextCodes: [String]
let startDate: Date?
let endDate: Date?
// let activeOnly: Bool? ONLY FOR TEACHERS
let latestOnly: Bool?
let include: [String]
let perPage: Int

init(
courseIds: [String],
startDate: Date? = nil,
endDate: Date? = nil,
latestOnly: Bool? = nil,
include: [String] = [],
perPage: Int = 50
) {
self.contextCodes = courseIds.map { "course_\($0)" }
self.startDate = startDate
self.endDate = endDate
self.latestOnly = latestOnly
self.include = include
self.perPage = perPage
}
rahulon12 marked this conversation as resolved.
Show resolved Hide resolved

var requestId: String? { "announcements/\(contextCodes.joined(separator: "_"))" }
var requestIdKey: ParentKeyPath<Announcement, String?> {
.createReadable(\.contextCode)
}
var idPredicate: Predicate<Announcement> {
let contextCodes = contextCodes as [String?]
let contextCodePred = contextCodes.isEmpty ? .true : #Predicate<Announcement> { announcement in
contextCodes.contains(announcement.contextCode)
}

return contextCodePred
}
var customPredicate: Predicate<Announcement> {
let contextCodes = contextCodes as [String?]
let contextCodePred = contextCodes.isEmpty ? .true : #Predicate<Announcement> { announcement in
contextCodes.contains(announcement.contextCode)
}
rahulon12 marked this conversation as resolved.
Show resolved Hide resolved

let startDatePredicate: Predicate<Announcement>
if let startDate {
startDatePredicate = #Predicate<Announcement> { announcement in
if let createdAt = announcement.createdAt {
startDate <= (createdAt)
} else { true }
}
} else { startDatePredicate = .true }

let endDatePredicate: Predicate<Announcement>
if let endDate {
endDatePredicate = #Predicate<Announcement> { announcement in
if let createdAt = announcement.createdAt {
endDate >= createdAt
} else { true }
}
} else { endDatePredicate = .true }

return #Predicate<Announcement> { announcement in
contextCodePred.evaluate(announcement) && startDatePredicate.evaluate(announcement) && endDatePredicate.evaluate(announcement)
}
}
}
16 changes: 16 additions & 0 deletions CanvasPlusPlayground/Common/Network/CanvasRequest.swift
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ struct CanvasRequest {
GetTabsRequest(courseId: courseId)
}

/// Fetches Announcements for one course
static func getAnnouncements(
courseId: String,
startDate: Date = .distantPast,
Expand All @@ -50,6 +51,21 @@ struct CanvasRequest {
)
}

/// Fetches announcements for all courses with id's in `courseIds`
static func getAnnouncements(
courseIds: [String],
startDate: Date = .distantPast,
endDate: Date = .now,
perPage: Int = 15
) -> GetAnnouncementsBatchRequest {
GetAnnouncementsBatchRequest(
courseIds: courseIds,
startDate: startDate,
endDate: endDate,
perPage: perPage
)
}

static func getAssignment(id: String, courseId: String) -> GetAssignmentRequest {
GetAssignmentRequest(assignmentId: id, courseId: courseId)
}
Expand Down
4 changes: 3 additions & 1 deletion CanvasPlusPlayground/Common/Utilities/String+StripHTML.swift
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import Foundation

extension String {
func stripHTML() -> String {
return replacingOccurrences(of: "<[^>]+>", with: "", options: .regularExpression)
replacingOccurrences(of: "<[^>]+>", with: "", options: .regularExpression)
.replacingOccurrences(of: "&nbsp;", with: "")
.replacingOccurrences(of: "&amp;", with: "&")
Comment on lines +12 to +14
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what does this do?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixes issue where announcements may show HTML entities (like &nbsp).

}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
//
// AllAnnouncementsManager.swift
// CanvasPlusPlayground
//
// Created by Rahul on 1/19/25.
//

import Foundation

@Observable class AllAnnouncementsManager {
var announcements: [Announcement] = []

func fetchAnnouncements(courses: [Course]) async {
let courseIds = courses.map { $0.id }

let announcements: [Announcement]? = try? await CanvasService.shared.loadAndSync(
CanvasRequest.getAnnouncements(courseIds: courseIds),
onCacheReceive: { (cached: [Announcement]?) in
guard let cached else { return }

setAnnouncements(cached, courses: courses)
},
onNewBatch: { batchAnnouncements in
setBatchAnnouncements(batchAnnouncements, courses: courses)
}
)

guard let announcements else {
print("Failed to fetch announcements.")
return
}

setAnnouncements(announcements, courses: courses)
}

private func setAnnouncements(_ announcements: [Announcement], courses: [Course]) {
DispatchQueue.main.async {
self.announcements = announcements.map { announcement in
guard announcement.course == nil,
let contextCode = announcement.contextCode else {
return announcement
}

announcement.course = courses.first(where: { course in
contextCode.contains(course.id)
})

return announcement
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i like this

}.sorted { $0.createdAt ?? Date() > $1.createdAt ?? Date() }
}
}

private func setBatchAnnouncements(
_ announcements: [Announcement],
courses: [Course]
) {
let newAnnouncements = self.announcements + announcements.filter {
!self.announcements.contains($0)
}

setAnnouncements(newAnnouncements, courses: courses)
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
//
// AllAnnouncementsView.swift
// CanvasPlusPlayground
//
// Created by Rahul on 1/19/25.
//

import SwiftUI

struct AllAnnouncementsView: View {
@Environment(CourseManager.self) private var courseManager

@State private var announcementsManager = AllAnnouncementsManager()
@State private var selectedAnnouncement: Announcement?
@State private var isLoadingAnnouncements = false

var body: some View {
List(selection: $selectedAnnouncement) {
ForEach(announcementsManager.announcements) { announcement in
NavigationLink {
CourseAnnouncementDetailView(announcement: announcement)
} label: {
AnnouncementRow(
course: announcement.course,
announcement: announcement,
showCourseName: true
)
}
}
}
.navigationTitle("All Announcements")
.statusToolbarItem("Announcements", isVisible: isLoadingAnnouncements)
.task {
isLoadingAnnouncements = true
await announcementsManager
.fetchAnnouncements(courses: courseManager.courses)
isLoadingAnnouncements = false
}
}
}
Loading