Merge pull request #1 from crelies/dev

Chris · web-flow · commit 3a1b0eb6c61c · 2019-11-14T00:07:51.000+01:00
Added move + delete and filter function
diff --git a/README.md b/README.md
@@ -1,21 +1,41 @@
 # AdvancedList
 
 [![Swift5](https://img.shields.io/badge/swift5-compatible-green.svg?longCache=true&style=flat-square)](https://developer.apple.com/swift)
-[![Platform](https://img.shields.io/badge/platform-iOS%20%7C%20macOS-lightgrey.svg?longCache=true&style=flat-square)](https://www.apple.com)
+[![Platforms](https://img.shields.io/badge/platform-iOS%20%7C%20macOS%20%7C%20tvOS-lightgrey.svg?longCache=true&style=flat-square)](https://www.apple.com)
 [![License](https://img.shields.io/badge/license-MIT-lightgrey.svg?longCache=true&style=flat-square)](https://en.wikipedia.org/wiki/MIT_License)
 
 This package provides a wrapper view around the **SwiftUI** `List view` which adds **pagination** (through my [ListPagination package](https://github.com/crelies/ListPagination)) and an **empty**, **error** and **loading state** including a corresponding view.
 
-## Installation
+## 📦 Installation
 
 Add this Swift package in Xcode using its Github repository url. (File > Swift Packages > Add Package Dependency...)
 
-## How to use
+## 🚀 How to use
 
 You control the view through an instance of `ListService`. The service manages the current state and the items of the list.
-Use it to append, update or remove items and to modify the state of the list. The view listens to the service and updates itself if needed.
+Use it to append, update or remove items and to modify the state of the list. The `AdvancedList` view listens to the service and updates itself if needed.
 
-### Pagination
+```swift
+import AdvancedList
+
+let listService = ListService()
+
+AdvancedList(listService: listService, emptyStateView: {
+    Text("No data")
+}, errorStateView: { error in
+    Text(error.localizedDescription)
+        .lineLimit(nil)
+}, loadingStateView: {
+    Text("Loading ...")
+}, pagination: .noPagination)
+
+listService.listState = .loading
+// TODO: fetch your items
+listService.appendItems(yourItems)
+listService.listState = .items
+```
+
+### 📄 Pagination
 
 The `Pagination` is implemented as a class (conforming to `ObservableObject`) so the `AdvancedList` can observe it.
 It has three different states: `error`, `idle` and `loading`. If the `state` of the `Pagination` changes the `AdvancedList` updates itself to show or hide the state related view (`ErrorView` for state `.error(Error)` or `LoadingView` for state `.loading`, `.idle` will display nothing). Update the `state` if you start loading (`.loading`), stop loading ( `.idle`) or if an error occurred (`.error(Error)`) so the `AdvancedList` can render the appropriate view.
@@ -34,12 +54,71 @@ The `thresholdItemPagination` expects an offset parameter (number of items befor
 
 **Skip pagination setup by using `.noPagination`.**
 
-## Example
+**Example:**
+
+```swift
+private(set) lazy var pagination: AdvancedListPagination<AnyView, AnyView> = {
+    .thresholdItemPagination(errorView: { error in
+        AnyView(
+            VStack {
+                Text(error.localizedDescription)
+                    .lineLimit(nil)
+                    .multilineTextAlignment(.center)
+                
+                Button(action: {
+                    // load current page again
+                }) {
+                    Text("Retry")
+                }.padding()
+            }
+        )
+    }, loadingView: {
+        AnyView(
+            VStack {
+                Divider()
+                Text("Loading...")
+            }
+        )
+    }, offset: 25, shouldLoadNextPage: {
+        // load next page
+    }, state: .idle)
+}()
+```
+
+### 📁 Move and 🗑️ delete items
+
+You can define which actions your list should support through the `supportedListActions` property of your `ListService` instance.
+Choose between `delete`, `move`, `moveAndDelete` and `none`. **The default is `none`.**
+
+```swift
+let listService = ListService()
+listService.supportedListActions = .moveAndDelete(onMove: { indexSet, index in
+    // move me
+}, onDelete: { indexSet in
+    // please delete me
+})
+```
+
+### 🎛️ Filtering
+
+The `AdvancedList` supports filtering (**disabled by default**). You only have to set the closure `excludeItem: (AnyListItem) -> Bool)` on your `ListService` instance.
+`AnyListItem` gives you access to the item (`Any`). **Keep in mind that you have to cast this item to your custom type!**
+
+```swift
+let listService = ListService()
+listService.excludeItem = { ($0.item as? YourItem).type == .xyz }
+```
+
+## 🎁 Example
 
 The following code shows how easy-to-use the view is:
 
 ```swift
+import AdvancedList
+
 let listService = ListService()
+listService.appendItems(yourItems)
+listService.listState = .items
 
 AdvancedList(listService: listService, emptyStateView: {
     Text("No data")
@@ -58,3 +137,5 @@ AdvancedList(listService: listService, emptyStateView: {
     Text("Loading ...")
 }, pagination: .noPagination)
 ```
+
+For more examples take a look at [AdvancedList-SwiftUI](https://github.com/crelies/AdvancedList-SwiftUI).
diff --git a/Sources/AdvancedList/public/Models/AdvancedListActions.swift b/Sources/AdvancedList/public/Models/AdvancedListActions.swift
@@ -0,0 +1,15 @@
+//
+//  AdvancedListActions.swift
+//  
+//
+//  Created by Christian Elies on 09.11.19.
+//
+
+import Foundation
+
+public enum AdvancedListActions {
+    case delete(onDelete: (IndexSet) -> Void)
+    case move(onMove: (IndexSet, Int) -> Void)
+    case moveAndDelete(onMove: (IndexSet, Int) -> Void, onDelete: (IndexSet) -> Void)
+    case none
+}
diff --git a/Sources/AdvancedList/public/Models/AnyListItem.swift b/Sources/AdvancedList/public/Models/AnyListItem.swift
@@ -10,10 +10,12 @@ import Foundation
 import SwiftUI
 
 public struct AnyListItem: Identifiable, View {
+    public let item: Any
     public let id: AnyHashable
     public let body: AnyView
     
     public init<Item: Identifiable>(item: Item) where Item: View {
+        self.item = item
         id = item.id
         body = AnyView(item)
     }
diff --git a/Sources/AdvancedList/public/Services/ListService.swift b/Sources/AdvancedList/public/Services/ListService.swift
@@ -24,7 +24,10 @@ public final class ListService: NSObject, ObservableObject {
             objectWillChange.send()
         }
     }
-    
+
+    public var supportedListActions: AdvancedListActions = .none
+    public var excludeItem: (AnyListItem) -> Bool = { _ in false }
+
     public func appendItems<Item: Identifiable>(_ items: [Item]) where Item: View {
         let anyListItems = items.map { AnyListItem(item: $0) }
         self.items.append(contentsOf: anyListItems)
diff --git a/Sources/AdvancedList/public/Views/AdvancedList.swift b/Sources/AdvancedList/public/Views/AdvancedList.swift
@@ -9,7 +9,6 @@
 import ListPagination
 import SwiftUI
 
-#if !targetEnvironment(macCatalyst)
 public struct AdvancedList<EmptyStateView: View, ErrorStateView: View, LoadingStateView: View, PaginationErrorView: View, PaginationLoadingView: View> : View {
     @ObservedObject private var listService: ListService
     @ObservedObject private var pagination: AdvancedListPagination<PaginationErrorView, PaginationLoadingView>
@@ -26,27 +25,6 @@ public struct AdvancedList<EmptyStateView: View, ErrorStateView: View, LoadingSt
         self.pagination = pagination
     }
 }
-#else
-public struct AdvancedList<EmptyStateView: View, ErrorStateView: View, LoadingStateView: View> : View {
-    private let emptyStateView: () -> EmptyStateView
-    private let errorStateView: (Error) -> ErrorStateView
-    private let loadingStateView: () -> LoadingStateView
-    @State private var isLastItem: Bool = false
-    
-    @EnvironmentObject var listService: ListService
-    /*
-        We have to erase the types of the pagination error and loading view
-        because currently there is no way to specify the types
-     */
-    @EnvironmentObject var pagination: AdvancedListPagination<AnyView, AnyView>
-    
-    public init(@ViewBuilder emptyStateView: @escaping () -> EmptyStateView, @ViewBuilder errorStateView: @escaping (Error) -> ErrorStateView, @ViewBuilder loadingStateView: @escaping () -> LoadingStateView) {
-        self.emptyStateView = emptyStateView
-        self.errorStateView = errorStateView
-        self.loadingStateView = loadingStateView
-    }
-}
-#endif
 
 extension AdvancedList {
     public var body: AnyView {
@@ -59,16 +37,7 @@ extension AdvancedList {
                 if !listService.items.isEmpty {
                     return AnyView(
                         VStack {
-                            List(listService.items) { item in
-                                item
-                                .onAppear {
-                                    self.listItemAppears(item)
-                                    
-                                    if self.listService.items.isLastItem(item) {
-                                        self.isLastItem = true
-                                    }
-                                }
-                            }
+                            getListView()
                             
                             if isLastItem {
                                 getPaginationStateView()
@@ -104,17 +73,71 @@ extension AdvancedList {
             case .noPagination: ()
         }
     }
+
+    private func getListView() -> some View {
+        switch listService.supportedListActions {
+        case .delete(let onDelete):
+            return AnyView(List {
+                ForEach(listService.items) { item in
+                    if !self.listService.excludeItem(item) {
+                        self.getItemView(item)
+                    }
+                }.onDelete { indexSet in
+                    onDelete(indexSet)
+                }
+            })
+        case .move(let onMove):
+            return AnyView(List {
+                ForEach(listService.items) { item in
+                    if !self.listService.excludeItem(item) {
+                        self.getItemView(item)
+                    }
+                }.onMove { (indexSet, index) in
+                    onMove(indexSet, index)
+                }
+            })
+        case .moveAndDelete(let onMove, let onDelete):
+            return AnyView(List {
+                ForEach(listService.items) { item in
+                    if !self.listService.excludeItem(item) {
+                        self.getItemView(item)
+                    }
+                }.onMove { (indexSet, index) in
+                    onMove(indexSet, index)
+                }.onDelete { indexSet in
+                    onDelete(indexSet)
+                }
+            })
+        case .none:
+            return AnyView(List(listService.items) { item in
+                if !self.listService.excludeItem(item) {
+                    self.getItemView(item)
+                }
+            })
+        }
+    }
+
+    private func getItemView(_ item: AnyListItem) -> some View {
+        item
+        .onAppear {
+            self.listItemAppears(item)
+
+            if self.listService.items.isLastItem(item) {
+                self.isLastItem = true
+            }
+        }
+    }
     
-    private func getPaginationStateView() -> AnyView {
+    private func getPaginationStateView() -> some View {
         var paginationStateView = AnyView(EmptyView())
         
         switch pagination.state {
-            case .error(let error):
-                paginationStateView = AnyView(pagination.errorView(error))
-            case .idle:
-                paginationStateView = AnyView(EmptyView())
-            case .loading:
-                paginationStateView = AnyView(pagination.loadingView())
+        case .error(let error):
+            paginationStateView = AnyView(pagination.errorView(error))
+        case .idle:
+            paginationStateView = AnyView(EmptyView())
+        case .loading:
+            paginationStateView = AnyView(pagination.loadingView())
         }
         
         return paginationStateView
@@ -124,39 +147,15 @@ extension AdvancedList {
 #if DEBUG
 struct AdvancedList_Previews : PreviewProvider {
     private static let listService = ListService()
-    
-    #if targetEnvironment(macCatalyst)
-    static var previews: some View {
-        NavigationView {
-            AdvancedList(emptyStateView: {
-                Text("No data")
-            }, errorStateView: { error in
-                VStack {
-                    Text(error.localizedDescription)
-                    .lineLimit(nil)
-                    
-                    Button(action: {
-                        // do something
-                    }) {
-                        Text("Retry")
-                    }
-                }
-            }, loadingStateView: {
-                Text("Loading ...")
-            })
-            .environmentObject(listService)
-            .environmentObject(AdvancedListPagination.noPagination)
-        }
-    }
-    #else
+
     static var previews: some View {
         NavigationView {
             AdvancedList(listService: listService, emptyStateView: {
                 Text("No data")
             }, errorStateView: { error in
                 VStack {
                     Text(error.localizedDescription)
-                    .lineLimit(nil)
+                        .lineLimit(nil)
                     
                     Button(action: {
                         // do something
@@ -167,9 +166,7 @@ struct AdvancedList_Previews : PreviewProvider {
             }, loadingStateView: {
                 Text("Loading ...")
             }, pagination: .noPagination)
-//            .navigationBarTitle(Text("List of Items"))
         }
     }
-    #endif
 }
 #endif

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,10 @@ public final class ListService: NSObject, ObservableObject {`
`24`	`24`	`objectWillChange.send()`
`25`	`25`	`}`
`26`	`26`	`}`
`27`		`-`
	`27`	`+`
	`28`	`+ public var supportedListActions: AdvancedListActions = .none`
	`29`	`+ public var excludeItem: (AnyListItem) -> Bool = { _ in false }`
	`30`	`+`
`28`	`31`	`public func appendItems<Item: Identifiable>(_ items: [Item]) where Item: View {`
`29`	`32`	`let anyListItems = items.map { AnyListItem(item: $0) }`
`30`	`33`	`self.items.append(contentsOf: anyListItems)`