feat: PointFree Dependency library support added

Author: BucekJiri

Example/App/AppDelegate.swift

@@ -7,8 +7,10 @@
 
 import AppFeature
 import Combine
+import Dependencies
 import SwiftUI
 import UserNotificationsClient
+import RemoteNotificationsClient
 
 @main
 final class AppDelegate: NSObject, UIApplicationDelegate {
@@ -43,24 +45,30 @@ extension SceneDelegate {
  // The user notification client needs to be initialized here at the app start
  // to assign the UNNotificationCenter delegate soon enough to react to events
  // coming from the notifications that opened the app
- let environment = AppEnvironment(remoteNotificationsClient: .live,
- userNotificationsClient: .live())
+ let remoteNotificationsClient = RemoteNotificationsClient.live
+ let userNotificationsClient = UserNotificationClient.live()
+
+ let vm = withDependencies {
+ $0.remoteNotificationsClient = remoteNotificationsClient
+ $0.userNotificationClient = userNotificationsClient
+ } operation: {
+ AppViewModel()
+ }
 
- let vm = AppViewModel(environment: environment)
  let appView = AppView(viewModel: vm)
 
  // Listen to the notification events and handle them
  Task {
- for await event in environment.userNotificationsClient.delegate() {
+ for await event in userNotificationsClient.delegate() {
  handleNotificationEvent(event, appViewModel: vm)
  }
  }
 
  // Register for remote notifications if the user granted the permissions
  Task {
- let allowed = await (environment.userNotificationsClient.getAuthorizationStatus() == .authorized)
+ let allowed = await (userNotificationsClient.getAuthorizationStatus() == .authorized)
  if allowed {
- environment.remoteNotificationsClient.registerForRemoteNotifications()
+ remoteNotificationsClient.registerForRemoteNotifications()
  }
  }
 

Example/App/Info.plist

@@ -27,8 +27,6 @@
 </array>
 </dict>
 </dict>
-<key>UIStatusBarStyle</key>
-<string>UIStatusBarStyleLightContent</string>
 <key>UISupportedExternalAccessoryProtocols</key>
 <array>
 <string>com.bixolon.protocol</string>

Example/Modules/Package.swift

@@ -12,19 +12,17 @@ let package = Package(
  .library(name: "AppFeature", targets: ["AppFeature"])
  ],
  dependencies: [
- .package(url: "https://github.com/pointfreeco/combine-schedulers", from: "0.5.3"),
+ .package(url: "https://github.com/pointfreeco/combine-schedulers", from: "0.9.0"),
  .package(url: "https://github.com/pointfreeco/swiftui-navigation", from: "0.1.0"),
- .package(url: "https://github.com/pointfreeco/xctest-dynamic-overlay", from: "0.2.1"),
  // NotificationsClients library
  .package(path: "../..")
  ],
  targets: [
  .target(
  name: "AppFeature",
  dependencies: [
- .product(name: "XCTestDynamicOverlay", package: "xctest-dynamic-overlay"),
  .product(name: "SwiftUINavigation", package: "swiftui-navigation"),
- .product(name: "NotificationsClients", package: "NotificationsClients")
+ .product(name: "NotificationsClients", package: "NotificationsClients"),
  ],
  resources: []
  ),

Example/Modules/Sources/AppFeature/AppViewModel.swift

@@ -1,16 +1,15 @@
 import Combine
 import SwiftUI
+import Dependencies
+import UserNotificationsClient
+import RemoteNotificationsClient
 
 public class AppViewModel: ObservableObject {
- var environment: AppEnvironment
+ public init() { }
  @Published var permissionsCanBeRequested: Bool = true
  @Published var notificationMessage: String?
-
- public init(
- environment: AppEnvironment
- ) {
- self.environment = environment
- }
+ @Dependency(\.remoteNotificationsClient) public var remoteNotificationsClient
+ @Dependency(\.userNotificationClient) public var userNotificationsClient
 
  public func receiveNotificationMessage(_ message: String) {
  self.notificationMessage = nil
@@ -20,7 +19,7 @@ public class AppViewModel: ObservableObject {
  }
 
  func checkPermissionStatus() async {
- let status = await environment.userNotificationsClient.getAuthorizationStatus()
+ let status = await userNotificationsClient.getAuthorizationStatus()
  switch status {
  case .notDetermined:
  permissionsCanBeRequested = true
@@ -33,15 +32,15 @@ public class AppViewModel: ObservableObject {
  Task { @MainActor in
  do {
  // Get the authorization status
- switch await environment.userNotificationsClient.getAuthorizationStatus() {
+ switch await userNotificationsClient.getAuthorizationStatus() {
  case .notDetermined:
  // Request the authorization
- let allowed = try await environment.userNotificationsClient.requestAuthorization([.alert, .badge, .sound])
+ let allowed = try await userNotificationsClient.requestAuthorization([.alert, .badge, .sound])
  if allowed {
  // Register the app to receive remote notifications
  // You probably want to call this also on app start
  // for case when the user allows the push permissions in the iOS settings
- environment.remoteNotificationsClient.registerForRemoteNotifications()
+ remoteNotificationsClient.registerForRemoteNotifications()
  }
  await checkPermissionStatus()
  default: return
@@ -61,7 +60,7 @@ public class AppViewModel: ObservableObject {
  content.userInfo["deeplink"] = "scheme://not_really_a_deeplink"
 
  let trigger = UNTimeIntervalNotificationTrigger(timeInterval: 1, repeats: false)
- try await environment.userNotificationsClient.addRequest(.init(identifier: UUID().uuidString,
+ try await userNotificationsClient.addRequest(.init(identifier: UUID().uuidString,
  content: content,
  trigger: trigger))
 

Example/NotificationClientsExample.xcodeproj/project.pbxproj

@@ -291,6 +291,7 @@
 INFOPLIST_FILE = App/Info.plist;
 INFOPLIST_KEY_UIApplicationSupportsIndirectInputEvents = YES;
 INFOPLIST_KEY_UILaunchStoryboardName = LaunchScreen;
+INFOPLIST_KEY_UIStatusBarStyle = UIStatusBarStyleLightContent;
 INFOPLIST_KEY_UISupportedInterfaceOrientations_iPad = "UIInterfaceOrientationPortrait UIInterfaceOrientationPortraitUpsideDown UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight";
 INFOPLIST_KEY_UISupportedInterfaceOrientations_iPhone = "UIInterfaceOrientationPortrait UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight";
 INFOPLIST_OUTPUT_FORMAT = XML;
@@ -448,6 +449,7 @@
 INFOPLIST_FILE = App/Info.plist;
 INFOPLIST_KEY_UIApplicationSupportsIndirectInputEvents = YES;
 INFOPLIST_KEY_UILaunchStoryboardName = LaunchScreen;
+INFOPLIST_KEY_UIStatusBarStyle = UIStatusBarStyleLightContent;
 INFOPLIST_KEY_UISupportedInterfaceOrientations_iPad = "UIInterfaceOrientationPortrait UIInterfaceOrientationPortraitUpsideDown UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight";
 INFOPLIST_KEY_UISupportedInterfaceOrientations_iPhone = "UIInterfaceOrientationPortrait UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight";
 INFOPLIST_OUTPUT_FORMAT = XML;
@@ -482,6 +484,7 @@
 INFOPLIST_FILE = App/Info.plist;
 INFOPLIST_KEY_UIApplicationSupportsIndirectInputEvents = YES;
 INFOPLIST_KEY_UILaunchStoryboardName = LaunchScreen;
+INFOPLIST_KEY_UIStatusBarStyle = UIStatusBarStyleLightContent;
 INFOPLIST_KEY_UISupportedInterfaceOrientations_iPad = "UIInterfaceOrientationPortrait UIInterfaceOrientationPortraitUpsideDown UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight";
 INFOPLIST_KEY_UISupportedInterfaceOrientations_iPhone = "UIInterfaceOrientationPortrait UIInterfaceOrientationLandscapeLeft UIInterfaceOrientationLandscapeRight";
 INFOPLIST_OUTPUT_FORMAT = XML;

Example/NotificationClientsExample.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -14,18 +14,24 @@ let package = Package(
  "UserNotificationsClient"]),
  ],
  dependencies: [
- .package(url: "https://github.com/pointfreeco/xctest-dynamic-overlay", from: "0.8.0"),
- // Dependencies declare other packages that this package depends on.
- // .package(url: /* package url */, from: "1.0.0"),
+ .package(
+ url: "https://github.com/pointfreeco/xctest-dynamic-overlay",
+ from: "0.8.0"),
+ .package(
+ url: "https://github.com/pointfreeco/swift-dependencies",
+ from: "0.1.0"
+ ),
  ],
  targets: [
  // Targets are the basic building blocks of a package. A target can define a module or a test suite.
  // Targets can depend on other targets in this package, and on products in packages this package depends on.
  .target(
  name: "RemoteNotificationsClient",
- dependencies: [.product(name: "XCTestDynamicOverlay", package: "xctest-dynamic-overlay")]),
+ dependencies: [.product(name: "XCTestDynamicOverlay", package: "xctest-dynamic-overlay"),
+ .product(name: "Dependencies", package: "swift-dependencies")]),
  .target(
  name: "UserNotificationsClient",
- dependencies: [.product(name: "XCTestDynamicOverlay", package: "xctest-dynamic-overlay")]),
+ dependencies: [.product(name: "XCTestDynamicOverlay", package: "xctest-dynamic-overlay"),
+ .product(name: "Dependencies", package: "swift-dependencies")]),
  ]
 )

Package.resolved

@@ -55,6 +55,12 @@ func setupAppEnvironment() {
 }
 ```
 
+Both the `RemoteNotificationsClient` and the `UserNotificationsClient` are already prepared for integration using the [PointFree Dependencies library](https://github.com/pointfreeco/swift-dependencies). You can also define them as: 
+```swift
+@Dependency(\.remoteNotificationsClient) var remoteNotificationsClient
+@Dependency(\.userNotificationClient) var userNotificationsClient
+```
+
 ### Requesting the push notifications authorization
 ```swift
 func requestPushAuthorization() async {

Package.swift

@@ -6,6 +6,7 @@
 //
 
 import Foundation
+import Dependencies
 
 /// Interface for a client that handles app registration for remote notifications
 public struct RemoteNotificationsClient {
@@ -19,3 +20,20 @@ public struct RemoteNotificationsClient {
  /// Unregister the app to receive remote notifications
  public var unregisterForRemoteNotifications: () async -> Void
 }
+
+
+extension RemoteNotificationsClient: DependencyKey {
+ public static let liveValue = RemoteNotificationsClient.live
+ #if DEBUG
+ public static let previewValue = RemoteNotificationsClient.noop
+ public static let testValue = RemoteNotificationsClient.failing
+ #endif
+}
+
+
+public extension DependencyValues {
+ var remoteNotificationsClient: RemoteNotificationsClient {
+ get { self[RemoteNotificationsClient.self] }
+ set { self[RemoteNotificationsClient.self] = newValue }
+ }
+}