Merge pull request #43 from jevonmao/develop

Implemented #40-prevent-dismiss, merge into 'main' for v1.3.0

Author: jevonmao

Package.swift

@@ -15,14 +15,15 @@ let package = Package(
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
-        .package(name: "SnapshotTesting", url: "https://github.com/pointfreeco/swift-snapshot-testing.git", "1.0.0"..<"2.0.0")
+        .package(name: "SnapshotTesting", url: "https://github.com/pointfreeco/swift-snapshot-testing.git", "1.0.0"..<"2.0.0"),
+        .package(name: "Introspect", url: "https://github.com/siteline/SwiftUI-Introspect", "0.0.0"..<"1.0.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: "PermissionsSwiftUI",
-            dependencies: [],
+            dependencies: ["Introspect"],
             exclude: ["../../Tests/PermissionsSwiftUITests/__Snapshots__"]
         ),
         .testTarget(

README.md

@@ -5,7 +5,7 @@
 </span>
 
 # PermissionsSwiftUI: A SwiftUI package to handle permissions
-<img src="https://img.shields.io/github/workflow/status/jevonmao/PermissionsSwiftUI/Swift?label=CI%20Build"> <img src="https://img.shields.io/github/contributors/jevonmao/PermissionsSwiftUI"> <img src="https://img.shields.io/badge/License-MIT-blue.svg"> <img src="https://img.shields.io/github/issues/jevonmao/PermissionsSwiftUI?color=orange"> <img src="https://img.shields.io/github/commit-activity/w/jevonmao/PermissionsSwiftUI?color=yellowgreen&logoColor=yellowgreen"> [![Codacy Badge](https://app.codacy.com/project/badge/Grade/6fe1a84c136b4a99823e7d71a8d08625)](https://www.codacy.com/gh/jevonmao/PermissionsSwiftUI/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=jevonmao/PermissionsSwiftUI&amp;utm_campaign=Badge_Grade)
+<img src="https://img.shields.io/github/workflow/status/jevonmao/PermissionsSwiftUI/Swift?label=CI%20Build"> <img src="https://img.shields.io/github/contributors/jevonmao/PermissionsSwiftUI"> <img src="https://img.shields.io/badge/License-MIT-blue.svg"> <img src="https://img.shields.io/github/issues/jevonmao/PermissionsSwiftUI?color=orange"> <img src="https://img.shields.io/github/commit-activity/w/jevonmao/PermissionsSwiftUI?color=yellowgreen&logoColor=yellowgreen"> 
 
 `PermissionsSwiftUI` displays and handles permissions in SwiftUI. It is largely inspired by [SPPermissions](https://github.com/varabeis/SPPermissions).
 The UI is highly customizable and resembles an **Apple style**. If you like the project, don't forget to `star ★` and follow me on GitHub. <br />
@@ -18,13 +18,20 @@ The UI is highly customizable and resembles an **Apple style**. If you like the
 ## Navigation
 -  [Installation](#installation)
 -  [Quickstart](#quickstart) 
+<details>
+  <summary>Usage</summary>
+  
 -  [Usage](#usage)
     -  [Customize Permission Texts](#customize-permission-texts)
     -  [Customize header texts](#customize-header-texts)
     -  [`onAppear` and `onDisappear` Override](#onappear-and-ondisappear-override)
     -  [Auto Check Authorization](#auto-check-authorization)
     -  [Auto Dismiss](#auto-dismiss)
     -  [Customize Colors](#customize-colors)
+    -  [Restrict Dismissal](#restrict-dismissal)
+    -  [Configuring Health Permissions](#configuring-health-permissions)
+</details>
+
 -  [Supported Permissions](#supported-permissions)
 -  [Additional Information](#additional-information)
     -  [Acknowledgement](#acknowledgement)
@@ -187,6 +194,52 @@ To unleash the full customization of all button colors under all states, you nee
                                                                  backgroundColor: Color)))
 ```
 For more information regarding the above method, reference the [official documentation](https://jevonmao.github.io/PermissionsSwiftUI/Structs/AllButtonColors.html).
+
+### Restrict Dismissal
+PermissionsSwiftUI will by default, prevent the user from dismissing the modal and alert. This restrict dismissal behavior and be overriden by the `var restrictModalDismissal: Bool` or `var restrictAlertDismissal: Bool` properties.
+To disable the default restrict dismiss behavior:
+```Swift
+.JMModal(showModal: $show, for permissions: [.camera], restrictDismissal: false)
+```
+You can also configure with the model:
+```Swift
+let model: PermissionStore = {
+        var model = PermissionStore()
+        model.permissions = [.camera]
+        model.restrictModalDismissal = false
+        model.restrictAlertDismissal = false
+        return model
+    }
+    ......
+
+    .JMModal(showModal: $showModal, forModel: model)
+```
+### Configuring Health Permissions
+Unlike all the other permissions, the configuration for health permission is a little different. Because Apple require developers to explictly set read and write types, PermissionsSwiftUI greatly simplifies the process.
+#### `HKAccess`
+The structure HKAccess is required when initalizing health permission’s enum associated values. It encapsulates the read and write type permissions for the health permission.
+
+To set read and write health types (`activeEnergyBurned` is used as example here):
+```Swift
+let healthTypes = Set([HKSampleType.quantityType(forIdentifier: .activeEnergyBurned)!])
+.JMModal(showModal: $show, for: [.health(categories: .init(readAndWrite: healthTypes))])
+
+//Same exact syntax for JMAlert styles
+.JMAlert(showModal: $show, for: [.health(categories: .init(readAndWrite: healthTypes))])
+
+```
+To set read or write individually:
+```Swift
+let readTypes = Set([HKSampleType.quantityType(forIdentifier: .activeEnergyBurned)!])
+let writeTypes = Set([HKSampleType.quantityType(forIdentifier: .appleStandTime)!])
+.JMModal(showModal: $showModal, for: [.health(categories: .init(read: readTypes, write: writeTypes))])
+```
+You may also set only read or write type:
+```Swift
+let readTypes = Set([HKSampleType.quantityType(forIdentifier: .activeEnergyBurned)!])
+.JMModal(showModal: $showModal, for: [.health(categories: .init(read: readTypes))])
+
+```
 ## Supported Permissions
 Here is a list of all permissions PermissionsSwiftUI already supports support(health not in image but is supported). Yup, even the newest `tracking` permission for iOS 14 so you can stay on top of your game. All permissions in PermissionsSwiftUI come with a default name, description, and a stunning Apple native SF Symbols icon.
 <br /> <br /> <br />

Sources/PermissionsSwiftUI/Components/Alert-style/AlertMainView.swift

@@ -14,7 +14,7 @@ struct AlertMainView: View {
     var shouldShowPermission:Bool{
         if PermissionStore.shared.autoCheckAlertAuth{
             if showAlert.wrappedValue &&
-                !PermissionStore.shared.permissionsToAsk.isEmpty {
+                !PermissionStore.shared.undeterminedPermissions.isEmpty {
                 return true
             }
             else {
@@ -35,23 +35,23 @@ struct AlertMainView: View {
     }
     var body: some View {
         ZStack{
+            let insertTransition = AnyTransition.opacity.combined(with: .scale(scale: 1.1)).animation(Animation.default.speed(1.6))
+            let removalTransiton = AnyTransition.opacity.combined(with: .scale(scale: 0.9)).animation(Animation.default.speed(1.8))
             bodyView
-
-            if shouldShowPermission{
+            if shouldShowPermission {
                 Group{
                     Blur(style: .systemUltraThinMaterialDark)
-                        .edgesIgnoringSafeArea(.all)
-                        .transition(AnyTransition.opacity.animation(Animation.default.speed(1.8)))
+                        .transition(AnyTransition.opacity.animation(Animation.default.speed(1.6)))
                     AlertView(showAlert:showAlert)
-                        .transition(AnyTransition.opacity.combined(with: .scale(scale: 0.92)).animation(Animation.default.speed(1.5)))
                         .onAppear(perform: PermissionStore.shared.onAppear)
                         .onDisappear(perform: PermissionStore.shared.onDisappear)
                 }
+                .transition(.asymmetric(insertion: insertTransition, removal: removalTransiton))
+                .edgesIgnoringSafeArea(.all)
+                .animation(.default)
 
             }
         }
-        .edgesIgnoringSafeArea(.all)
-        .animation(.default)
 
 
     }

Sources/PermissionsSwiftUI/Components/Alert-style/AlertView.swift

@@ -16,8 +16,9 @@ struct AlertView: View {
         screenSize.width < 400 ? 20-(1000-screenSize.width)/120 : 20
     }
     var body: some View {
+        let store = PermissionStore.shared
             VStack{
-                HeaderText(exitButtonAction: {showAlert = false}, isAlert: true)
+                HeaderView(exitButtonAction: {showAlert = store.isAlertDismissalRestricted}, isAlert: true)
                     .padding(.bottom, paddingSize/1.5)
                 PermissionSection(showModal: $showAlert, isAlert:true)
 

Sources/PermissionsSwiftUI/Components/Modal-style/MainView.swift

@@ -6,26 +6,36 @@
 //
 
 import SwiftUI
+import Introspect
 
 struct MainView: View {
+    @State var isModalNotShown = true
     var showModal: Binding<Bool>
     var bodyView: AnyView
-    var permissionsToAsk: [PermissionType]
-    var shouldShowPermission:Binding<Bool>{
+    var _permissionsToAsk: [PermissionType]?
+    var permissionsToAsk: [PermissionType] {
+        guard _permissionsToAsk == nil else {
+            return _permissionsToAsk!
+        }
+        return PermissionStore.shared.undeterminedPermissions
+    }
+    var shouldShowPermission: Binding<Bool>{
         Binding(get: {
             let store = PermissionStore.shared
-            if store.autoCheckModalAuth{
+            if store.autoCheckModalAuth && isModalNotShown {
                 return !permissionsToAsk.isEmpty
             }
             return true
         }, set: {_ in})
     }
+    @ObservedObject var store = PermissionStore.shared
+    
     init(for bodyView: AnyView,
          show showModal: Binding<Bool>,
-         permissionsToAsk: [PermissionType]=PermissionStore.shared.permissionsToAsk) {
+         permissionsToAsk: [PermissionType]?=nil) {
         self.bodyView = bodyView
         self.showModal = showModal
-        self.permissionsToAsk = permissionsToAsk
+        self._permissionsToAsk = permissionsToAsk
     }
 
     var body: some View {
@@ -34,9 +44,16 @@ struct MainView: View {
                 ModalView(showModal: showModal)
                     .onAppear(perform: PermissionStore.shared.onAppear)
                     .onDisappear(perform:PermissionStore.shared.onDisappear)
-                    .onDisappear{showModal.wrappedValue = false}
+                    .onAppear{isModalNotShown=false}
+                    .onDisappear{showModal.wrappedValue = false; isModalNotShown=true}
+                    .introspectViewController{
+                        if store.restrictModalDismissal {
+                            $0.isModalInPresentation = store.isModalDismissalRestricted
+                        }
+                    }
 
             })
+           
 
     }
     //if DEBUG to ensure these functions are never used in production. They are for unit testing only.

Sources/PermissionsSwiftUI/Components/Modal-style/ModalView.swift

@@ -10,10 +10,12 @@ import SwiftUI
 struct ModalView: View {
     @Binding var showModal: Bool
     var mainText:PermissionStore.MainTexts{PermissionStore.shared.mainTexts}
+
     var body: some View {
         ScrollView {
             VStack {
-                HeaderText(exitButtonAction: {showModal=false})
+                let store = PermissionStore.shared
+                HeaderView(exitButtonAction: {showModal = store.isModalDismissalRestricted})
 
                 PermissionSection(showModal:$showModal, isAlert:false)
                     .background(Color(.systemBackground))

Sources/PermissionsSwiftUI/Components/Modal-style/AllowButtonSection.swift renamed to Sources/PermissionsSwiftUI/Components/Shared/AllowButtonSection.swift

@@ -7,7 +7,7 @@
 
 import SwiftUI
 
-struct HeaderText: View {
+struct HeaderView: View {
     var exitButtonAction:() -> Void
     //HeaderText component have slightly different UI for alert and modal.
     var isAlert:Bool = false

Sources/PermissionsSwiftUI/Components/Shared/HeaderText.swift renamed to Sources/PermissionsSwiftUI/Components/Shared/HeaderView.swift

@@ -11,18 +11,18 @@ struct PermissionSection: View {
     @Environment(\.colorScheme) var colorScheme
     @Binding var showModal:Bool
     var isAlert:Bool
-    var permissions:[PermissionType]{
+    var permissions:[PermissionType] {
         let store = PermissionStore.shared
         if isAlert{
             if store.autoCheckAlertAuth{
-                return store.permissionsToAsk
+                return store.undeterminedPermissions
             }
             else {
                 return store.permissions
             }
         }
         if store.autoCheckModalAuth{
-            return store.permissionsToAsk
+            return store.undeterminedPermissions
         }
         else {
             return store.permissions
@@ -38,6 +38,9 @@ struct PermissionSection: View {
                 }
             }
         }
+//        .onAppear{
+//            PermissionStore
+//        }
 
     }
 }
@@ -109,6 +112,8 @@ struct PermissionSectionCell: View {
 
             Spacer()
             if isAlert {
+                //Call requestPermission (enum function) to make request to Apple API
+                //The handleButtonState function will be executed based on result of request
                 AllowButtonSection(action: {
                     permission.requestPermission(isPermissionGranted: {handleButtonState(for: $0)})
                 }, allowButtonStatus: $allowButtonStatus)
@@ -128,6 +133,7 @@ struct PermissionSectionCell: View {
 
     func handleButtonState(for authorized:Bool){
         var currentPermission = permission.currentPermission
+        currentPermission.interacted = true
         if authorized {
             allowButtonStatus = .allowed
             currentPermission.authorized = true

Sources/PermissionsSwiftUI/Components/Shared/PermissionSection.swift

@@ -16,7 +16,7 @@ protocol LocationManager {
 }
 
 
-extension CLLocationManager:LocationManager{
+extension CLLocationManager: LocationManager{
     func authorizationStatus() -> CLAuthorizationStatus {
         CLLocationManager.authorizationStatus()
     }
@@ -27,31 +27,23 @@ struct MockCLLocationManager:LocationManager{
     weak var delegate: CLLocationManagerDelegate?
 
     private static var status:CLAuthorizationStatus = .notDetermined
+    var whenInUseRequestOverride: CLAuthorizationStatus = .authorizedWhenInUse
+    var alwaysUseRequestOverride: CLAuthorizationStatus = .authorizedAlways
+
     func authorizationStatus() -> CLAuthorizationStatus {
         MockCLLocationManager.status
     }
 
     func requestWhenInUseAuthorization() {
-        MockCLLocationManager.status = .authorizedWhenInUse
+        MockCLLocationManager.status = whenInUseRequestOverride
     }
 
     func requestAlwaysAuthorization() {
-        MockCLLocationManager.status = .authorizedAlways
+        MockCLLocationManager.status = alwaysUseRequestOverride
 
     }
 
 
 }
-//class MockCLLocationManager:CLLocationManager{
-//    var authStatus:CLAuthorizationStatus = .notDetermined
-//    func authorizationStatus() -> CLAuthorizationStatus{
-//        return authStatus
-//    }
-//    override func requestAlwaysAuthorization() {
-//        self.authStatus = .authorizedAlways
-//    }
-//    override func requestWhenInUseAuthorization() {
-//        self.authStatus = .authorizedWhenInUse
-//    }
-//}
+
 

Sources/PermissionsSwiftUI/Model/Mocks/MockLocationManager.swift

@@ -41,15 +41,15 @@ class JMLocationPermissionManager: NSObject, CLLocationManagerDelegate, Permissi
         }
 
         if let completionHandler = completionHandler {
-            let status = CLLocationManager.authorizationStatus()
+            let status = locationManager.authorizationStatus()
             completionHandler(status == .authorizedAlways || status == .authorizedWhenInUse ? true : false)
 
         }
     }
     //Used to request in use permission (1 of 2 types of iOS location permission)
     func requestPermission(_ completionHandler: @escaping (Bool) -> Void) {
         self.completionHandler = completionHandler
-        let status = CLLocationManager.authorizationStatus()
+        let status = locationManager.authorizationStatus()
 
         switch status {
         case .notDetermined: