Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edonv/orother
A macro for adding a blank "other" case to any enum.
https://github.com/edonv/orother
enum macro other swift xcode
Last synced: 2 months ago
JSON representation
A macro for adding a blank "other" case to any enum.
- Host: GitHub
- URL: https://github.com/edonv/orother
- Owner: edonv
- License: mit
- Created: 2024-02-22T22:47:36.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-07-13T16:02:53.000Z (6 months ago)
- Last Synced: 2024-10-14T01:33:45.504Z (3 months ago)
- Topics: enum, macro, other, swift, xcode
- Language: Swift
- Homepage:
- Size: 34.2 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OrOther
[](https://swiftpackageindex.com/edonv/OrOther)
[](https://swiftpackageindex.com/edonv/OrOther)
`OrOther` is a macro that adds a "blank" `.other(_:)` case to any enum. All that's needed is to create an empty enum, add a `private` nested enum called `Options` with an explicit raw value type, add the explicit cases you want, then tack `@OrOther` onto the primary enum.
`OrOther` will automatically synthesize the any enum cases you add to `Options`, then add an extra `.other(_:)` case. The `.other(_:)` case has an associated value of the same type as the `Options` enum's raw value.
It also automatically synthesizes conformace to `RawRepresentable` for the attached enum, by adding a synthesized computed `rawValue` property and `init(rawValue:)` initializer:
- `rawValue` returns the `rawValue` of the matching case from the nested `Options` enum, unless it's `.other`, in which case, the associated value is returned.
- `init(rawValue:)` is *non-failable*, as it first tries to match the `rawValue` to that of the `Options` enum and return the matching case. If there isn't a matching case in `Options`, it returns `rawValue` as the associated value of an `.other` case.
You can then add other protocols to your primary enum as you'd like (e.g. adding `Codable` to `EnumTest` in the example below).
Additionally, due to macros not being able to add an extension for a `private` type, you cannot make the primary enum `private`. The only workaround as of now is to explictly conform the primary enum to `RawRepresentable`.
## Example
### Usage
```swift
@OrOther
enum EnumTest: Codable {
private enum Options: String {
case a
case b
case c, d, e, f
}
}
```
### Synthesized Output
```swift
enum EnumTest {
private enum Options: String { ... }
typealias RawValue = String
case a, b, c, d, e, f, other(String)
var rawValue: RawValue {
switch self {
case .a:
return Options.a.rawValue
case .b:
return Options.b.rawValue
case .c:
return Options.c.rawValue
case .d:
return Options.d.rawValue
case .e:
return Options.e.rawValue
case .f:
return Options.f.rawValue
case .other(let string):
return string
}
}
init(rawValue: RawValue) {
if let this = Options(rawValue: rawValue) {
switch this {
case .a:
self = .a
case .b:
self = .b
case .c:
self = .c
case .d:
self = .d
case .e:
self = .e
case .f:
self = .f
}
} else {
self = .other(rawValue)
}
}
}
```
## Supported Protocols
The following protocols can be explicitly added to the primary enum, and `@OrOther` its conformance will be automatically synthesized:
- `Equatable`
- `Hashable`
- `Encodable` / `Decodable` / `Codable`
- `CaseIterable`