Update factory methods to options params (#977)

Author: martinmitrevski

.swiftformat

@@ -81,4 +81,4 @@
 --wrapcollections before-first
 
 # Exclude paths
---exclude Sources/StreamChatSwiftUI/Generated,Sources/StreamChatSwiftUI/StreamSwiftyGif,Sources/StreamChatSwiftUI/StreamNuke
+--exclude Sources/StreamChatSwiftUI/Generated,Sources/StreamChatSwiftUI/StreamSwiftyGif,Sources/StreamChatSwiftUI/StreamNuke,StreamChatSwiftUITests/Tests

.swiftlint.yml

@@ -43,6 +43,7 @@ only_rules:
   - trailing_comma
   - trailing_newline
   - trailing_semicolon
+  - trailing_whitespace
   - unneeded_break_in_switch
   - unneeded_override
   - unused_closure_parameter

DemoAppSwiftUI/AppDelegate.swift

@@ -127,7 +127,7 @@ class AppDelegate: NSObject, UIApplicationDelegate {
         }
 
         chatClient.currentUserController().addDevice(.apn(token: deviceToken)) { error in
-            if let error = error {
+            if let error {
                 log.error("adding a device failed with an error \(error)")
                 return
             }

DemoAppSwiftUI/AppleMessageComposerView.swift

@@ -100,21 +100,23 @@ struct AppleMessageComposerView<Factory: ViewFactory>: View, KeyboardReadable {
             .padding(.all, 8)
 
             factory.makeAttachmentPickerView(
-                attachmentPickerState: $viewModel.pickerState,
-                filePickerShown: $viewModel.filePickerShown,
-                cameraPickerShown: $viewModel.cameraPickerShown,
-                addedFileURLs: $viewModel.addedFileURLs,
-                onPickerStateChange: viewModel.change(pickerState:),
-                photoLibraryAssets: viewModel.imageAssets,
-                onAssetTap: viewModel.imageTapped(_:),
-                onCustomAttachmentTap: viewModel.customAttachmentTapped(_:),
-                isAssetSelected: viewModel.isImageSelected(with:),
-                addedCustomAttachments: viewModel.addedCustomAttachments,
-                cameraImageAdded: viewModel.cameraImageAdded(_:),
-                askForAssetsAccessPermissions: viewModel.askForPhotosPermission,
-                isDisplayed: viewModel.overlayShown,
-                height: viewModel.overlayShown ? popupSize : 0,
-                popupHeight: popupSize
+                options: AttachmentPickerViewOptions(
+                    attachmentPickerState: $viewModel.pickerState,
+                    filePickerShown: $viewModel.filePickerShown,
+                    cameraPickerShown: $viewModel.cameraPickerShown,
+                    addedFileURLs: $viewModel.addedFileURLs,
+                    onPickerStateChange: viewModel.change(pickerState:),
+                    photoLibraryAssets: viewModel.imageAssets,
+                    onAssetTap: viewModel.imageTapped(_:),
+                    onCustomAttachmentTap: viewModel.customAttachmentTapped(_:),
+                    isAssetSelected: viewModel.isImageSelected(with:),
+                    addedCustomAttachments: viewModel.addedCustomAttachments,
+                    cameraImageAdded: viewModel.cameraImageAdded(_:),
+                    askForAssetsAccessPermissions: viewModel.askForPhotosPermission,
+                    isDisplayed: viewModel.overlayShown,
+                    height: viewModel.overlayShown ? popupSize : 0,
+                    popupHeight: popupSize
+                )
             )
         }
         .background(
@@ -126,8 +128,8 @@ struct AppleMessageComposerView<Factory: ViewFactory>: View, KeyboardReadable {
         )
         .onPreferenceChange(HeightPreferenceKey.self) { value in
             Task { @MainActor in
-                if let value = value, value != composerHeight {
-                    self.composerHeight = value
+                if let value, value != composerHeight {
+                    composerHeight = value
                 }
             }
         }
@@ -144,27 +146,29 @@ struct AppleMessageComposerView<Factory: ViewFactory>: View, KeyboardReadable {
         }
         .onReceive(keyboardHeight) { height in
             if height > 0 && height != popupSize {
-                self.popupSize = height - bottomSafeArea
+                popupSize = height - bottomSafeArea
             }
         }
         .overlay(
             viewModel.showCommandsOverlay ?
                 factory.makeCommandsContainerView(
-                    suggestions: viewModel.suggestions,
-                    handleCommand: { commandInfo in
-                        viewModel.handleCommand(
-                            for: $viewModel.text,
-                            selectedRangeLocation: $viewModel.selectedRangeLocation,
-                            command: $viewModel.composerCommand,
-                            extraData: commandInfo
-                        )
-                    }
+                    options: CommandsContainerViewOptions(
+                        suggestions: viewModel.suggestions,
+                        handleCommand: { commandInfo in
+                            viewModel.handleCommand(
+                                for: $viewModel.text,
+                                selectedRangeLocation: $viewModel.selectedRangeLocation,
+                                command: $viewModel.composerCommand,
+                                extraData: commandInfo
+                            )
+                        }
+                    )
                 )
                 .offset(y: -composerHeight)
                 .animation(.none, value: viewModel.showCommandsOverlay) : nil,
             alignment: .bottom
         )
-        .modifier(factory.makeComposerViewModifier())
+        .modifier(factory.makeComposerViewModifier(options: ComposerViewModifierOptions()))
         .onChange(of: editedMessage) { _ in
             viewModel.text = editedMessage?.text ?? ""
             if editedMessage != nil {

DemoAppSwiftUI/ChannelHeader/NewChatViewModel.swift

@@ -71,12 +71,12 @@ import SwiftUI
 
     func onlineInfo(for user: ChatUser) -> String {
         if user.isOnline {
-            return "Online"
+            "Online"
         } else if let lastActiveAt = user.lastActiveAt,
                   let timeAgo = lastSeenDateFormatter(lastActiveAt) {
-            return timeAgo
+            timeAgo
         } else {
-            return "Offline"
+            "Offline"
         }
     }
 

DemoAppSwiftUI/CreateGroupView.swift

@@ -140,7 +140,7 @@ struct SearchBar: View {
 
                         if isEditing {
                             Button(action: {
-                                self.text = ""
+                                text = ""
 
                             }) {
                                 Image(systemName: "multiply.circle.fill")
@@ -152,13 +152,13 @@ struct SearchBar: View {
                 )
                 .padding(.horizontal, 10)
                 .onTapGesture {
-                    self.isEditing = true
+                    isEditing = true
                 }
 
             if isEditing {
                 Button(action: {
-                    self.isEditing = false
-                    self.text = ""
+                    isEditing = false
+                    text = ""
 
                     // Dismiss the keyboard
                     UIApplication.shared.sendAction(

DemoAppSwiftUI/CreateGroupViewModel.swift

@@ -50,12 +50,12 @@ import SwiftUI
 
     func onlineInfo(for user: ChatUser) -> String {
         if user.isOnline {
-            return "Online"
+            "Online"
         } else if let lastActiveAt = user.lastActiveAt,
                   let timeAgo = lastSeenDateFormatter(lastActiveAt) {
-            return timeAgo
+            timeAgo
         } else {
-            return "Offline"
+            "Offline"
         }
     }
 

DemoAppSwiftUI/LoginViewModel.swift

@@ -36,7 +36,7 @@ import SwiftUI
             ),
             token: token
         ) { [weak self] error in
-            if let error = error {
+            if let error {
                 log.error("connecting the user failed \(error)")
                 return
             }
@@ -55,7 +55,7 @@ import SwiftUI
         chatClient.connectGuestUser(
             userInfo: .init(id: credentials.id, name: credentials.name)
         ) { [weak self] error in
-            if let error = error {
+            if let error {
                 log.error("connecting the user failed \(error)")
                 return
             }

DemoAppSwiftUI/PinChannelHelpers.swift

@@ -75,7 +75,7 @@ struct DemoAppChatChannelListItem: View {
 
     private var subtitleView: some View {
         HStack(spacing: 4) {
-            if let image = image {
+            if let image {
                 Image(uiImage: image)
                     .customizable()
                     .frame(maxHeight: 12)

DemoAppSwiftUI/ViewFactoryExamples.swift

@@ -15,15 +15,17 @@ class DemoAppFactory: ViewFactory {
 
     public static let shared = DemoAppFactory()
 
-    func makeChannelListHeaderViewModifier(title: String) -> some ChannelListHeaderViewModifier {
-        CustomChannelModifier(title: title)
+    func makeChannelListHeaderViewModifier(options: ChannelListHeaderViewModifierOptions) -> some ChannelListHeaderViewModifier {
+        CustomChannelModifier(title: options.title)
     }
 
     func supportedMoreChannelActions(
-        for channel: ChatChannel,
-        onDismiss: @escaping @MainActor () -> Void,
-        onError: @escaping @MainActor (Error) -> Void
+        options: SupportedMoreChannelActionsOptions
     ) -> [ChannelAction] {
+        let channel = options.channel
+        let onDismiss = options.onDismiss
+        let onError = options.onError
+        
         var actions = ChannelAction.defaultActions(
             for: channel,
             chatClient: chatClient,
@@ -42,19 +44,20 @@ class DemoAppFactory: ViewFactory {
     }
 
     func makeChannelListItem(
-        channel: ChatChannel,
-        channelName: String,
-        avatar: UIImage,
-        onlineIndicatorShown: Bool,
-        disabled: Bool,
-        selectedChannel: Binding<ChannelSelectionInfo?>,
-        swipedChannelId: Binding<String?>,
-        channelDestination: @escaping @MainActor (ChannelSelectionInfo) -> ChatChannelView<DemoAppFactory>,
-        onItemTap: @escaping @MainActor (ChatChannel) -> Void,
-        trailingSwipeRightButtonTapped: @escaping @MainActor (ChatChannel) -> Void,
-        trailingSwipeLeftButtonTapped: @escaping @MainActor (ChatChannel) -> Void,
-        leadingSwipeButtonTapped: @escaping @MainActor (ChatChannel) -> Void
+        options: ChannelListItemOptions<ChannelDestination>
     ) -> some View {
+        let channel = options.channel
+        let channelName = options.channelName
+        let avatar = options.avatar
+        let onlineIndicatorShown = options.onlineIndicatorShown
+        let disabled = options.disabled
+        let selectedChannel = options.selectedChannel
+        let swipedChannelId = options.swipedChannelId
+        let channelDestination = options.channelDestination
+        let onItemTap = options.onItemTap
+        let trailingSwipeRightButtonTapped = options.trailingSwipeRightButtonTapped
+        let trailingSwipeLeftButtonTapped = options.trailingSwipeLeftButtonTapped
+        let leadingSwipeButtonTapped = options.leadingSwipeButtonTapped
         let listItem = DemoAppChatChannelNavigatableListItem(
             channel: channel,
             channelName: channelName,
@@ -231,35 +234,37 @@ class CustomFactory: ViewFactory {
 
     public static let shared = CustomFactory()
 
-    func makeGiphyBadgeViewType(for message: ChatMessage, availableWidth: CGFloat) -> some View {
+    func makeGiphyBadgeViewType(options: GiphyBadgeViewTypeOptions) -> some View {
         EmptyView()
     }
 
-    func makeLoadingView() -> some View {
+    func makeLoadingView(options: LoadingViewOptions) -> some View {
         VStack {
             Text("This is custom loading view")
             ProgressView()
         }
     }
 
-    func makeNoChannelsView() -> some View {
+    func makeNoChannelsView(options: NoChannelsViewOptions) -> some View {
         VStack {
             Spacer()
             Text("This is our own custom no channels view.")
             Spacer()
         }
     }
 
-    func makeChannelListHeaderViewModifier(title: String) -> some ChannelListHeaderViewModifier {
-        CustomChannelModifier(title: title)
+    func makeChannelListHeaderViewModifier(options: ChannelListHeaderViewModifierOptions) -> some ChannelListHeaderViewModifier {
+        CustomChannelModifier(title: options.title)
     }
 
     // Example for an injected action. Uncomment to see it in action.
     func supportedMoreChannelActions(
-        for channel: ChatChannel,
-        onDismiss: @escaping @MainActor () -> Void,
-        onError: @escaping @MainActor (Error) -> Void
+        options: SupportedMoreChannelActionsOptions
     ) -> [ChannelAction] {
+        let channel = options.channel
+        let onDismiss = options.onDismiss
+        let onError = options.onError
+        
         var defaultActions = ChannelAction.defaultActions(
             for: channel,
             chatClient: chatClient,
@@ -296,16 +301,14 @@ class CustomFactory: ViewFactory {
     }
 
     func makeMoreChannelActionsView(
-        for channel: ChatChannel,
-        onDismiss: @escaping @MainActor () -> Void,
-        onError: @escaping @MainActor (Error) -> Void
+        options: MoreChannelActionsViewOptions
     ) -> some View {
         VStack {
             Text("This is our custom view")
             Spacer()
             HStack {
                 Button {
-                    onDismiss()
+                    options.onDismiss()
                 } label: {
                     Text("Action")
                 }
@@ -315,22 +318,23 @@ class CustomFactory: ViewFactory {
     }
 
     func makeMessageTextView(
-        for message: ChatMessage,
-        isFirst: Bool,
-        availableWidth: CGFloat
+        options: MessageTextViewOptions
     ) -> some View {
-        CustomMessageTextView(
+        let message = options.message
+        let isFirst = options.isFirst
+        return CustomMessageTextView(
             message: message,
             isFirst: isFirst
         )
     }
 
     func makeCustomAttachmentViewType(
-        for message: ChatMessage,
-        isFirst: Bool,
-        availableWidth: CGFloat
+        options: CustomAttachmentViewTypeOptions
     ) -> some View {
-        CustomAttachmentView(
+        let message = options.message
+        let isFirst = options.isFirst
+        let availableWidth = options.availableWidth
+        return CustomAttachmentView(
             message: message,
             width: availableWidth,
             isFirst: isFirst