OnCommitModifier

OnCommitModifier.swift

/// データをコミットすべきタイミングで実行されるModifier
///
/// コミットされるタイミングは下記の3つ:
/// 1. `UIApplication.willTerminateNotification`通知を受け取ったとき
/// 2. `onDissapear`が呼び出されたとき
/// 3.  `scenePhase`が`.background`に切り替わったとき
///
/// このModifierは上記の3つをまとめて汎用的に取り扱えるシンタックスシュガーとなっている.
struct OnCommitModifier: ViewModifier {
    
    /// コミット時に実行するアクション. 
    var action: () -> Void
    
    @Environment(\.scenePhase) var scenePhase
    
    func body(content: Content) -> some View {
        content
            .onDisappear {
                action()
            }
            .onReceive(NotificationCenter.default.publisher(for: UIApplication.willTerminateNotification)) { _ in
                action()
            }
            .onChange(of: scenePhase) { newValue in
                if newValue == .background {
                    action()
                }
            }
    }
    
}

extension View {
    
    /// upstreamの`View`に`OnCommitModifier`を適応するメソッド
    ///
    /// - Parameter action: コミット時に実行したいアクション
    /// - Returns: 何らかの具体ビュー
    func onCommit(_ action: @escaping () -> Void) -> some View {
        self.modifier(OnCommitModifier(action: action))
    }
    
}