Update release notes

danielsaidi · danielsaidi · commit e2fd2f3b5c85 · 2024-05-28T22:44:29.000+02:00
diff --git a/Demo/Demo.xcodeproj/project.xcworkspace/xcuserdata/danielsaidi.xcuserdatad/UserInterfaceState.xcuserstate b/Demo/Demo.xcodeproj/project.xcworkspace/xcuserdata/danielsaidi.xcuserdatad/UserInterfaceState.xcuserstate
diff --git a/Demo/Demo/ContentView.swift b/Demo/Demo/ContentView.swift
@@ -28,7 +28,6 @@ struct ContentView: View {
         NavigationStack {
             List {
                 Section("Onboardings") {
-
                     listButton(
                         .popover, 
                         presentPopover,
diff --git a/Demo/Demo/DemoPageContent.swift b/Demo/Demo/DemoPageContent.swift
@@ -13,7 +13,7 @@ struct DemoPageContent: View {
 
     @Binding
     var index: Int
-    let info: OnboardingPageInfo<LocalizedOnboardingFlow.Page>
+    let info: OnboardingPageInfo<LocalizedOnboarding.Page>
 
     @Environment(\.dismiss)
     private var dismiss
diff --git a/Demo/Demo/DemoPageView.swift b/Demo/Demo/DemoPageView.swift
@@ -11,7 +11,7 @@ import SwiftUI
 
 struct DemoPageView: View {
     
-    let onboarding: LocalizedOnboardingFlow
+    let onboarding: LocalizedOnboarding
 
     @Binding var index: Int
     
diff --git a/Demo/Demo/DemoSlideshow.swift b/Demo/Demo/DemoSlideshow.swift
@@ -11,7 +11,7 @@ import SwiftUI
 
 struct DemoSlideshow: View {
 
-    let onboarding: LocalizedOnboardingFlow
+    let onboarding: LocalizedOnboarding
 
     @Binding var index: Int
 
diff --git a/Demo/Demo/Onboarding+Demo.swift b/Demo/Demo/Onboarding+Demo.swift
@@ -43,7 +43,7 @@ extension Onboarding {
     static let demoToolbarPopover = Onboarding(id: "demo.toolbar.popover")
 }
 
-extension LocalizedOnboardingFlow {
+extension LocalizedOnboarding {
 
-    static let demo = LocalizedOnboardingFlow(id: "demo-flow")
+    static let demo = .init(id: "demo-flow")
 }
diff --git a/README.md b/README.md
@@ -23,7 +23,7 @@ OnboardingKit is a Swift SDK that helps you create onboarding experiences in `Sw
 
 OnboardingKit has different onboarding types. A standard ``Onboarding`` is shown right away, and only once, while other types can require multiple presentation attempts, a certain number of "incorrect" actions, etc.
 
-OnboardingKit also has localized utilities, like the ``LocalizedOnboardingFlow``, and UI components like ``OnboardingPageView`` and ``OnboardingSlideshow``.
+OnboardingKit also has localized utilities, like the ``LocalizedOnboarding``, and UI components like ``OnboardingPageView`` and ``OnboardingSlideshow``.
 
 
 
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -8,16 +8,13 @@ Breaking changes can still occur in minor updates, if there's a strong reason fo
 
 ## 8.0
 
-This version adds support for strict concurrency and a new slideshow component.
+This version adds support for strict concurrency and a new `OnboardingSlideshow` component.
 
-### ✨ New features
-
-* `OnboardingSlideshow` is a new view that automatically slides through a set of pages.
+To simplify the `OnboardingPageView` and `OnboardingSlideshow` view builder setup, these functions have been refactored to only use `OnboardingPageInfo` as parameter.
 
-### 💥 Breaking changes
-
-* To simplify the OnboardingPageView and OnboardingSlideshow view builders, these functions have been refactored to only use the OnboardingPageInfo type as parameter. This is a breaking change, but it's very easy to fix. Sorry for any inconvenience. 
+### ✨ New features
 
+* `OnboardingSlideshow` is a new view that automatically slides through a set of pages. 
 
 
 
diff --git a/Sources/OnboardingKit/OnboardingKit.docc/Getting-Started.md b/Sources/OnboardingKit/OnboardingKit.docc/Getting-Started.md
@@ -78,4 +78,4 @@ Both views can be styled by applying a style view modifier to the view hierarchy
 
 ## Localization
 
-You can use a ``LocalizedOnboardingFlow`` to automatically generate onboarding pages from the localized strings in your project. This makes it easy to manage your onboarding flows with just text and assets, without writing more code.
+You can use a ``LocalizedOnboarding`` to automatically generate pages from the localized strings in your project. This makes it easy to manage your onboarding with just text and assets, without writing any code.
diff --git a/Sources/OnboardingKit/OnboardingKit.docc/OnboardingKit.md b/Sources/OnboardingKit/OnboardingKit.docc/OnboardingKit.md
@@ -12,7 +12,7 @@ OnboardingKit is a Swift SDK that helps you create onboarding experiences in `Sw
 
 OnboardingKit has different onboarding types. A standard ``Onboarding`` is shown right away, and only once, while other types can require multiple presentation attempts, a certain number of "incorrect" actions, etc.
 
-OnboardingKit also has localized utilities, like the ``LocalizedOnboardingFlow``, and UI components like ``OnboardingPageView`` and ``OnboardingSlideshow``.
+OnboardingKit also has localized utilities, like the ``LocalizedOnboarding``, and UI components like ``OnboardingPageView`` and ``OnboardingSlideshow``.
 
 
 
@@ -59,10 +59,7 @@ OnboardingKit is available under the MIT license.
 - ``ConditionalOnboarding``
 - ``CorrectBehaviorOnboarding``
 - ``DelayedOnboarding``
-
-### Localization
-
-- ``LocalizedOnboardingFlow``
+- ``LocalizedOnboarding``
 
 ### Views
 
diff --git a/Sources/OnboardingKit/Onboardings/LocalizedOnboarding.swift b/Sources/OnboardingKit/Onboardings/LocalizedOnboarding.swift
@@ -1,5 +1,5 @@
 //
-//  LocalizedOnboardingFlow.swift
+//  LocalizedOnboarding.swift
 //  OnboardingKit
 //
 //  Created by Daniel Saidi on 2020-09-06.
@@ -8,11 +8,11 @@
 
 import Foundation
 
-/// This onboarding flow is generated by parsing information
-/// from localized strings and mapping it to pages.
+/// This onboarding is generated by parsing information from
+/// localized strings and mapping it to pages.
 ///
-/// With this approach, you can update an onboarding flow by
-/// just adjusting localized strings and images.
+/// With this approach, you can update an onboarding by just
+/// adjusting localized strings and images.
 ///
 /// The `pageResolver` starts at index 0 and will check if a
 /// string exists for certain keys. As long as a page exists,
@@ -28,9 +28,9 @@ import Foundation
 ///
 /// If you don't provide a `pageResolver`, the flow will use
 /// ``page(for:at:in:resourceName:resourceKeySeparator:)``.
-open class LocalizedOnboardingFlow {
+open class LocalizedOnboarding {
     
-    /// Create a localized onboarding flow.
+    /// Create a localized onboarding.
     ///
     /// - Parameters:
     ///   - id: The id to use.
@@ -44,9 +44,9 @@ open class LocalizedOnboardingFlow {
         id: String,
         bundle: Bundle = .main,
         pageIndicationKey: String = "title",
-        resourceName: ResourceNameResolver = LocalizedOnboardingFlow.resourceName,
+        resourceName: ResourceNameResolver = LocalizedOnboarding.resourceName,
         resourceKeySeparator: ResourceKeySeparator = ".",
-        pageResolver: @escaping PageResolver = LocalizedOnboardingFlow.page,
+        pageResolver: @escaping PageResolver = LocalizedOnboarding.page,
         translator: Translator? = nil
     ) {
         var index = 0
@@ -89,7 +89,6 @@ open class LocalizedOnboardingFlow {
         /// The name of the image asset.
         public let imageName: String?
     }
-
     
     public let pages: [Page]
     
@@ -102,7 +101,7 @@ open class LocalizedOnboardingFlow {
     public typealias Translator = (String) -> String
 }
 
-public extension LocalizedOnboardingFlow {
+public extension LocalizedOnboarding {
     
     /// This function generates resource names, by using the
     /// format `onboarding.<id>.<index>.<key>`.
@@ -124,7 +123,7 @@ public extension LocalizedOnboardingFlow {
         for id: Onboarding.ID,
         at pageIndex: PageIndex,
         in bundle: Bundle,
-        resourceName: ResourceNameResolver = LocalizedOnboardingFlow.resourceName,
+        resourceName: ResourceNameResolver = LocalizedOnboarding.resourceName,
         resourceKeySeparator: ResourceKeySeparator
     ) -> Page {
         let separator = resourceKeySeparator
diff --git a/Tests/OnboardingKitTests/Localization/LocalizedOnboardingFlowTests.swift b/Tests/OnboardingKitTests/Localization/LocalizedOnboardingFlowTests.swift
@@ -1,5 +1,5 @@
 //
-//  LocalizedOnboardingFlowTests.swift
+//  LocalizedOnboardingTests.swift
 //  OnboardingKitTests
 //
 //  Created by Daniel Saidi on 2018-06-18.
@@ -9,14 +9,14 @@
 import OnboardingKit
 import XCTest
 
-final class LocalizedOnboardingFlowTests: XCTestCase {
+final class LocalizedOnboardingTests: XCTestCase {
 
     func test_standardInitializer_createsStandardPagesForAllTranslations() {
         let translator: (String) -> String = {
             $0 == "onboarding.welcome.3.title" ? $0 : ""
         }
 
-        let result = LocalizedOnboardingFlow(
+        let result = LocalizedOnboarding(
             id: "welcome",
             translator: translator)
         let pages = result.pages
@@ -32,7 +32,7 @@ final class LocalizedOnboardingFlowTests: XCTestCase {
             $0 == "onboarding_custom_2_movie" ? $0 : ""
         }
 
-        let result = LocalizedOnboardingFlow(
+        let result = LocalizedOnboarding(
             id: "custom",
             pageIndicationKey: "movie",
             resourceKeySeparator: "_",
@@ -45,7 +45,7 @@ final class LocalizedOnboardingFlowTests: XCTestCase {
     }
 
     func test_standardResourceNameResolver_usesExpectedResourceNameFormat() {
-        let result = LocalizedOnboardingFlow.resourceName(
+        let result = LocalizedOnboarding.resourceName(
             for: "welcome",
             at: 0,
             key: "title",
@@ -54,7 +54,7 @@ final class LocalizedOnboardingFlowTests: XCTestCase {
     }
 
     func test_standardResourceNameResolver_omitsEmptyResourceKeys() {
-        let result = LocalizedOnboardingFlow.resourceName(
+        let result = LocalizedOnboarding.resourceName(
             for: "farewell",
             at: 3,
             key: "",
@@ -63,11 +63,11 @@ final class LocalizedOnboardingFlowTests: XCTestCase {
     }
 
     func test_standardPageResolved_usesProvidedResourceNameResolved() {
-        let result = LocalizedOnboardingFlow.page(
+        let result = LocalizedOnboarding.page(
             for: "hello",
             at: 5,
             in: .main,
-            resourceName: LocalizedOnboardingFlow.resourceName,
+            resourceName: LocalizedOnboarding.resourceName,
             resourceKeySeparator: "_")
         XCTAssertEqual(result.title, "onboarding_hello_5_title")
         XCTAssertEqual(result.text, "onboarding_hello_5_text")

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ extension Onboarding {`
`43`	`43`	`static let demoToolbarPopover = Onboarding(id: "demo.toolbar.popover")`
`44`	`44`	`}`
`45`	`45`
`46`		`-extension LocalizedOnboardingFlow {`
	`46`	`+extension LocalizedOnboarding {`
`47`	`47`
`48`		`- static let demo = LocalizedOnboardingFlow(id: "demo-flow")`
	`48`	`+ static let demo = .init(id: "demo-flow")`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
@@ -23,7 +23,7 @@ OnboardingKit is a Swift SDK that helps you create onboarding experiences in `Sw
`23`	`23`
`24`	`24`	OnboardingKit has different onboarding types. A standard ``Onboarding`` is shown right away, and only once, while other types can require multiple presentation attempts, a certain number of "incorrect" actions, etc.
`25`	`25`
`26`		-OnboardingKit also has localized utilities, like the ``LocalizedOnboardingFlow``, and UI components like ``OnboardingPageView`` and ``OnboardingSlideshow``.
	`26`	+OnboardingKit also has localized utilities, like the ``LocalizedOnboarding``, and UI components like ``OnboardingPageView`` and ``OnboardingSlideshow``.
`27`	`27`
`28`	`28`
`29`	`29`
Original file line number	Diff line number	Diff line change
`@@ -78,4 +78,4 @@ Both views can be styled by applying a style view modifier to the view hierarchy`
`78`	`78`
`79`	`79`	`## Localization`
`80`	`80`
`81`		-You can use a ``LocalizedOnboardingFlow`` to automatically generate onboarding pages from the localized strings in your project. This makes it easy to manage your onboarding flows with just text and assets, without writing more code.
	`81`	+You can use a ``LocalizedOnboarding`` to automatically generate pages from the localized strings in your project. This makes it easy to manage your onboarding with just text and assets, without writing any code.