Move macOS-clean utility tests into the cross-platform Swift package

jkmassel · jkmassel · commit b897a2cdf27e · 2026-07-23T15:16:52.000-06:00
Relocate the Queue, LoggingURLRedactor, DashboardDynamicCardAnalyticsEvent,
SiteCreationHeaderData, QRLoginURLParser, and ReaderCSS tests from KeystoneTests
into WordPressSharedTests, moving each subject into WordPressShared so it builds
on macOS and runs under `swift test` at the repo root. Also move URLHelpersTests
and delete two stale KeystoneTests copies (DictionaryHelpersTests,
URLIncrementalFilenameTests) whose WordPressShared copies already ran.
diff --git a/Modules/Sources/WordPressShared/Analytics/DashboardDynamicCardAnalyticsEvent.swift b/Modules/Sources/WordPressShared/Analytics/DashboardDynamicCardAnalyticsEvent.swift
@@ -1,18 +1,18 @@
-enum DashboardDynamicCardAnalyticsEvent: Hashable {
+public enum DashboardDynamicCardAnalyticsEvent: Hashable {
 
     case cardShown(id: String)
     case cardTapped(id: String, url: String?)
     case cardCtaTapped(id: String, url: String?)
 
-    var name: String {
+    public var name: String {
         switch self {
         case .cardShown: return "dynamic_dashboard_card_shown"
         case .cardTapped: return "dynamic_dashboard_card_tapped"
         case .cardCtaTapped: return "dynamic_dashboard_card_cta_tapped"
         }
     }
 
-    var properties: [String: String] {
+    public var properties: [String: String] {
         switch self {
         case .cardShown(let id):
             return [Keys.id: id]
diff --git a/Modules/Sources/WordPressShared/Utility/LoggingURLRedactor.swift b/Modules/Sources/WordPressShared/Utility/LoggingURLRedactor.swift
@@ -1,8 +1,8 @@
 import Foundation
 
-struct LoggingURLRedactor {
+public struct LoggingURLRedactor {
 
-    static func redactedURL(_ url: URL) -> URL {
+    public static func redactedURL(_ url: URL) -> URL {
 
         if isAuthURL(url) {
             return redactParameter(named: "token", in: url)
diff --git a/Modules/Sources/WordPressShared/Utility/QRLoginURLParser.swift b/Modules/Sources/WordPressShared/Utility/QRLoginURLParser.swift
@@ -1,24 +1,29 @@
 import Foundation
 
-struct QRLoginToken: Equatable {
-    let token: String
-    let data: String
+public struct QRLoginToken: Equatable {
+    public let token: String
+    public let data: String
 
-    static func == (lhs: Self, rhs: Self) -> Bool {
-        return lhs.token == rhs.token && lhs.data == rhs.data
+    public init(token: String, data: String) {
+        self.token = token
+        self.data = data
+    }
+
+    public static func == (lhs: Self, rhs: Self) -> Bool {
+        lhs.token == rhs.token && lhs.data == rhs.data
     }
 }
 
-struct QRLoginURLParser {
+public struct QRLoginURLParser {
     private let urlString: String
 
-    init(urlString: String) {
+    public init(urlString: String) {
         self.urlString = urlString
     }
 
     /// Attempts to retrieve the QR Login token information from the incoming urlString
     /// - Returns: QRLoginToken or nil if the parsing fails for any reason
-    func parse() -> QRLoginToken? {
+    public func parse() -> QRLoginToken? {
         // Early validation, making sure this is a valid URL from a valid host
         guard let url = URL(string: urlString), Self.isValidHost(url: url) else {
             return nil
@@ -39,7 +44,7 @@ struct QRLoginURLParser {
     }
 
     /// Validates that the input URL is coming from a valid host
-    static func isValidHost(url: URL) -> Bool {
+    public static func isValidHost(url: URL) -> Bool {
         guard let host = url.host else {
             return false
         }
diff --git a/Modules/Sources/WordPressShared/Utility/Queue.swift b/Modules/Sources/WordPressShared/Utility/Queue.swift
@@ -6,21 +6,23 @@ import Foundation
 public struct Queue<Element> {
     private var elements = [Element]()
 
+    public init() {}
+
     /// Push `element` onto the back of the queue
     ///
-    mutating func push(_ element: Element) {
+    public mutating func push(_ element: Element) {
         elements.insert(element, at: elements.startIndex)
     }
 
     /// Remove and return the item at the front of the queue
     ///
-    mutating func pop() -> Element? {
-        return elements.popLast()
+    public mutating func pop() -> Element? {
+        elements.popLast()
     }
 
     /// Removes all elements; If `where` is given, only the elements matching the
     /// predicate will be removed.
-    mutating func removeAll(where shouldBeRemoved: ((Element) -> Bool)? = nil) {
+    public mutating func removeAll(where shouldBeRemoved: ((Element) -> Bool)? = nil) {
         if let shouldBeRemoved {
             elements.removeAll(where: shouldBeRemoved)
         } else {
diff --git a/Modules/Sources/WordPressShared/Utility/ReaderCSS.swift b/Modules/Sources/WordPressShared/Utility/ReaderCSS.swift
@@ -1,10 +1,9 @@
 import Foundation
-import WordPressShared
 
 /// A struct that returns the Reader CSS URL
 /// If you need to fix an issue in the CSS, see pbArwn-GU-p2
 ///
-struct ReaderCSS {
+public struct ReaderCSS {
     private let store: KeyValueDatabase
 
     private let now: Int
@@ -14,17 +13,17 @@ struct ReaderCSS {
     private let expirationDays: Int = 5
 
     private var expirationDaysInSeconds: Int {
-        return expirationDays * 60 * 60 * 24
+        expirationDays * 60 * 60 * 24
     }
 
     static let updatedKey = "ReaderCSSLastUpdated"
 
     /// Returns a custom Reader CSS URL
     /// This value can be changed under Settings > Debug
     ///
-    var customAddress: String? {
+    public var customAddress: String? {
         get {
-            return store.object(forKey: "reader-css-url") as? String
+            store.object(forKey: "reader-css-url") as? String
         }
         set {
             store.set(newValue, forKey: "reader-css-url")
@@ -34,19 +33,22 @@ struct ReaderCSS {
     /// Returns the Reader CSS appending a timestamp
     /// We force it to update based on the `expirationDays` property
     ///
-    var address: String {
+    public var address: String {
         guard let lastUpdated = store.object(forKey: type(of: self).updatedKey) as? Int,
-              now - lastUpdated < expirationDaysInSeconds || !isInternetReachable() else {
+            now - lastUpdated < expirationDaysInSeconds || !isInternetReachable()
+        else {
             saveCurrentDate()
             return url(appendingTimestamp: now)
         }
 
         return url(appendingTimestamp: lastUpdated)
     }
 
-    init(now: Int = Int(Date().timeIntervalSince1970),
-         store: KeyValueDatabase = UserPersistentStoreFactory.instance(),
-         isInternetReachable: @escaping () -> Bool = ReachabilityUtils.isInternetReachable) {
+    public init(
+        now: Int = Int(Date().timeIntervalSince1970),
+        store: KeyValueDatabase = UserPersistentStoreFactory.instance(),
+        isInternetReachable: @escaping () -> Bool = ReachabilityUtils.isInternetReachable
+    ) {
         self.store = store
         self.now = now
         self.isInternetReachable = isInternetReachable
diff --git a/Modules/Sources/WordPressShared/Utility/SiteCreationHeaderData.swift b/Modules/Sources/WordPressShared/Utility/SiteCreationHeaderData.swift
@@ -0,0 +1,12 @@
+/// Describes the header information presented to a user during individual steps of Site Creation.
+/// This struct is best suited for cases where these values are static (i.e., not retrieved from the server).
+///
+public struct SiteCreationHeaderData {
+    public let title: String
+    public let subtitle: String
+
+    public init(title: String, subtitle: String) {
+        self.title = title
+        self.subtitle = subtitle
+    }
+}
diff --git a/Modules/Tests/WordPressSharedTests/DashboardDynamicCardAnalyticsEventTests.swift b/Modules/Tests/WordPressSharedTests/DashboardDynamicCardAnalyticsEventTests.swift
@@ -1,4 +1,4 @@
-@testable import WordPress
+@testable import WordPressShared
 import XCTest
 
 final class DashboardDynamicCardAnalyticsEventTests: XCTestCase {
diff --git a/Modules/Tests/WordPressSharedTests/LoggingURLRedactorTests.swift b/Modules/Tests/WordPressSharedTests/LoggingURLRedactorTests.swift
@@ -1,5 +1,5 @@
 import XCTest
-@testable import WordPress
+@testable import WordPressShared
 
 class LoggingURLRedactorTests: XCTestCase {
 
diff --git a/Modules/Tests/WordPressSharedTests/QRLoginURLParserTests.swift b/Modules/Tests/WordPressSharedTests/QRLoginURLParserTests.swift
@@ -1,5 +1,5 @@
 import XCTest
-@testable import WordPress
+@testable import WordPressShared
 
 class QRLoginURLParserTests: XCTestCase {
     /// Test to make sure isValidHost returns true when passed a valid URL host
diff --git a/Modules/Tests/WordPressSharedTests/QueueTests.swift b/Modules/Tests/WordPressSharedTests/QueueTests.swift
@@ -1,5 +1,5 @@
 import XCTest
-@testable import WordPress
+@testable import WordPressShared
 
 class QueueTests: XCTestCase {
     private var queue = Queue<Int>()
diff --git a/Modules/Tests/WordPressSharedTests/ReaderCSSTests.swift b/Modules/Tests/WordPressSharedTests/ReaderCSSTests.swift
@@ -1,7 +1,6 @@
-import WordPressShared
 import XCTest
 
-@testable import WordPress
+@testable import WordPressShared
 
 class ReaderCSSTests: XCTestCase {
     // MARK: - When online
diff --git a/Modules/Tests/WordPressSharedTests/SiteCreationHeaderDataTests.swift b/Modules/Tests/WordPressSharedTests/SiteCreationHeaderDataTests.swift
@@ -1,5 +1,5 @@
 import XCTest
-@testable import WordPress
+@testable import WordPressShared
 
 final class SiteCreationHeaderDataTests: XCTestCase {
     private struct Constants {
diff --git a/Modules/Tests/WordPressSharedTests/URLHelpersTests.swift b/Modules/Tests/WordPressSharedTests/URLHelpersTests.swift
@@ -1,5 +1,5 @@
 import XCTest
-import WordPress
+import WordPressShared
 
 class URLHelpersTests: XCTestCase {
 
diff --git a/Tests/KeystoneTests/Tests/Extensions/DictionaryHelpersTests.swift b/Tests/KeystoneTests/Tests/Extensions/DictionaryHelpersTests.swift
diff --git a/Tests/KeystoneTests/Tests/Extensions/URLIncrementalFilenameTests.swift b/Tests/KeystoneTests/Tests/Extensions/URLIncrementalFilenameTests.swift
diff --git a/Tests/KeystoneTests/Tests/Features/Dashboard/BlogDashboardDynamicCardCoordinatorTests.swift b/Tests/KeystoneTests/Tests/Features/Dashboard/BlogDashboardDynamicCardCoordinatorTests.swift
@@ -1,4 +1,5 @@
 @testable import WordPress
+import WordPressShared
 import XCTest
 
 final class BlogDashboardDynamicCardCoordinatorTests: XCTestCase {
diff --git a/Tests/KeystoneTests/Tests/Login/QRLoginCoordinatorTests.swift b/Tests/KeystoneTests/Tests/Login/QRLoginCoordinatorTests.swift
@@ -1,4 +1,5 @@
 import XCTest
+import WordPressShared
 @testable import WordPress
 
 class QRLoginCoordinatorTests: XCTestCase {
diff --git a/Tests/KeystoneTests/Tests/Login/QRLoginScanningCoordinatorTests.swift b/Tests/KeystoneTests/Tests/Login/QRLoginScanningCoordinatorTests.swift
@@ -1,4 +1,5 @@
 import XCTest
+import WordPressShared
 @testable import WordPress
 
 class QRLoginScanningCoordinatorTests: XCTestCase {
diff --git a/Tests/KeystoneTests/Tests/Login/QRLoginVerifyCoordinatorTests.swift b/Tests/KeystoneTests/Tests/Login/QRLoginVerifyCoordinatorTests.swift
@@ -1,4 +1,5 @@
 import XCTest
+import WordPressShared
 @testable import WordPress
 @testable import WordPressData
 
diff --git a/WordPress/Classes/Services/QRLoginService.swift b/WordPress/Classes/Services/QRLoginService.swift
@@ -1,4 +1,5 @@
 import Foundation
+import WordPressShared
 import WordPressData
 import WordPressKit
 
diff --git a/WordPress/Classes/ViewRelated/Me/App Settings/DebugMenuViewController.swift b/WordPress/Classes/ViewRelated/Me/App Settings/DebugMenuViewController.swift
@@ -1,4 +1,5 @@
 import UIKit
+import WordPressShared
 import AsyncImageKit
 import AutomatticTracks
 import BuildSettingsKit
diff --git a/WordPress/Classes/ViewRelated/QR Login/Coordinators/QRLoginScanningCoordinator.swift b/WordPress/Classes/ViewRelated/QR Login/Coordinators/QRLoginScanningCoordinator.swift
@@ -1,4 +1,5 @@
 import UIKit
+import WordPressShared
 
 class QRLoginScanningCoordinator: NSObject {
     let parentCoordinator: QRLoginParentCoordinator
diff --git a/WordPress/Classes/ViewRelated/QR Login/Coordinators/QRLoginVerifyCoordinator.swift b/WordPress/Classes/ViewRelated/QR Login/Coordinators/QRLoginVerifyCoordinator.swift
@@ -1,4 +1,5 @@
 import Foundation
+import WordPressShared
 import WordPressData
 import WordPressKit
 
diff --git a/WordPress/Classes/ViewRelated/QR Login/Helpers/QRLoginProtocols.swift b/WordPress/Classes/ViewRelated/QR Login/Helpers/QRLoginProtocols.swift
@@ -1,4 +1,5 @@
 import AVFoundation
+import WordPressShared
 import UIKit
 import QuartzCore
 import WordPressKit
diff --git a/WordPress/Classes/ViewRelated/Site Creation/Shared/SiteCreationHeaderData.swift b/WordPress/Classes/ViewRelated/Site Creation/Shared/SiteCreationHeaderData.swift

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-@testable import WordPress`
	`1`	`+@testable import WordPressShared`
`2`	`2`	`import XCTest`
`3`	`3`
`4`	`4`	`final class DashboardDynamicCardAnalyticsEventTests: XCTestCase {`