Avoid rendering trailing spaces for 6-digit codes (#85)

bitwarden · May 7, 2024 · f1dc721 · f1dc721
1 parent edff0c7
commit f1dc721
Show file tree

Hide file tree

Showing 16 changed files with 191 additions and 1 deletion.
diff --git a/AuthenticatorShared/Core/Vault/Services/TOTP/TOTPCodeModel.swift b/AuthenticatorShared/Core/Vault/Services/TOTP/TOTPCodeModel.swift
@@ -17,7 +17,9 @@ public struct TOTPCodeModel: Equatable, Sendable {
         code.enumerated().map { index, character in
             guard (index + 1) % 3 == 0 else { return "\(character)" }
             return "\(character) "
-        }.joined()
+        }
+        .joined()
+        .trimmingCharacters(in: .whitespacesAndNewlines)
     }
 
     /// The period of the code.

diff --git a/AuthenticatorShared/Core/Vault/Services/TOTP/TOTPCodeModelTests.swift b/AuthenticatorShared/Core/Vault/Services/TOTP/TOTPCodeModelTests.swift
@@ -0,0 +1,24 @@
+import Foundation
+import XCTest
+
+@testable import AuthenticatorShared
+
+final class TOTPCodeModelTests: AuthenticatorTestCase {
+    // MARK: Tests
+
+    /// `displayCode` groups digits correctly
+    func test_displayCode_spaces() {
+        XCTAssertEqual(model(for: "12345").displayCode, "123 45")
+        XCTAssertEqual(model(for: "123456").displayCode, "123 456")
+        XCTAssertEqual(model(for: "1234567").displayCode, "123 456 7")
+        XCTAssertEqual(model(for: "12345678").displayCode, "123 456 78")
+        XCTAssertEqual(model(for: "123456789").displayCode, "123 456 789")
+        XCTAssertEqual(model(for: "1234567890").displayCode, "123 456 789 0")
+    }
+
+    // MARK: Private Methods
+
+    func model(for code: String) -> TOTPCodeModel {
+        TOTPCodeModel(code: code, codeGenerationDate: Date(), period: 30)
+    }
+}
diff --git a/AuthenticatorShared/UI/Vault/ItemList/ItemList/ItemListSection+Fixtures.swift b/AuthenticatorShared/UI/Vault/ItemList/ItemList/ItemListSection+Fixtures.swift
@@ -0,0 +1,106 @@
+import Foundation
+
+#if DEBUG
+
+extension ItemListSection {
+    static func digitsFixture(accountNames: Bool = false) -> ItemListSection { // swiftlint:disable:this function_body_length line_length
+        ItemListSection(
+            id: "Digits",
+            items: [
+                ItemListItem(
+                    id: "5",
+                    name: "Five",
+                    accountName: accountNames ? "[email protected]" : nil,
+                    itemType: .totp(
+                        model: ItemListTotpItem(
+                            itemView: .fixture(),
+                            totpCode: TOTPCodeModel(
+                                code: "12345",
+                                codeGenerationDate: Date(),
+                                period: 30
+                            )
+                        )
+                    )
+                ),
+                ItemListItem(
+                    id: "6",
+                    name: "Six",
+                    accountName: accountNames ? "[email protected]" : nil,
+                    itemType: .totp(
+                        model: ItemListTotpItem(
+                            itemView: .fixture(),
+                            totpCode: TOTPCodeModel(
+                                code: "123456",
+                                codeGenerationDate: Date(),
+                                period: 30
+                            )
+                        )
+                    )
+                ),
+                ItemListItem(
+                    id: "7",
+                    name: "Seven",
+                    accountName: accountNames ? "[email protected]" : nil,
+                    itemType: .totp(
+                        model: ItemListTotpItem(
+                            itemView: .fixture(),
+                            totpCode: TOTPCodeModel(
+                                code: "1234567",
+                                codeGenerationDate: Date(),
+                                period: 30
+                            )
+                        )
+                    )
+                ),
+                ItemListItem(
+                    id: "8",
+                    name: "Eight",
+                    accountName: accountNames ? "[email protected]" : nil,
+                    itemType: .totp(
+                        model: ItemListTotpItem(
+                            itemView: .fixture(),
+                            totpCode: TOTPCodeModel(
+                                code: "12345678",
+                                codeGenerationDate: Date(),
+                                period: 30
+                            )
+                        )
+                    )
+                ),
+                ItemListItem(
+                    id: "9",
+                    name: "Nine",
+                    accountName: accountNames ? "[email protected]" : nil,
+                    itemType: .totp(
+                        model: ItemListTotpItem(
+                            itemView: .fixture(),
+                            totpCode: TOTPCodeModel(
+                                code: "123456789",
+                                codeGenerationDate: Date(),
+                                period: 30
+                            )
+                        )
+                    )
+                ),
+                ItemListItem(
+                    id: "10",
+                    name: "Ten",
+                    accountName: accountNames ? "[email protected]" : nil,
+                    itemType: .totp(
+                        model: ItemListTotpItem(
+                            itemView: .fixture(),
+                            totpCode: TOTPCodeModel(
+                                code: "1234567890",
+                                codeGenerationDate: Date(),
+                                period: 30
+                            )
+                        )
+                    )
+                ),
+            ],
+            name: "Digits"
+        )
+    }
+}
+
+#endif
diff --git a/AuthenticatorShared/UI/Vault/ItemList/ItemList/ItemListView.swift b/AuthenticatorShared/UI/Vault/ItemList/ItemList/ItemListView.swift
@@ -548,6 +548,19 @@ struct ItemListView_Previews: PreviewProvider {
                 timeProvider: PreviewTimeProvider()
             )
         }.previewDisplayName("3 Search Results")
