Toolkit enhancement proposal: Swift CustomStringConvertible and CustomDebugStringConvertible for AGS Objective-C Enums

[esreli]

I would like to introduce a swift toolkit enhancement that would adhere AGS enums to the swift CustomStringConvertible and CustomDebugStringConvertible protocols.

This enhancement will allow someone to either:

1. Help display to a user a stringified status
2. Display to a developer a stringified debug status in the debug console

This will allow a developer to more easily convey information contained in an Objective-C enum (statuses, etc) to themselves or to the user.

For example:

extension AGSDrawStatus: CustomStringConvertible {
    
    public var description: String {
        switch self {
        case AGSDrawStatusInProgress:
            return "In Progress"
        case AGSDrawStatusCompleted:
            return "Completed"
        default:
            return ""
        }
    }
}

extension AGSDrawStatus: CustomDebugStringConvertible {
    
    public var debugDescription: String {
        return "[Draw Status] \(self)"
    }
}

let drawStatus:AGSDrawStatus = AGSDrawStatusInProgress

print(drawStatus)
// In Progress

print(drawStatus.description)
// In Progress

print(drawStatus.debugDescription)
// [Draw Status] In Progress

and

(lldb) po drawStatus
▿ [Draw Status] In Progress
  - rawValue : 0

[philium]

Remember that Swift imports Objective-C enum constants as members, so it would be case .inProgress and case .completed.

The default description for cases of a Swift enum is simply the case name:

enum DrawStatus {
    case inProgress
    case completed
}

print(DrawStatus.inProgress) // inProgress
print(DrawStatus.completed) // completed

What would you think of using the case name for the descriptions?

[esreli]

A heads up @philium, the above construct was based on a simplified proof of concept I had built, they aren't reflective of the actual SDK. I built this proof of concept because I won't be posting proprietary code in a public channel and thus the construct above does not reflect the actual codebase but instead a demo.

As for the stringified enum case, I would personally advocate for a proper description as opposed to printing the case name, it's something that can both be used in debugging as well as something that can be used in some sort of UI element.