StanfordSpezi / SpeziOnboarding

Spezi Onboarding module to inform a user or retrieve consent for a study participation
https://swiftpackageindex.com/StanfordSpezi/SpeziOnboarding/documentation/
MIT License
11 stars 5 forks source link

Upgrade to Observable, String Catalogs and bump Spezi dependencies #31

Closed Supereg closed 7 months ago

Supereg commented 7 months ago

Upgrade to Observable, String Catalogs and bump Spezi dependencies

:recycle: Current situation & Problem

This PR migrates SpeziOnboarding from using ObservableObject to the new Observable framework. Additionally it bumps all Spezi dependencies. Lastly, we migrate to using String Catalogs. This induced some changes in the views, such that we make sure to not translate standard String instances. Minor changes in the public API.

:gear: Release Notes

:books: Documentation

Some broken documentation was fixed.

:white_check_mark: Testing

Tests didn't require any modifications.

:pencil: Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

codecov[bot] commented 7 months ago

Codecov Report

Merging #31 (9ad2715) into main (52250fa) will decrease coverage by 2.04%. The diff coverage is 46.22%.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/31/graphs/tree.svg?width=650&height=150&src=pr&token=tVwIFVPdJG&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi)](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/31?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) ```diff @@ Coverage Diff @@ ## main #31 +/- ## ========================================== - Coverage 73.33% 71.28% -2.04% ========================================== Files 21 21 Lines 1046 1055 +9 ========================================== - Hits 767 752 -15 - Misses 279 303 +24 ``` | [Files](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/31?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) | Coverage Δ | | |---|---|---| | [...ources/SpeziOnboarding/OnboardingConsentView.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/31?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ0NvbnNlbnRWaWV3LnN3aWZ0) | `76.70% <100.00%> (ø)` | | | [Sources/SpeziOnboarding/OnboardingDataSource.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/31?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ0RhdGFTb3VyY2Uuc3dpZnQ=) | `100.00% <ø> (ø)` | | | [.../OnboardingFlow/OnboardingFlowViewCollection.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/31?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ0Zsb3cvT25ib2FyZGluZ0Zsb3dWaWV3Q29sbGVjdGlvbi5zd2lmdA==) | `100.00% <ø> (ø)` | | | [...ding/OnboardingFlow/OnboardingNavigationPath.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/31?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ0Zsb3cvT25ib2FyZGluZ05hdmlnYXRpb25QYXRoLnN3aWZ0) | `84.69% <100.00%> (-0.13%)` | :arrow_down: | | [.../SpeziOnboarding/ConsentView/ConsentDocument.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/31?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvQ29uc2VudFZpZXcvQ29uc2VudERvY3VtZW50LnN3aWZ0) | `87.71% <75.00%> (+0.07%)` | :arrow_up: | | [...ing/OnboardingFlow/IllegalOnboardingStepView.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/31?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ0Zsb3cvSWxsZWdhbE9uYm9hcmRpbmdTdGVwVmlldy5zd2lmdA==) | `0.00% <0.00%> (ø)` | | | [...eziOnboarding/OnboardingFlow/OnboardingStack.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/31?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ0Zsb3cvT25ib2FyZGluZ1N0YWNrLnN3aWZ0) | `83.34% <88.89%> (ø)` | | | [Sources/SpeziOnboarding/OnboardingTitleView.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/31?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ1RpdGxlVmlldy5zd2lmdA==) | `68.58% <60.00%> (-11.42%)` | :arrow_down: | | [Sources/SpeziOnboarding/OnboardingView.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/31?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ1ZpZXcuc3dpZnQ=) | `51.25% <0.00%> (ø)` | | | [...es/SpeziOnboarding/OnboardingInformationView.swift](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/31?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi#diff-U291cmNlcy9TcGV6aU9uYm9hcmRpbmcvT25ib2FyZGluZ0luZm9ybWF0aW9uVmlldy5zd2lmdA==) | `50.00% <45.00%> (-1.89%)` | :arrow_down: | | ... and [2 more](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/31?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) | | ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/31?src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/31?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). Last update [52250fa...9ad2715](https://app.codecov.io/gh/StanfordSpezi/SpeziOnboarding/pull/31?src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=StanfordSpezi).