Move AppLocalizedString to WordPressShared (#24223)

* Move AppLocalizedString to WordPressShared

* Make Bundle.app private

* Remove unneeded Foundation imports

Author: kean

WordPress/Classes/Utility/AppLocalizedString.swift renamed to Modules/Sources/WordPressShared/Utility/AppLocalizedString.swift

@@ -1,37 +1,4 @@
-import SwiftUI
-
-extension Bundle {
-    /// Returns the `Bundle` for the host `.app`.
-    ///
-    /// - If this is called from code already located in the main app's bundle or from a Pod/Framework,
-    ///   this will return the same as `Bundle.main`, aka the bundle of the app itself.
-    /// - If this is called from an App Extension (Widget, ShareExtension, etc), this will return the bundle of the
-    ///   main app hosting said App Extension (while `Bundle.main` would return the App Extension itself)
-    ///
-    /// This is particularly useful to reference a resource or string bundled inside the app from an App Extension / Widget.
-    ///
-    /// - Note:
-    ///   In the context of Unit Tests this will return the Test Harness (aka Test Host) app, since that is the app running said tests.
-    ///
-    static let app: Bundle = {
-        var url = Bundle.main.bundleURL
-        while url.pathExtension != "app" && url.lastPathComponent != "/" {
-            url.deleteLastPathComponent()
-        }
-        guard let appBundle = Bundle(url: url) else { fatalError("Unable to find the parent app bundle") }
-        return appBundle
-    }()
-}
-
-/// Use this to express *intent* on your API that the string you are manipulating / returning is intended to already be localized
-/// and its value to have been provided via a call to `NSLocalizedString` or `AppLocalizedString`.
-///
-/// Semantically speaking, a method taking or returning a `LocalizedString` is signaling that you can display said UI string
-/// to the end user, without the need to be treated as a key to be localized. The string is expected to already have been localized
-/// at that point of the code, via a call to `NSLocalizedString`, `AppLocalizedString` or similar upstream in the code.
-///
-/// - Note: Remember though that, as a `typealias`, this won't provide any compile-time guarantee.
-typealias LocalizedString = String
+import Foundation
 
 /// Use this function instead of `NSLocalizedString` to reference localized strings **from the app bundle** – especially
 /// when using localized strings from the code of an app extension.
@@ -63,6 +30,29 @@ typealias LocalizedString = String
 /// - Returns: A localized version of the string designated by `key` in the table identified by `tableName`.
 ///   If the localized string for `key` cannot be found within the table, `value` is returned.
 ///   (However, `key` is returned instead when `value` is `nil` or the empty string).
-func AppLocalizedString(_ key: String, tableName: String? = nil, value: String? = nil, comment: String) -> LocalizedString {
+public func AppLocalizedString(_ key: String, tableName: String? = nil, value: String? = nil, comment: String) -> String {
     Bundle.app.localizedString(forKey: key, value: value, table: nil)
 }
+
+private extension Bundle {
+    /// Returns the `Bundle` for the host `.app`.
+    ///
+    /// - If this is called from code already located in the main app's bundle or from a Pod/Framework,
+    ///   this will return the same as `Bundle.main`, aka the bundle of the app itself.
+    /// - If this is called from an App Extension (Widget, ShareExtension, etc), this will return the bundle of the
+    ///   main app hosting said App Extension (while `Bundle.main` would return the App Extension itself)
+    ///
+    /// This is particularly useful to reference a resource or string bundled inside the app from an App Extension / Widget.
+    ///
+    /// - Note:
+    ///   In the context of Unit Tests this will return the Test Harness (aka Test Host) app, since that is the app running said tests.
+    ///
+    static let app: Bundle = {
+        var url = Bundle.main.bundleURL
+        while url.pathExtension != "app" && url.lastPathComponent != "/" {
+            url.deleteLastPathComponent()
+        }
+        guard let appBundle = Bundle(url: url) else { fatalError("Unable to find the parent app bundle") }
+        return appBundle
+    }()
+}

WordPress/Classes/Utility/FormattableContent/Actions/FormattableContentAction.swift

@@ -1,3 +1,4 @@
+import WordPressShared
 
 protocol FormattableContentActionParser {
     func parse(_ dictionary: [String: AnyObject]?) -> [FormattableContentAction]

WordPress/Classes/ViewRelated/Aztec/Extensions/FormatBarItemProviders.swift

@@ -2,6 +2,7 @@ import Foundation
 import Gridicons
 import Aztec
 import UIKit
+import WordPressShared
 
 protocol FormatBarItemProvider {
     var iconImage: UIImage { get }

WordPress/Classes/ViewRelated/Aztec/Extensions/TextList+WordPress.swift

@@ -1,6 +1,7 @@
 import Foundation
 import Aztec
 import UIKit
+import WordPressShared
 
 // MARK: - TextList.Style
 //

WordPress/Classes/ViewRelated/Stats/Extensions/Double+Stats.swift

@@ -1,4 +1,5 @@
 import Foundation
+import WordPressShared
 
 fileprivate struct Unit {
     let abbreviationFormat: String

WordPress/Classes/ViewRelated/Views/List/NotificationsList/NotificationsTableViewCellContent.swift

@@ -204,10 +204,10 @@ extension NotificationsTableViewCellContent {
 
             let action: () -> Void
 
-            let accessibilityLabel: LocalizedString
-            let accessibilityHint: LocalizedString
+            let accessibilityLabel: String
+            let accessibilityHint: String
 
-            init(icon: SwiftUI.Image, color: Color? = nil, accessibilityLabel: LocalizedString, accessibilityHint: LocalizedString, action: @escaping () -> Void) {
+            init(icon: SwiftUI.Image, color: Color? = nil, accessibilityLabel: String, accessibilityHint: String, action: @escaping () -> Void) {
                 self.icon = icon
                 self.color = color
                 self.accessibilityLabel = accessibilityLabel

WordPress/JetpackStatsWidgets/Model/GroupedViewData.swift

@@ -1,16 +1,16 @@
-import SwiftUI
+import Foundation
 
 struct GroupedViewData {
 
-    let widgetTitle: LocalizedString
+    let widgetTitle: String
     let siteName: String
-    let upperLeftTitle: LocalizedString
+    let upperLeftTitle: String
     let upperLeftValue: Int
-    let upperRightTitle: LocalizedString
+    let upperRightTitle: String
     let upperRightValue: Int
-    let lowerLeftTitle: LocalizedString
+    let lowerLeftTitle: String
     let lowerLeftValue: Int
-    let lowerRightTitle: LocalizedString
+    let lowerRightTitle: String
     let lowerRightValue: Int
 
     let statsURL: URL?

WordPress/JetpackStatsWidgets/Model/ListViewData.swift

@@ -3,7 +3,7 @@ import JetpackStatsWidgetsCore
 
 struct ListViewData {
 
-    let widgetTitle: LocalizedString
+    let widgetTitle: String
     let siteName: String
     let items: [ThisWeekWidgetDay]
 

WordPress/JetpackStatsWidgets/Views/Cards/FlexibleCard.swift

@@ -3,11 +3,11 @@ import SwiftUI
 /// A card with a title and a numeric or string value that can be either vertically or horizontally stacked
 struct FlexibleCard: View {
     let axis: Axis
-    let title: LocalizedString
+    let title: String
     let value: Value
     let lineLimit: Int
 
-    init(axis: Axis, title: LocalizedString, value: Value, lineLimit: Int = 1) {
+    init(axis: Axis, title: String, value: Value, lineLimit: Int = 1) {
         self.axis = axis
         self.title = title
         self.value = value

WordPress/JetpackStatsWidgets/Views/Cards/ListRow.swift

@@ -1,6 +1,7 @@
 
 import SwiftUI
 import WidgetKit
+import WordPressShared
 
 struct ListRow: View {
     @Environment(\.widgetFamily) var family: WidgetFamily
@@ -48,7 +49,7 @@ struct ListRow: View {
         return percentValue < 0 ? Constants.negativeColor : Constants.positiveColor
     }
 
-    private var differenceLabelText: LocalizedString {
+    private var differenceLabelText: String {
         guard !isToday else {
             return LocalizableStrings.todayWidgetTitle
         }