Merge Ratings into AtlText

Sources/Gravatar/Network/Services/AvatarService.swift

@@ -90,15 +90,22 @@ public struct AvatarService: Sendable {
         }
     }
 
-    package func update(_ altText: String?, rating: AvatarRating?, avatarID: String, accessToken: String) async throws {
+    @discardableResult
+    package func update(
+        _ altText: String?,
+        rating: AvatarRating?,
+        avatarID: String,
+        accessToken: String
+    ) async throws -> Avatar {
         var request = URLRequest(url: .avatarsURL.appendingPathComponent(avatarID))
         request.httpMethod = "PATCH"
         let updateBody = UpdateAvatarRequest(rating: rating, altText: altText)
         request.httpBody = try JSONEncoder().encode(updateBody)
 
         let authorizedRequest = request.settingAuthorizationHeaderField(with: accessToken)
         do {
-            _ = try await client.data(with: authorizedRequest)
+            let (data, _) = try await client.data(with: authorizedRequest)
+            return try data.decode()
         } catch {
             throw error.apiError()
         }

Sources/GravatarUI/Avatar+AvatarRating.swift

@@ -0,0 +1,13 @@
+extension Avatar {
+    /// Transforms `Avatar.Rating` into `AvatarRating`
+    /// This is only necessary while we maintain both enums.  For our next major realease, `Avatar` will use the `AvatarRating` enum
+    /// rather than defining its own.
+    var avatarRating: AvatarRating {
+        switch self.rating {
+        case .g: .g
+        case .pg: .pg
+        case .r: .r
+        case .x: .x
+        }
+    }
+}

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

@@ -1,6 +1,21 @@
+/* Rating that indicates that the avatar is suitable for everyone */
+"Avatar.Rating.G.subtitle" = "General";
+
+/* Rating that indicates that the avatar may not be suitable for children */
+"Avatar.Rating.PG.subtitle" = "Parental Guidance";
+
+/* Rating that indicates that the avatar may not be suitable for children */
+"Avatar.Rating.R.subtitle" = "Restricted";
+
+/* Rating that indicates that the avatar is obviously and extremely unsuitable for children */
+"Avatar.Rating.X.subtitle" = "Extreme";
+
 /* An option in the avatar menu that deletes the avatar */
 "AvatarPicker.AvatarAction.delete" = "Delete";
 
+/* An option in the avatar menu that shows the current rating, and allows the user to change that rating. The rating is used to indicate the appropriateness of an avatar for different audiences, and follows the US system of Motion Picture ratings: G, PG, R, and X. */
+"AvatarPicker.AvatarAction.rate" = "Rating: %@";
+
 /* An option in the avatar menu that shares the avatar */
 "AvatarPicker.AvatarAction.share" = "Share...";
 
@@ -82,6 +97,12 @@
 /* This error message shows when the user attempts to delete an avatar and fails. */
 "AvatarPickerViewModel.Delete.Error" = "Oops, there was an error deleting the image.";
 
+/* This error message shows when the user attempts to change the rating of an avatar and fails. */
+"AvatarPickerViewModel.Rating.Error" = "Oops, something didn't quite work out while trying to rate your avatar.";
+
+/* This confirmation message shows when the user picks a different avatar rating and the change was applied successfully. */
+"AvatarPickerViewModel.RatingUpdate.Success" = "Avatar rating was changed successfully.";
+
 /* This error message shows when the user attempts to share an avatar and fails. */
 "AvatarPickerViewModel.Share.Fail" = "Oops, something didn't quite work out while trying to share your avatar.";
 

Sources/GravatarUI/SwiftUI/AvatarPicker/AvatarAction.swift

@@ -1,25 +1,23 @@
 import Foundation
 import SwiftUI
 
-enum AvatarAction: String, CaseIterable, Identifiable {
+enum AvatarAction: Identifiable {
     case share
     case delete
+    case rating(AvatarRating)
     case playground
     case altText
 
-    static var allCases: [AvatarAction] {
-        var cases: [AvatarAction] = []
-        if #available(iOS 18.2, *) {
-            if EnvironmentValues().supportsImagePlayground {
-                cases.append(.playground)
-            }
+    var id: String {
+        switch self {
+        case .share: "share"
+        case .delete: "delete"
+        case .rating(let rating): rating.rawValue
+        case .playground: "playground"
+        case .altText: "altText"
         }
-        cases.append(contentsOf: [.share, .altText, .delete])
-        return cases
     }
 
-    var id: String { rawValue }
-
     var icon: Image {
         switch self {
         case .delete:
@@ -30,6 +28,8 @@ enum AvatarAction: String, CaseIterable, Identifiable {
             Image(systemName: "apple.image.playground")
         case .altText:
             Image(systemName: "text.below.photo")
+        case .rating:
+            Image(systemName: "star.leadinghalf.filled")
         }
     }
 
@@ -59,14 +59,23 @@ enum AvatarAction: String, CaseIterable, Identifiable {
                 value: "Alt Text",
                 comment: "An option in the avatar menu that edits the avatar's Alt Text."
             )
+        case .rating(let rating):
+            String(
+                format: SDKLocalizedString(
+                    "AvatarPicker.AvatarAction.rate",
+                    value: "Rating: %@",
+                    comment: "An option in the avatar menu that shows the current rating, and allows the user to change that rating. The rating is used to indicate the appropriateness of an avatar for different audiences, and follows the US system of Motion Picture ratings: G, PG, R, and X."
+                ),
+                rating.rawValue
+            )
         }
     }
 
     var role: ButtonRole? {
         switch self {
         case .delete:
             .destructive
-        case .share, .playground, .altText:
+        case .share, .rating, .playground, .altText:
             nil
         }
     }

Sources/GravatarUI/SwiftUI/AvatarPicker/AvatarImageModel.swift

@@ -18,6 +18,7 @@ struct AvatarImageModel: Hashable, Identifiable, Sendable {
     let isSelected: Bool
     let state: State
     let altText: String?
+    let rating: AvatarRating
 
     var url: URL? {
         guard case .remote(let url) = source else {
@@ -47,11 +48,12 @@ struct AvatarImageModel: Hashable, Identifiable, Sendable {
         return image
     }
 
-    init(id: String, source: Source, state: State = .loaded, isSelected: Bool = false, altText: String? = nil) {
+    init(id: String, source: Source, state: State = .loaded, isSelected: Bool = false, rating: AvatarRating = .g, altText: String? = nil) {
         self.id = id
         self.source = source
         self.state = state
         self.isSelected = isSelected
+        self.rating = rating
         self.altText = altText
     }
 

Sources/GravatarUI/SwiftUI/AvatarPicker/AvatarPickerView.swift

@@ -394,6 +394,10 @@ struct AvatarPickerView<ImageEditor: ImageEditorView>: View {
             }
         case .altText:
             editAltText(for: avatar)
+        case .rating(let rating):
+            Task {
+                await model.update(avatar, rating: rating)
+            }
         }
     }
 

Sources/GravatarUI/SwiftUI/AvatarPicker/AvatarPickerViewModel.swift

@@ -207,7 +207,7 @@ class AvatarPickerViewModel: ObservableObject {
 
         let localID = UUID().uuidString
 
-        let localImageModel = AvatarImageModel(id: localID, source: .local(image: image), state: .loading)
+        let localImageModel = AvatarImageModel(id: localID, source: .local(image: image), state: .loading, rating: .g)
         grid.append(localImageModel)
 
         await doUpload(squareImage: image, localID: localID, accessToken: authToken)
@@ -290,7 +290,8 @@ class AvatarPickerViewModel: ObservableObject {
         let newModel = AvatarImageModel(
             id: imageID,
             source: .local(image: squareImage),
-            state: .error(supportsRetry: supportsRetry, errorMessage: errorMessage)
+            state: .error(supportsRetry: supportsRetry, errorMessage: errorMessage),
+            rating: grid.model(with: imageID)?.rating ?? .g
         )
         grid.replaceModel(withID: imageID, with: newModel)
     }
@@ -337,6 +338,7 @@ class AvatarPickerViewModel: ObservableObject {
         await profile
     }
 
+    @discardableResult
     func update(_ avatar: AvatarImageModel, altText: String) async -> Bool {
         guard let token = self.authToken else { return false }
         do {
@@ -359,6 +361,35 @@ class AvatarPickerViewModel: ObservableObject {
         return false
     }
 
+    @discardableResult
+    func update(_ avatar: AvatarImageModel, rating: AvatarRating) async -> Bool {
+        guard let authToken else { return false }
+
+        do {
+            let updatedAvatar = try await avatarService.update(
+                nil,
+                rating: rating,
+                avatarID: avatar.id,
+                accessToken: authToken
+            )
+            withAnimation {
+                grid.replaceModel(withID: avatar.id, with: .init(with: updatedAvatar))
+                toastManager.showToast(Localized.avatarRatingUpdateSuccess, type: .info)
+            }
+            return true
+        } catch APIError.responseError(let reason) where reason.urlSessionErrorLocalizedDescription != nil {
+            handleError(message: reason.urlSessionErrorLocalizedDescription ?? Localized.avatarRatingError)
+        } catch {
+            handleError(message: Localized.avatarRatingError)
+        }
+
+        func handleError(message: String) {
+            toastManager.showToast(message, type: .error)
+        }
+
+        return false
+    }
+
     func delete(_ avatar: AvatarImageModel) async -> Bool {
         guard let token = self.authToken else { return false }
         defer {
@@ -446,6 +477,16 @@ extension AvatarPickerViewModel {
             value: "Image alt text was changed successfully",
             comment: "This confirmation message shows when the user has updated the alt text."
         )
+        static let avatarRatingUpdateSuccess = SDKLocalizedString(
+            "AvatarPickerViewModel.RatingUpdate.Success",
+            value: "Avatar rating was changed successfully.",
+            comment: "This confirmation message shows when the user picks a different avatar rating and the change was applied successfully."
+        )
+        static let avatarRatingError = SDKLocalizedString(
+            "AvatarPickerViewModel.Rating.Error",
+            value: "Oops, something didn't quite work out while trying to rate your avatar.",
+            comment: "This error message shows when the user attempts to change the rating of an avatar and fails."
+        )
     }
 }
 
@@ -468,5 +509,6 @@ extension AvatarImageModel {
         state = .loaded
         isSelected = avatar.isSelected
         altText = avatar.altText
+        rating = avatar.avatarRating
     }
 }

Sources/GravatarUI/SwiftUI/AvatarPicker/Views/AvatarPickerAvatarView.swift

@@ -80,25 +80,105 @@ struct AvatarPickerAvatarView: View {
 
     func actionsMenu() -> some View {
         Menu {
-            ForEach(AvatarAction.allCases) { action in
-                Button(role: action.role) {
-                    onActionTap(action)
-                } label: {
-                    Label {
-                        Text(action.localizedTitle)
-                    } icon: {
-                        action.icon
+            Section {
+                button(for: .share)
+                if #available(iOS 18.2, *) {
+                    if EnvironmentValues().supportsImagePlayground {
+                        button(for: .playground)
                     }
                 }
             }
+            Section {
+                button(for: .altText)
+                Menu {
+                    ForEach(AvatarRating.allCases, id: \.self) { rating in
+                        button(for: .rating(rating), isSelected: rating == avatar.rating)
+                    }
+                } label: {
+                    label(forAction: AvatarAction.rating(avatar.rating))
+                }
+            }
+            Section {
+                button(for: .delete)
+            }
         } label: {
             ellipsisView()
         }
     }
+
+    private func button(
+        for action: AvatarAction,
+        isSelected selected: Bool = false,
+        systemImageWhenSelected systemImage: String = "checkmark"
+    ) -> some View {
+        Button(role: action.role) {
+            onActionTap(action)
+        } label: {
+            switch action {
+            case .rating(let rating):
+                let buttonTitle = "\(rating.rawValue) (\(rating.localizedSubtitle))"
+
+                if selected {
+                    label(forAction: action, title: buttonTitle, systemImage: systemImage)
+                } else {
+                    Text(buttonTitle)
+                }
+            case .altText, .delete, .playground, .share:
+                label(forAction: action)
+            }
+        }
+    }
+
+    private func label(forAction action: AvatarAction, title: String? = nil, systemImage: String) -> Label<Text, Image> {
+        label(forAction: action, title: title, image: Image(systemName: systemImage))
+    }
+
+    private func label(forAction action: AvatarAction, title: String? = nil, image: Image? = nil) -> Label<Text, Image> {
+        Label {
+            Text(title ?? action.localizedTitle)
+        } icon: {
+            image ?? action.icon
+        }
+    }
+}
+
+extension AvatarRating {
+    fileprivate var localizedSubtitle: String {
+        switch self {
+        case .g:
+            SDKLocalizedString(
+                "Avatar.Rating.G.subtitle",
+                value: "General",
+                comment: "Rating that indicates that the avatar is suitable for everyone"
+            )
+        case .pg:
+            SDKLocalizedString(
+                "Avatar.Rating.PG.subtitle",
+                value: "Parental Guidance",
+                comment: "Rating that indicates that the avatar may not be suitable for children"
+            )
+        case .r:
+            SDKLocalizedString(
+                "Avatar.Rating.R.subtitle",
+                value: "Restricted",
+                comment: "Rating that indicates that the avatar may not be suitable for children"
+            )
+        case .x:
+            SDKLocalizedString(
+                "Avatar.Rating.X.subtitle",
+                value: "Extreme",
+                comment: "Rating that indicates that the avatar is obviously and extremely unsuitable for children"
+            )
+        }
+    }
 }
 
 #Preview {
-    let avatar = AvatarImageModel(id: "1", source: .remote(url: "https://gravatar.com/userimage/110207384/aa5f129a2ec75162cee9a1f0c472356a.jpeg?size=256"))
+    let avatar = AvatarImageModel(
+        id: "1",
+        source: .remote(url: "https://gravatar.com/userimage/110207384/aa5f129a2ec75162cee9a1f0c472356a.jpeg?size=256"),
+        rating: .pg
+    )
     return AvatarPickerAvatarView(avatar: avatar, maxLength: AvatarGridConstants.maxAvatarWidth, minLength: AvatarGridConstants.minAvatarWidth) {
         false
     } onAvatarTap: { _ in

Sources/TestHelpers/Bundle+ResourceBundle.swift

@@ -44,6 +44,10 @@ extension Bundle {
         testsBundle.jsonData(forResource: "avatarUploadResponse")
     }
 
+    public static var setRatingJsonData: Data {
+        testsBundle.jsonData(forResource: "avatarSetRatingResponse")
+    }
+
     public static var getAvatarsJsonData: Data {
         testsBundle.jsonData(forResource: "avatarsResponse")
     }

Sources/TestHelpers/Resources/avatarSetRatingResponse.json

@@ -0,0 +1,7 @@
+{
+  "image_id": "991a7b71cf9f34...",
+  "image_url": "https://2.gravatar.com/userimage/1/991a7b71cf934ea2...?size=512",
+  "rating": "PG",
+  "updated_date": "2024-09-18T10:17:53Z",
+  "alt_text": "John Appleseed's avatar"
+}