-
-
Notifications
You must be signed in to change notification settings - Fork 3
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
New Task model using SwiftData and Schedule creation using Calendar Recurrence Rule #44
base: main
Are you sure you want to change the base?
Conversation
…s for simplifications
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for all the work in this PR; amazing job!!
It would be amazing to update the README accordingly and address the smaller comments I had in the PR review. A huge step toward improving on the Scheduler module; amazing job!
@@ -16,39 +16,56 @@ on: | |||
workflow_dispatch: | |||
|
|||
jobs: | |||
determine_macos_version: # Currently some runners still run on macOS 14 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All our runners should be update to macOS 15, we should be able to remove this now.
.package(url: "https://github.com/StanfordSpezi/SpeziStorage", from: "1.1.2") | ||
.package(url: "https://github.com/StanfordSpezi/SpeziViews", branch: "feature/additional-infrastructure"), | ||
.package(url: "https://github.com/StanfordSpezi/SpeziStorage", from: "1.1.2"), | ||
.package(url: "https://github.com/swiftlang/swift-syntax", from: "600.0.0-prerelease-2024-08-14"), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could probably update this to https://github.com/swiftlang/swift-syntax/releases/tag/600.0.1
.package(url: "https://github.com/StanfordSpezi/Spezi", from: "1.7.0"), | ||
.package(url: "https://github.com/StanfordSpezi/SpeziStorage", from: "1.1.2") | ||
.package(url: "https://github.com/StanfordSpezi/SpeziViews", branch: "feature/additional-infrastructure"), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO to use a release before we merge the PR.
private let logger = Logger(subsystem: "edu.stanford.spezi.scheduler", category: "EventQuery") | ||
|
||
|
||
func measure<T, C: Clock>( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice mechanism! We might want to make this private or fileprivate if we only use it here?
} | ||
|
||
|
||
extension Occurrence: CustomStringConvertible { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wonder if would be helpful to also add https://developer.apple.com/documentation/swift/debugdescription() here to make the types easier to debug as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very cool mechanism; great job!
/// ### Providing hints and tips | ||
/// | ||
/// Sometimes it might be necessary to provide more detailed information or explanation about a event. You can supply a "More Information" view to the tile. | ||
/// In this case a small "(i)" button will be displayed that presents the view as a sheet. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very cool mechanism!
/// } | ||
/// .navigationTitle("Schedule") | ||
/// ``` | ||
public struct TodayList<Tile: View>: View { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very cool reusable mechanism; we might want to extend this to display any arbitrary date in the future that can be driven by a nice UI adding a date selector 👍
] | ||
|
||
|
||
final class UserStorageEntryMacroTests: XCTestCase { // swiftlint:disable:this type_body_length |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very cool to see these tests validating the behavior!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wondering if we can include some of the UI images in the documentation to have some visual examples using the images.
New Task model using SwiftData and Schedule creation using Calendar Recurrence Rule
♻️ Current situation & Problem
This PR completely rethinks the Scheduler package.
We introduce an updated Task model that is completely backed by SwiftData. Further, we provide a new
Schedule
model that provides greater flexibility for formulating recurring events. Instead of formulating events based on intervals usingDateComponents
, we use the newRecurrenceRule
infrastructure introduced with iOS 18.Using a
Schedule
, you can generate a potentially infinite list ofOccurrence
s. ATask
uses the occurrences of its Schedule to generateEvents
. When events are marked as completed, they are associated with anOutcome
. Both aTask
and anOutcome
can be extended with arbitrary data. This is enabled using the@Property
macro, that allows to define custom properties on tasks and outcomes using aSharedRepository
-backed storage implementation.Task
are stored in an versioned, append-only store. Modifying the contents of a Task (e.g., instructions, schedules, ...), appends a new Task version and marks it as effective for the specified date. This allows to modify tasks without changing previous events or occurrences. Something that was impossible with the previous implementation.Lastly, the updated Scheduler provides additional support for UI components out of the box. We provide the new
@EventQuery
property wrapper that you can use in your SwiftUI views. It allows to easily and efficiently query Events directly in SwiftUI.Additionally, we provide several, reusable UI components out of the box to visualize events in your application.
Notifications are currently no longer supported with this version of SpeziScheduler: #45 (This is now tackled in #49 which will most likely be merged alongside this PR).
An example of how to configure tasks with this new model is depicted below:
⚙️ Release Notes
@EventQuery
property wrapper to easily query events in your SwiftUI view.Breaking Changes
📚 Documentation
The documentation catalog was completely restructured, highlighting all the new API and functionality.
✅ Testing
New unit and UI tests have been written to verify functionality. We aimed to set a focus on unit tests for fastest possible test execution.
📝 Code of Conduct & Contributing Guidelines
By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines: