Various additions and refactoring to support both Random Access Collections and Core Data sources (#9)

Author: reedes

README.md

@@ -217,6 +217,7 @@ If this validation is used, the user will not be able to save changes until it r
 ## See Also
 
 * [DetailerDemo](https://github.com/openalloc/DetailerDemo) - the demonstration app for this library
+* [TablerCoreDemo](https://github.com/openalloc/TablerCoreDemo) - the demonstration app for this library, for Core Data sources
 
 Swift open-source libraries (by the same author):
 

Sources/DetailerConfig.swift

@@ -21,12 +21,12 @@ import SwiftUI
 public enum DetailerConfigDefaults {
 
     #if os(macOS)
-    public static let detailerDefaultMinWidth: CGFloat = 300
+    public static let minWidth: CGFloat = 300
     #elseif os(iOS)
-    public static let detailerDefaultMinWidth: CGFloat = 0
+    public static let minWidth: CGFloat = 0
     #endif
 
-    public static let defaultValidateIndicator: (Bool) -> AnyView = { AnyView(
+    public static let validateIndicator: (Bool) -> AnyView = { AnyView(
         Image(systemName: "exclamationmark.triangle")
             .font(.title2)
             .backport.symbolRenderingMode()
@@ -61,15 +61,15 @@ public struct DetailerConfig<Element>
     public let titler: Titler
     public let validateIndicator: ValidateIndicator
 
-    public init(minWidth: CGFloat = DetailerConfigDefaults.detailerDefaultMinWidth,
+    public init(minWidth: CGFloat = DetailerConfigDefaults.minWidth,
                 canEdit: CanEdit? = nil,
                 canDelete: @escaping CanDelete = { _ in true },
                 onDelete: OnDelete? = nil,
                 onValidate: @escaping OnValidate = { _, _ in [] },
                 onSave: OnSave? = nil,
                 onCancel: @escaping OnCancel = { _, _ in },
                 titler: @escaping Titler,
-                validateIndicator: @escaping ValidateIndicator = DetailerConfigDefaults.defaultValidateIndicator)
+                validateIndicator: @escaping ValidateIndicator = DetailerConfigDefaults.validateIndicator)
     {
         self.minWidth = minWidth
         self.canEdit = canEdit

Sources/Internal/EditDetail.swift renamed to Sources/Internal/EditDetailBase.swift

@@ -1,5 +1,5 @@
 //
-//  EditDetail.swift
+//  SwiftUIView.swift
 //
 // Copyright 2022 FlowAllocator LLC
 //
@@ -18,37 +18,34 @@
 
 import SwiftUI
 
-struct EditDetail<Element, Detail>: View
-    where Element: Identifiable,
-    Detail: View
+struct EditDetailBase<Element, Detail>: View
+where Element: Identifiable,
+      Detail: View
 {
     @Environment(\.presentationMode) var presentationMode: Binding<PresentationMode>
-
-    typealias DetailContent = (DetailerContext<Element>, Binding<Element>) -> Detail
+    
+    typealias DetailContent = (DetailerContext<Element>) -> Detail
     typealias Validate<T> = (KeyPath<Element, T>) -> Void
-
+    
     // MARK: Parameters
-
-    // NOTE `element` not a binding, because we don't want to change data live
-    // NOTE `isAdd` will be set to `false` on dismissal of sheet
-
+    
     var config: DetailerConfig<Element>
-    @State var element: Element
+    var element: Element
     @Binding var isAdd: Bool
     var detailContent: DetailContent
-
+    
     // MARK: Locals
-
+    
     @State private var invalidFields: Set<AnyKeyPath> = Set()
     @State private var showValidationAlert = false
     @State private var alertMessage: String? = nil
-
+    
     private var context: DetailerContext<Element> {
         DetailerContext<Element>(config: config,
                                  onValidate: validateAction,
                                  isAdd: isAdd)
     }
-
+    
     private var isDeleteAvailable: Bool {
         config.onDelete != nil
     }
@@ -60,29 +57,29 @@ struct EditDetail<Element, Detail>: View
     private var isSaveAvailable: Bool {
         config.onSave != nil
     }
-
+    
     private var canSave: Bool {
         isSaveAvailable && invalidFields.isEmpty
     }
-
+    
     // MARK: Views
-
+    
     var body: some View {
         VStack(alignment: .leading) { // .leading needed to keep title from centering
-            #if os(macOS)
+#if os(macOS)
             Text(config.titler(element)).font(.largeTitle)
-            #endif
+#endif
             // this is where the user will typically declare a Form or VStack
-            detailContent(context, $element)
+            detailContent(context)
             // .animation(.default)
         }
         .alert(isPresented: $showValidationAlert) {
             Alert(title: Text("Validation Failure"),
                   message: Text(alertMessage ?? "Requires valid entry before save."))
         }
-        #if os(macOS)
+#if os(macOS)
         .padding()
-        #endif
+#endif
         .toolbar {
             ToolbarItem(placement: .destructiveAction) {
                 Button(action: deleteAction) {
@@ -92,7 +89,7 @@ struct EditDetail<Element, Detail>: View
                 .opacity(isDeleteAvailable ? 1 : 0)
                 .disabled(!canDelete)
             }
-
+            
             ToolbarItem(placement: .cancellationAction) {
                 Button(action: cancelAction) {
                     Text("Cancel")
@@ -107,18 +104,18 @@ struct EditDetail<Element, Detail>: View
                 .disabled(!canSave)
             }
         }
-        #if os(macOS)
+#if os(macOS)
         // NOTE on macOS, this seems to be needed to avoid excessive height
         .frame(minWidth: config.minWidth, maxWidth: .infinity, maxHeight: .infinity, alignment: .leading)
-        #endif
-
-        #if os(iOS) || targetEnvironment(macCatalyst)
+#endif
+        
+#if os(iOS) || targetEnvironment(macCatalyst)
         .navigationTitle(config.titler(element))
-        #endif
+#endif
     }
-
+    
     // MARK: Action Handlers
-
+    
     // NOTE: should be invoked via async to avoid updating the state during view render
     private func validateAction(_ anyKeyPath: AnyKeyPath, _ result: Bool) {
         if result {
@@ -133,40 +130,40 @@ struct EditDetail<Element, Detail>: View
             }
         }
     }
-
+    
     private func saveAction() {
         guard let _onSave = config.onSave else { return }
-
+        
         // display any validation changes
         let messages = config.onValidate(context, element)
         if messages.count > 0 {
             alertMessage = config.onValidate(context, element).joined(separator: "\n\n")
             showValidationAlert = true
             return
         }
-
+        
         let invalidCount = invalidFields.count
         if invalidCount > 0 {
             alertMessage = "\(invalidCount) field(s) require valid values before you can save."
             showValidationAlert = true
             return
         }
-
+        
         _onSave(context, element)
         dismissAction()
     }
-
+    
     private func deleteAction() {
         guard let _onDelete = config.onDelete else { return }
         _onDelete(element.id)
         dismissAction()
     }
-
+    
     private func cancelAction() {
         config.onCancel(context, element)
         dismissAction()
     }
-
+    
     private func dismissAction() {
         isAdd = false
         presentationMode.wrappedValue.dismiss()

Sources/Internal/EditDetailC.swift

@@ -0,0 +1,41 @@
+//
+//  EditDetailC.swift
+//
+// Copyright 2022 FlowAllocator LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import SwiftUI
+
+/// Core Data support
+struct EditDetailC<Element, Detail>: View
+where Element: Identifiable & ObservableObject,
+      Detail: View
+{
+    typealias ProjectedValue = ObservedObject<Element>.Wrapper
+    typealias DetailContent = (DetailerContext<Element>, ProjectedValue) -> Detail
+    
+    var config: DetailerConfig<Element>
+    @ObservedObject var element: Element
+    @Binding var isAdd: Bool
+    var detailContent: DetailContent
+    
+    var body: some View {
+        EditDetailBase(config: config,
+                       element: element,
+                       isAdd: $isAdd) { context in
+            detailContent(context, $element)
+        }
+    }
+}

Sources/Internal/EditDetailR.swift

@@ -0,0 +1,45 @@
+//
+//  EditDetail.swift
+//
+// Copyright 2022 FlowAllocator LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+import SwiftUI
+
+/// RandomAccess support
+struct EditDetailR<Element, Detail>: View
+where Element: Identifiable,
+      Detail: View
+{
+    typealias BoundValue = Binding<Element>
+    typealias DetailContent = (DetailerContext<Element>, BoundValue) -> Detail
+    
+    var config: DetailerConfig<Element>
+    @State var element: Element
+    @Binding var isAdd: Bool
+    var detailContent: DetailContent
+    
+    var body: some View {
+        EditDetailBase(config: config,
+                       element: element,
+                       isAdd: $isAdd) { context in
+            detailContent(context, $element)
+        }
+    }
+}
+
+
+
+