+
+        NavigationView {
+            ItemListView(
+                store: Store(
+                    processor: StateProcessor(
+                        state: ItemListState(
+                            loadingState: .data([ItemListSection.digitsFixture(accountNames: true)])
+                        )
+                    )
+                ),
+                timeProvider: PreviewTimeProvider()
+            )
+        }.previewDisplayName("Digits")
     }
 }
 #endif
diff --git a/...mListViewTests/test_snapshot_ItemListView_previews.1-Search-Result-portrait.png b/...mListViewTests/test_snapshot_ItemListView_previews.1-Search-Result-portrait.png
diff --git a/...tViewTests/test_snapshot_ItemListView_previews.1-Search-Result-portraitDark.png b/...tViewTests/test_snapshot_ItemListView_previews.1-Search-Result-portraitDark.png
diff --git a/...ListViewTests/test_snapshot_ItemListView_previews.3-Search-Results-portrait.png b/...ListViewTests/test_snapshot_ItemListView_previews.3-Search-Results-portrait.png
diff --git a/...ViewTests/test_snapshot_ItemListView_previews.3-Search-Results-portraitDark.png b/...ViewTests/test_snapshot_ItemListView_previews.3-Search-Results-portraitDark.png
diff --git a/...ots__/ItemListViewTests/test_snapshot_ItemListView_previews.Digits-portrait.png b/...ots__/ItemListViewTests/test_snapshot_ItemListView_previews.Digits-portrait.png
diff --git a/...__/ItemListViewTests/test_snapshot_ItemListView_previews.Digits-portraitAX5.png b/...__/ItemListViewTests/test_snapshot_ItemListView_previews.Digits-portraitAX5.png
diff --git a/..._/ItemListViewTests/test_snapshot_ItemListView_previews.Digits-portraitDark.png b/..._/ItemListViewTests/test_snapshot_ItemListView_previews.Digits-portraitDark.png
diff --git a/...tViewTests/test_snapshot_ItemListView_previews.Items-with-Favorite-portrait.png b/...tViewTests/test_snapshot_ItemListView_previews.Items-with-Favorite-portrait.png
diff --git a/...wTests/test_snapshot_ItemListView_previews.Items-with-Favorite-portraitDark.png b/...wTests/test_snapshot_ItemListView_previews.Items-with-Favorite-portraitDark.png
diff --git a/...ewTests/test_snapshot_ItemListView_previews.Items-without-Favorite-portrait.png b/...ewTests/test_snapshot_ItemListView_previews.Items-without-Favorite-portrait.png
diff --git a/...sts/test_snapshot_ItemListView_previews.Items-without-Favorite-portraitDark.png b/...sts/test_snapshot_ItemListView_previews.Items-without-Favorite-portraitDark.png
diff --git a/AuthenticatorShared/UI/Vault/Views/ItemListItemRow/ItemListItemRowView.swift b/AuthenticatorShared/UI/Vault/Views/ItemListItemRow/ItemListItemRowView.swift
@@ -197,4 +197,49 @@ struct ItemListItemRowView: View {
         timeProvider: PreviewTimeProvider()
     )
 }
+
+struct ItemListItemRow_Previews: PreviewProvider {
+    static var previews: some View {
+        NavigationView {
+            VStack(spacing: 4) {
+                ForEach(ItemListSection.digitsFixture(accountNames: false).items) { item in
+                    ItemListItemRowView(
+                        store: Store(
+                            processor: StateProcessor(
+                                state: ItemListItemRowState(
+                                    item: item,
+                                    hasDivider: true,
+                                    showWebIcons: true
+                                )
+                            )
+                        ),
+                        timeProvider: PreviewTimeProvider()
+                    )
+                }
+            }
+        }.previewDisplayName(
+            "Digits without account"
+        )
+        NavigationView {
+            VStack(spacing: 4) {
+                ForEach(ItemListSection.digitsFixture(accountNames: true).items) { item in
+                    ItemListItemRowView(
+                        store: Store(
+                            processor: StateProcessor(
+                                state: ItemListItemRowState(
+                                    item: item,
+                                    hasDivider: true,
+                                    showWebIcons: true
+                                )
+                            )
+                        ),
+                        timeProvider: PreviewTimeProvider()
+                    )
+                }
+            }
+        }.previewDisplayName(
+            "Digits with account"
+        )
+    }
+}
 #endif