New Task model using SwiftData and Schedule creation using Calendar Recurrence Rule

[Supereg]

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 using DateComponents, we use the new RecurrenceRule infrastructure introduced with iOS 18.

Using a Schedule, you can generate a potentially infinite list of Occurrences. A Task uses the occurrences of its Schedule to generate Events. When events are marked as completed, they are associated with an Outcome. Both a Task and an Outcome can be extended with arbitrary data. This is enabled using the @Property macro, that allows to define custom properties on tasks and outcomes using a SharedRepository-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:

import Spezi
import SpeziScheduler

class MySchedulerModule: Module {
    @Dependency(Scheduler.self)
    private var scheduler

    init() {}

    func configure() {
        do {
            try scheduler.createOrUpdateTask(
                id: "my-daily-task",
                title: "Daily Questionnaire",
                instructions: "Please fill out the Questionnaire every day.",
                category: Task.Category("Questionnaire", systemName: "list.clipboard.fill"),
                schedule: .daily(hour: 9, minute: 0, startingAt: .today)
            )
        } catch {
            // handle error (e.g., visualize in your UI)
        }
    }
}

⚙️ Release Notes

• New version Scheduler Store using SwiftData.
• New Task module using Events and Outcomes.
• New Schedule model based on RecurrenceRule allowing for greater flexibility when specifying schedules.
• Introduces new UI components to easily visualize events.
• New @EventQuery property wrapper to easily query events in your SwiftUI view.

Breaking Changes

• This version of SpeziScheduler is not compatible with the previous version. All previously persisted data will be permanently deleted when using this new version. Already scheduled Notifications may currently not be removed and may be continue to be delivered.

📚 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:

• I agree to follow the Code of Conduct and Contributing Guidelines.

[codecov]

Codecov Report

Attention: Patch coverage is 62.63191% with 602 lines in your changes missing coverage. Please review.

Project coverage is 63.11%. Comparing base (896eb44) to head (19139c5).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...s/SpeziSchedulerMacros/UserStorageEntryMacro.swift	0.00%	122 Missing ⚠️
Sources/SpeziSchedulerUI/EventScheduleList.swift	0.00%	113 Missing ⚠️
Sources/SpeziScheduler/Task/Task.swift	68.33%	51 Missing ⚠️
Sources/SpeziScheduler/Schedule/Schedule.swift	71.01%	49 Missing ⚠️
Sources/SpeziScheduler/Scheduler.swift	86.22%	39 Missing ⚠️
...es/SpeziScheduler/Schedule/Schedule+Duration.swift	52.31%	31 Missing ⚠️
Sources/SpeziScheduler/Task/Outcome.swift	20.52%	31 Missing ⚠️
.../SpeziScheduler/Task/AllowedCompletionPolicy.swift	46.67%	24 Missing ⚠️
Sources/SpeziSchedulerUI/InstructionsTile.swift	80.84%	23 Missing ⚠️
...rces/SpeziScheduler/UserInfo/UserInfoStorage.swift	64.41%	21 Missing ⚠️
... and 11 more

Additional details and impacted files

@@            Coverage Diff            @@
##           main      #44       +/-   ##
=========================================
+ Coverage      0   63.11%   +63.11%     
=========================================
  Files         0       24       +24     
  Lines         0     1648     +1648     
=========================================
+ Hits          0     1040     +1040     
- Misses        0      608      +608     

Files with missing lines	Coverage Δ
...iScheduler/Task/Task+LocalizedStringResource.swift	100.00% <100.00%> (ø)
...SchedulerUI/Category/TaskCategoryAppearances.swift	100.00% <100.00%> (ø)
...rUI/Category/TaskCategoryAppearancesModifier.swift	100.00% <100.00%> (ø)
...es/SpeziSchedulerMacros/SpeziSchedulerMacros.swift	0.00% <0.00%> (ø)
...rces/SpeziScheduler/Schedule/Date+Extensions.swift	86.67% <86.67%> (ø)
Sources/SpeziScheduler/EventQuery.swift	96.43% <96.43%> (ø)
Sources/SpeziScheduler/UserInfo/UserInfoKey.swift	0.00% <0.00%> (ø)
Sources/SpeziScheduler/Schedule/Occurence.swift	61.91% <61.91%> (ø)
Sources/SpeziSchedulerUI/DefaultTileHeader.swift	89.34% <89.34%> (ø)
Sources/SpeziScheduler/Task/Task+Category.swift	33.34% <33.34%> (ø)
... and 14 more

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 896eb44...19139c5. Read the comment docs.

[PSchmiedmayer]

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!