Macros to help automating SwiftRex boilerplate
A macro that produces memberwise initializers for a struct, with the option to control the visibility accessor modifier.
@MemberwiseInit(visibility: .fileprivate)
public struct BlackjackCard {
var suit = "diamonds", rank = "3"
let type: String
let flipped: Bool
let onFlip: (Bool) -> Void
}produces:
extension BlackjackCard {
fileprivate init(suit: String = "diamonds", rank: String = "3", type: String, flipped: Bool, onFlip: @escaping (Bool) -> Void) {
self.suit = suit
self.rank = rank
self.type = type
self.flipped = flipped
}
}Type inference is hard. Swift compiler does an amazing job inferring types, especially in closures. However, re-implementing whatever Swift compiler does to infer the types would not be feasible here, and Swift Macros run before type-checkers, so we can't reliably know what type is when a variable is not explicitly telling us:
@MemberwiseInit
struct MyStruct {
// Bool
var isToday = Calendar.current.isDateInToday(Date())
// (DateComponents) -> Date?
var myCrazyClosure = {
Calendar.current.date(from: $0)
}
}In such situations, the variable may be omited from the init, causing a compiler error, or it may use a wrong value that we tried our best to infer. If you face such situations, please explicitly annotate your variables with the proper type, and everything should work as expected.
A macro that produces predicates and prisms for all cases of an Enum.
Predicates will be Bool properties in the format isCaseA that returns true whenever that instance points to the caseA case of the enum.
Prism is a property with the same name as the case, but for the instance of the enum. If the instance points to that case, the variable will return a tuple of all associated values of that case, or instance of Void () for case without associated values. However, if the instance points to another case, it will return nil. This is extremely useful for using KeyPaths.
@Prism
enum Color {
case red, green, blue
}produces:
extension Color {
var isRed: Bool {
if case .red = self { true } else { false }
}
var isGreen: Bool {
if case .green = self { true } else { false }
}
var isBlue: Bool {
if case .blue = self { true } else { false }
}
}usage:
let color1 = Color.red
color1.isRed // true
color1.isGreen // false
color1.isBlue // false@Prism
enum Contact {
case email(address: String)
case phone(countryCode: String, number: String)
case letter(street: String, house: String, postalCode: String, city: String, state: String, country: String)
case noContact
}produces:
extension Contact {
var email: String? {
guard case let .email(address) = self else { return nil }
return address
}
var phone: (countryCode: String, number: String)? {
guard case let .phone(countryCode, number) = self else { return nil }
return (countryCode: countryCode, number: number)
}
var letter: (street: String, house: String, postalCode: String, city: String, state: String, country: String)? {
guard case let .letter(street, house, postalCode, city, state, country) = self else { return nil }
return (street: street, house: house, postalCode: postalCode, city: city, state: state, country: country)
}
var noContact: Void? {
guard case .noContact = self else { return nil }
return ()
}
}Please notice that the Void case is important not only for consistency, but for more advanced cases of composition.
Logically, a case with no associated values "holds" a Void associated value (singleton type), or not (nil) if the instance has another case.
usage:
let contact = Contact.phone(countryCode: "44", number: "078906789")
let phone = contact.phone.map { $0.countryCode + " " + $0.number } ?? "<No Phone>" // "44 078906789"
let resolveEmail: KeyPath<Contact, String?> = \Contact.email // passing contact will resolve to `nil`,
// but passing something with email will resolve to the addreesSetter Prisms also produce setters. In that case, if the enum case has an associated value and you want to change the values in the tuple, that is possible as long as the instance points to the same case, otherwise it will be ignored. For example:
var contact = Contact.phone(countryCode: "44", number: "078906789")
contact.phone = (countryCode: "44", number: "99999999") // ✅ this change happens with success
contact.email = "my@email.com" // 🚫 this change is ignored, because the enum instance points to phone, not emailThe setter can be really useful if you have a long tree of enums and want to change the leaf. It's also useful for WritableKeyPath situations.
Extra:
- Use
Prismin the enum if you want to generate code for every case - Use
PrismCasein a case if you want a different visibility only for that case generated code. - Use only
PrismCasewithoutPrismin the enum if you want code generated only for that case. - Use
NoPrismin a case if you don't want code generated for that case.
A macro that produces predicates and prisms for a single case of an Enum.
enum Color {
case red, black
@PrismCase
case green, blue
case yellow, white
}produces:
extension Color {
var isGreen: Bool {
if case .green = self { true } else { false }
}
var isBlue: Bool {
if case .blue = self { true } else { false }
}
}usage:
let color1 = Color.green
color1.isGreen // true
color1.isBlue // false
color1.isRed 🚫 // Compiler error, not generatedenum Contact {
case email(address: String)
@PrismCase
case phone(countryCode: String, number: String)
case letter(street: String, house: String, postalCode: String, city: String, state: String, country: String)
case noContact
}produces:
extension Contact {
var phone: (countryCode: String, number: String)? {
guard case let .phone(countryCode, number) = self else { return nil }
return (countryCode: countryCode, number: number)
}
}Please notice that the Void case is important not only for consistency, but for more advanced cases of composition.
Logically, a case with no associated values "holds" a Void associated value (singleton type), or not (nil) if the instance has another case.
usage:
let contact = Contact.phone(countryCode: "44", number: "078906789")
let phone = contact.phone.map { $0.countryCode + " " + $0.number } ?? "<No Phone>" // "44 078906789"
let resolveEmail: KeyPath<Contact, String?> = \Contact.phone?.number // passing contact will resolve to `"078906789"`,
// but passing something with email will resolve to nilA macro that prevents the code generatio of predicates and prisms for a specific case, in an Enum marked with Prism
@Prism
enum Color {
case red, green, blue
@NoPrism
case white, black
}produces:
extension Color {
var isRed: Bool {
if case .red = self { true } else { false }
}
var isGreen: Bool {
if case .green = self { true } else { false }
}
var isBlue: Bool {
if case .blue = self { true } else { false }
}
}usage:
let color1 = Color.red
color1.isRed // true
color1.isGreen // false
color1.isBlue // false
color1.isWhite 🚫 // Compiler error, not generated@Prism
enum Contact {
case email(address: String)
case phone(countryCode: String, number: String)
@NoPrism
case letter(street: String, house: String, postalCode: String, city: String, state: String, country: String)
@NoPrism
case noContact
}produces:
extension Contact {
var email: String? {
guard case let .email(address) = self else { return nil }
return address
}
var phone: (countryCode: String, number: String)? {
guard case let .phone(countryCode, number) = self else { return nil }
return (countryCode: countryCode, number: number)
}
}Please notice that the Void case is important not only for consistency, but for more advanced cases of composition.
Logically, a case with no associated values "holds" a Void associated value (singleton type), or not (nil) if the instance has another case.
usage:
let contact = Contact.phone(countryCode: "44", number: "078906789")
let phone = contact.phone.map { $0.countryCode + " " + $0.number } ?? "<No Phone>" // "44 078906789"
let resolveEmail: KeyPath<Contact, String?> = \Contact.email // passing contact will resolve to `nil`,
// but passing something with email will resolve to the addrees