code cleanup, localizing texts

Author: martinmitrevski

Sources/StreamChatSwiftUI/ChatChannel/Composer/Suggestions/InstantCommands/GiphyCommandHandler.swift

@@ -32,7 +32,7 @@ public struct GiphyCommandHandler: CommandHandler {
         displayInfo = CommandDisplayInfo(
             displayName: "Giphy",
             icon: images.commandGiphy,
-            format: "\(id) [text]",
+            format: "\(id) [\(L10n.Composer.Commands.Format.text)]",
             isInstant: true
         )
     }

Sources/StreamChatSwiftUI/ChatChannel/Composer/Suggestions/InstantCommands/InstantCommandsHandler.swift

@@ -6,26 +6,29 @@ import Combine
 import StreamChat
 import SwiftUI
 
+/// Handler for istant commands.
 public class InstantCommandsHandler: CommandHandler {
 
     public let id: String
     public var displayInfo: CommandDisplayInfo?
 
-    private let typingSuggester = TypingSuggester(
-        options:
-        TypingSuggestionOptions(
-            symbol: "/",
-            shouldTriggerOnlyAtStart: true
-        )
-    )
+    private let typingSuggester: TypingSuggester
     private let commands: [CommandHandler]
 
     public init(
         commands: [CommandHandler],
+        symbol: String = "/",
         id: String = "instantCommands"
     ) {
         self.commands = commands
         self.id = id
+        typingSuggester = TypingSuggester(
+            options:
+            TypingSuggestionOptions(
+                symbol: symbol,
+                shouldTriggerOnlyAtStart: true
+            )
+        )
     }
 
     public func canHandleCommand(in text: String, caretLocation: Int) -> ComposerCommand? {

Sources/StreamChatSwiftUI/ChatChannel/Composer/Suggestions/InstantCommands/InstantCommandsView.swift

@@ -5,6 +5,7 @@
 import StreamChat
 import SwiftUI
 
+/// View for the instant commands suggestions.
 struct InstantCommandsView: View {
 
     @Injected(\.images) private var images
@@ -16,46 +17,26 @@ struct InstantCommandsView: View {
 
     var body: some View {
         VStack {
-            HStack {
-                Image(uiImage: images.smallBolt)
-                    .renderingMode(.template)
-                    .resizable()
-                    .frame(width: 24, height: 24)
-                    .foregroundColor(colors.tintColor)
-                Text(L10n.Composer.Suggestions.Commands.header)
-                    .font(fonts.body)
-                    .foregroundColor(Color(colors.textLowEmphasis))
-                Spacer()
-            }
-            .standardPadding()
+            InstantCommandsHeader()
+                .standardPadding()
 
             ForEach(0..<instantCommands.count) { i in
                 let command = instantCommands[i]
                 if let displayInfo = command.displayInfo {
-                    HStack {
-                        Image(uiImage: displayInfo.icon)
-                        Text(displayInfo.displayName)
-                            .font(fonts.title3)
-                            .bold()
-                            .foregroundColor(Color(colors.text))
-                        Text(displayInfo.format)
-                            .font(fonts.body)
-                            .foregroundColor(Color(colors.textLowEmphasis))
-                        Spacer()
-                    }
-                    .standardPadding()
-                    .highPriorityGesture(
-                        TapGesture()
-                            .onEnded { _ in
-                                let instantCommand = ComposerCommand(
-                                    id: command.id,
-                                    typingSuggestion: TypingSuggestion.empty,
-                                    displayInfo: command.displayInfo,
-                                    replacesMessageSent: command.replacesMessageSent
-                                )
-                                commandSelected(instantCommand)
-                            }
-                    )
+                    InstantCommandView(displayInfo: displayInfo)
+                        .standardPadding()
+                        .highPriorityGesture(
+                            TapGesture()
+                                .onEnded { _ in
+                                    let instantCommand = ComposerCommand(
+                                        id: command.id,
+                                        typingSuggestion: TypingSuggestion.empty,
+                                        displayInfo: command.displayInfo,
+                                        replacesMessageSent: command.replacesMessageSent
+                                    )
+                                    commandSelected(instantCommand)
+                                }
+                        )
                 }
             }
         }
@@ -65,3 +46,49 @@ struct InstantCommandsView: View {
         .animation(.spring())
     }
 }
+
+/// View for the instant commands header.
+struct InstantCommandsHeader: View {
+    
+    @Injected(\.images) private var images
+    @Injected(\.fonts) private var fonts
+    @Injected(\.colors) private var colors
+    
+    var body: some View {
+        HStack {
+            Image(uiImage: images.smallBolt)
+                .renderingMode(.template)
+                .resizable()
+                .frame(width: 24, height: 24)
+                .foregroundColor(colors.tintColor)
+            Text(L10n.Composer.Suggestions.Commands.header)
+                .font(fonts.body)
+                .foregroundColor(Color(colors.textLowEmphasis))
+            Spacer()
+        }
+    }
+}
+
+/// View for an instant command entry.
+struct InstantCommandView: View {
+    
+    @Injected(\.images) private var images
+    @Injected(\.fonts) private var fonts
+    @Injected(\.colors) private var colors
+    
+    var displayInfo: CommandDisplayInfo
+    
+    var body: some View {
+        HStack {
+            Image(uiImage: displayInfo.icon)
+            Text(displayInfo.displayName)
+                .font(fonts.title3)
+                .bold()
+                .foregroundColor(Color(colors.text))
+            Text(displayInfo.format)
+                .font(fonts.body)
+                .foregroundColor(Color(colors.textLowEmphasis))
+            Spacer()
+        }
+    }
+}

Sources/StreamChatSwiftUI/ChatChannel/Composer/Suggestions/InstantCommands/MuteCommandHandler.swift

@@ -23,9 +23,9 @@ public class MuteCommandHandler: TwoStepMentionCommand {
             id: id
         )
         let displayInfo = CommandDisplayInfo(
-            displayName: "Mute",
+            displayName: L10n.Composer.Commands.mute,
             icon: images.commandMute,
-            format: "\(id) [@username]",
+            format: "\(id) [\(L10n.Composer.Commands.Format.username)]",
             isInstant: true
         )
         self.displayInfo = displayInfo

Sources/StreamChatSwiftUI/ChatChannel/Composer/Suggestions/InstantCommands/TwoStepMentionCommand.swift

@@ -7,13 +7,14 @@ import StreamChat
 import SwiftUI
 
 /// Base class that supports two step commands, where the second one is mentioning users.
-public class TwoStepMentionCommand: CommandHandler {
+open class TwoStepMentionCommand: CommandHandler {
 
     @Injected(\.images) private var images
     @Injected(\.colors) private var colors
 
     private let channelController: ChatChannelController
     private let mentionsCommandHandler: MentionsCommandHandler
+    private let mentionSymbol: String
 
     internal var selectedUser: ChatUser?
 
@@ -25,13 +26,15 @@ public class TwoStepMentionCommand: CommandHandler {
         channelController: ChatChannelController,
         commandSymbol: String,
         id: String,
-        displayInfo: CommandDisplayInfo? = nil
+        displayInfo: CommandDisplayInfo? = nil,
+        mentionSymbol: String = "@"
     ) {
         self.channelController = channelController
         self.id = id
+        self.mentionSymbol = mentionSymbol
         mentionsCommandHandler = MentionsCommandHandler(
             channelController: channelController,
-            commandSymbol: "@",
+            commandSymbol: mentionSymbol,
             mentionAllAppUsers: false
         )
         self.displayInfo = displayInfo
@@ -87,9 +90,9 @@ public class TwoStepMentionCommand: CommandHandler {
 
     private func mentionText(for user: ChatUser) -> String {
         if let name = user.name, !name.isEmpty {
-            return "@\(name)"
+            return "\(mentionSymbol)\(name)"
         } else {
-            return "@\(user.id)"
+            return "\(mentionSymbol)\(user.id)"
         }
     }
 
@@ -114,7 +117,7 @@ public class TwoStepMentionCommand: CommandHandler {
         }
         let oldText = command.typingSuggestion.text
         let text = oldText.replacingOccurrences(
-            of: "@", with: ""
+            of: mentionSymbol, with: ""
         ).trimmingCharacters(in: .whitespaces)
         let oldRange = command.typingSuggestion.locationRange
         let offset = oldText.count - text.count

Sources/StreamChatSwiftUI/ChatChannel/Composer/Suggestions/InstantCommands/UnmuteCommandHandler.swift

@@ -23,9 +23,9 @@ public class UnmuteCommandHandler: TwoStepMentionCommand {
             id: id
         )
         let displayInfo = CommandDisplayInfo(
-            displayName: "Unmute",
+            displayName: L10n.Composer.Commands.unmute,
             icon: images.commandUnmute,
-            format: "\(id) [@username]",
+            format: "\(id) [\(L10n.Composer.Commands.Format.username)]",
             isInstant: true
         )
         self.displayInfo = displayInfo

Sources/StreamChatSwiftUI/Generated/L10n.swift

@@ -93,6 +93,20 @@ internal enum L10n {
       /// Also send as direct message
       internal static var directMessageReply: String { L10n.tr("Localizable", "composer.checkmark.direct-message-reply") }
     }
+    internal enum Commands {
+      /// Giphy
+      internal static var giphy: String { L10n.tr("Localizable", "composer.commands.giphy") }
+      /// Mute
+      internal static var mute: String { L10n.tr("Localizable", "composer.commands.mute") }
+      /// Unmute
+      internal static var unmute: String { L10n.tr("Localizable", "composer.commands.unmute") }
+      internal enum Format {
+        /// text
+        internal static var text: String { L10n.tr("Localizable", "composer.commands.format.text") }
+        /// @username
+        internal static var username: String { L10n.tr("Localizable", "composer.commands.format.username") }
+      }
+    }
     internal enum Files {
       /// Add more files
       internal static var addMore: String { L10n.tr("Localizable", "composer.files.add-more") }

Sources/StreamChatSwiftUI/Resources/en.lproj/Localizable.strings

@@ -76,6 +76,13 @@
 "composer.quoted.video" = "Video";
 "composer.quoted.giphy" = "Giphy";
 
+"composer.commands.giphy" = "Giphy";
+"composer.commands.mute" = "Mute";
+"composer.commands.unmute" = "Unmute";
+"composer.commands.format.text" = "text";
+"composer.commands.format.username" = "@username";
+
+
 "composer.suggestions.commands.header" = "Instant Commands";
 "message.sending.attachment-uploading-failed" = "UPLOADING FAILED";