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

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

Open
wants to merge 44 commits into
base: main
Choose a base branch
from

Conversation

Supereg
Copy link
Member

@Supereg Supereg commented Aug 23, 2024

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.

⚙️ 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:

Copy link

codecov bot commented Sep 9, 2024

Codecov Report

Attention: Patch coverage is 63.65435% with 551 lines in your changes missing coverage. Please review.

Project coverage is 63.94%. Comparing base (896eb44) to head (b08e806).

Files with missing lines Patch % Lines
...s/SpeziSchedulerMacros/UserStorageEntryMacro.swift 0.00% 122 Missing ⚠️
Sources/SpeziSchedulerUI/TodayList.swift 0.00% 65 Missing ⚠️
Sources/SpeziScheduler/Task/Task.swift 68.33% 51 Missing ⚠️
Sources/SpeziScheduler/Schedule/Schedule.swift 71.01% 49 Missing ⚠️
Sources/SpeziScheduler/Scheduler.swift 81.30% 49 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 ⚠️
...rces/SpeziScheduler/UserInfo/UserInfoStorage.swift 64.41% 21 Missing ⚠️
...peziSchedulerMacros/SpeziSchedulerDiagnostic.swift 0.00% 18 Missing ⚠️
... and 11 more
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##           main      #44       +/-   ##
=========================================
+ Coverage      0   63.94%   +63.94%     
=========================================
  Files         0       24       +24     
  Lines         0     1550     +1550     
=========================================
+ Hits          0      991      +991     
- Misses        0      559      +559     
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/UserInfo/UserInfoKey.swift 0.00% <0.00%> (ø)
Sources/SpeziScheduler/EventQuery.swift 95.24% <95.24%> (ø)
Sources/SpeziScheduler/Schedule/Occurence.swift 61.91% <61.91%> (ø)
Sources/SpeziSchedulerUI/DefaultTileHeader.swift 89.34% <89.34%> (ø)
Sources/SpeziSchedulerUI/InstructionsTile.swift 90.43% <90.43%> (ø)
... 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...b08e806. Read the comment docs.

@Supereg Supereg changed the title Infinity Loop New Task model using SwiftData and Schedule creation using Calendar Recurrence Rule Sep 10, 2024
@Supereg Supereg mentioned this pull request Sep 10, 2024
1 task
@Supereg Supereg marked this pull request as ready for review September 10, 2024 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant