Skip to content

[GroveAccount] Support module selectors in the @AccountKey macro #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MonzerMansour wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[GroveAccount] Support module selectors in the @AccountKey macro #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ var dependencies: [Package.Dependency] = [
.package(url: "https://github.com/huggingface/swift-transformers.git", from: "1.0.0"),
.package(url: "https://github.com/pointfreeco/swift-snapshot-testing.git", from: "1.19.2"),
.package(url: "https://github.com/SchmiedmayerLab/ResearchKit.git", "3.1.4"..<"3.2.0"),
.package(url: "https://github.com/swiftlang/swift-syntax.git", "602.0.0"..<"604.0.0"),
.package(url: "https://github.com/swiftlang/swift-syntax.git", "603.0.0"..<"604.0.0"),
.package(url: "https://github.com/dfed/swift-testing-expectation.git", .upToNextMinor(from: "0.1.4")),
.package(url: "https://github.com/techprimate/TPPDF.git", from: "2.6.1"),
.package(url: "https://github.com/SchmiedmayerLab/zstd.git", exact: "1.5.8-beta.1")
Expand Down
12 changes: 11 additions & 1 deletion Sources/GroveAccountMacros/AccountKeyMacro.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ extension AccountKeyMacro: PeerMacro {
accountKeyProtocol = "RequiredAccountKey"
}

guard valueTypeInitializer.forceToText == valueTypeName.forceToText else {
guard valueTypeInitializer.canonicalTypeText == valueTypeName.canonicalTypeText else {
throw DiagnosticsError(
syntax: valueTypeName,
message: "Value type '\(valueTypeName)' is expected to match the property binding type annotation '\(valueTypeInitializer.forceToText)'",
Expand Down Expand Up @@ -374,6 +374,16 @@ extension SyntaxProtocol {
var forceToText: String {
String(decoding: syntaxTextBytes, as: UTF8.self)
}

/// The node's text reduced to its raw tokens, discarding all trivia.
///
/// Used to compare two type expressions that may be spelled with different whitespace or comments
/// (e.g. `ModuleA::GenderIdentity` vs `ModuleA :: GenderIdentity`) but denote the same type.
var canonicalTypeText: String {
tokens(viewMode: .sourceAccurate)
.map { $0.text }
.joined()
}
}


Expand Down
317 changes: 317 additions & 0 deletions Tests/GroveAccountMacrosTests/AccountKeyMacroTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -848,6 +848,323 @@ struct AccountKeyMacroTests {
failureHandler: { Issue.record("\($0.message)") }
)
}

@Test
func accountKeyModuleSelector() {
assertMacroExpansion(
"""
extension AccountDetails {
@AccountKey(
id: "genderIdentity",
name: "Gender Identity",
options: .mutable,
as: ModuleA::GenderIdentity.self,
initial: .empty(.preferNotToState)
)
var genderIdentity: ModuleA::GenderIdentity?
}
""",
expandedSource:
"""
extension AccountDetails {
var genderIdentity: ModuleA::GenderIdentity? {
get {
self[__Key_genderIdentity.self]
}
set {
self[__Key_genderIdentity.self] = newValue
}
}

struct __Key_genderIdentity: AccountKey {
typealias Value = ModuleA::GenderIdentity

static let name: LocalizedStringResource = "Gender Identity"
static let identifier: String = "genderIdentity"
static let category: AccountKeyCategory = .other
static var initialValue: InitialValue<Value> {
.empty(.preferNotToState)
}
static let options: AccountKeyOptions = .mutable
struct DataDisplay: DataDisplayView {
var body: some View {
fatalError("'\\("Gender Identity")' does not support display access.")
}

init(_ value: Value) {
fatalError("'\\("Gender Identity")' does not support display access.")
}
}
struct DataEntry: DataEntryView {
var body: some View {
fatalError("'\\("Gender Identity")' does not support display access.")
}

init(_ value: Binding<Value>) {
fatalError("'\\("Gender Identity")' does not support display access.")
}
}
}
}
""",
macroSpecs: testMacrosSpecs,
failureHandler: { Issue.record("\($0.message)") }
)
}

@Test
func accountKeyModuleSelectorRequired() {
assertMacroExpansion(
"""
extension AccountDetails {
@AccountKey(name: "Name", as: ModuleA::PersonName.self)
var name: ModuleA::PersonName
}
""",
expandedSource:
"""
extension AccountDetails {
var name: ModuleA::PersonName {
get {
self[__Key_name.self]
}
set {
self[__Key_name.self] = newValue
}
}

struct __Key_name: RequiredAccountKey {
typealias Value = ModuleA::PersonName

static let name: LocalizedStringResource = "Name"
static let identifier: String = "name"
static let category: AccountKeyCategory = .other
static let options: AccountKeyOptions = .default
}
}
""",
macroSpecs: testMacrosSpecs,
failureHandler: { Issue.record("\($0.message)") }
)
}

@Test
func accountKeyModuleSelectorNestedType() {
assertMacroExpansion(
"""
extension AccountDetails {
@AccountKey(name: "Preferred Workout Type", as: ModuleA::WorkoutType.ID.self)
var preferredWorkoutType: ModuleA::WorkoutType.ID?
}
""",
expandedSource:
"""
extension AccountDetails {
var preferredWorkoutType: ModuleA::WorkoutType.ID? {
get {
self[__Key_preferredWorkoutType.self]
}
set {
self[__Key_preferredWorkoutType.self] = newValue
}
}

struct __Key_preferredWorkoutType: AccountKey {
typealias Value = ModuleA::WorkoutType.ID

static let name: LocalizedStringResource = "Preferred Workout Type"
static let identifier: String = "preferredWorkoutType"
static let category: AccountKeyCategory = .other
static let options: AccountKeyOptions = .default
}
}
""",
macroSpecs: testMacrosSpecs,
failureHandler: { Issue.record("\($0.message)") }
)
}

@Test
func accountKeyModuleSelectorCustomUI() {
assertMacroExpansion(
"""
extension AccountDetails {
@AccountKey(
name: "Gender Identity",
as: ModuleA::GenderIdentity.self,
displayView: ModuleA::GenderIdentityDisplayUI.self,
entryView: ModuleA::GenderIdentityEntryUI.self
)
var genderIdentity: ModuleA::GenderIdentity?
}
""",
expandedSource:
"""
extension AccountDetails {
var genderIdentity: ModuleA::GenderIdentity? {
get {
self[__Key_genderIdentity.self]
}
set {
self[__Key_genderIdentity.self] = newValue
}
}

struct __Key_genderIdentity: AccountKey {
typealias Value = ModuleA::GenderIdentity

static let name: LocalizedStringResource = "Gender Identity"
static let identifier: String = "genderIdentity"
static let category: AccountKeyCategory = .other
static let options: AccountKeyOptions = .default
struct DataDisplay: SetupDisplayView {
typealias Value = ModuleA::GenderIdentity

private let value: Value?

var body: some View {
if let value {
ModuleA::GenderIdentityDisplayUI(value)
} else {
makeSetupView(for: ModuleA::GenderIdentityDisplayUI.self)
}
}

private func makeSetupView<T: DataDisplayView>(for type: T.Type) -> some View {
EmptyView()
}

private func makeSetupView<T: SetupDisplayView>(for type: T.Type) -> some View {
T(nil)
}

init(_ value: Value?) {
self.value = value
}
}
struct DataEntry: DataEntryView {
@Binding private var value: Value

var body: some View {
ModuleA::GenderIdentityEntryUI($value)
}

init(_ value: Binding<Value>) {
self._value = value
}
}
}
}
""",
macroSpecs: testMacrosSpecs,
failureHandler: { Issue.record("\($0.message)") }
)
}

/// The value type and the binding's type annotation are compared by their tokens, so differences in
/// whitespace between the two spellings must not be reported as a type mismatch.
@Test
func accountKeyTypeComparisonIgnoresTrivia() {
assertMacroExpansion(
"""
extension AccountDetails {
@AccountKey(name: "Gender Identity", as: ModuleA :: GenderIdentity.self)
var genderIdentity: ModuleA::GenderIdentity?
}
""",
expandedSource:
"""
extension AccountDetails {
var genderIdentity: ModuleA::GenderIdentity? {
get {
self[__Key_genderIdentity.self]
}
set {
self[__Key_genderIdentity.self] = newValue
}
}

struct __Key_genderIdentity: AccountKey {
typealias Value = ModuleA::GenderIdentity

static let name: LocalizedStringResource = "Gender Identity"
static let identifier: String = "genderIdentity"
static let category: AccountKeyCategory = .other
static let options: AccountKeyOptions = .default
}
}
""",
macroSpecs: testMacrosSpecs,
failureHandler: { Issue.record("\($0.message)") }
)

assertMacroExpansion(
"""
extension AccountDetails {
@AccountKey(name: "Preferred Workout Type", as: WorkoutType . ID.self)
var preferredWorkoutType: WorkoutType.ID?
}
""",
expandedSource:
"""
extension AccountDetails {
var preferredWorkoutType: WorkoutType.ID? {
get {
self[__Key_preferredWorkoutType.self]
}
set {
self[__Key_preferredWorkoutType.self] = newValue
}
}

struct __Key_preferredWorkoutType: AccountKey {
typealias Value = WorkoutType.ID

static let name: LocalizedStringResource = "Preferred Workout Type"
static let identifier: String = "preferredWorkoutType"
static let category: AccountKeyCategory = .other
static let options: AccountKeyOptions = .default
}
}
""",
macroSpecs: testMacrosSpecs,
failureHandler: { Issue.record("\($0.message)") }
)
}

@Test
func accountKeyModuleSelectorTypeMismatch() {
assertMacroExpansion(
"""
extension AccountDetails {
@AccountKey(name: "Gender Identity", as: ModuleA::GenderIdentity.self)
var genderIdentity: GenderIdentity?
}
""",
expandedSource:
"""
extension AccountDetails {
var genderIdentity: GenderIdentity? {
get {
self[__Key_genderIdentity.self]
}
set {
self[__Key_genderIdentity.self] = newValue
}
}
}
""",
diagnostics: [
DiagnosticSpec(
message: "Value type 'ModuleA::GenderIdentity' is expected to match the property binding type annotation 'GenderIdentity'",
line: 2,
column: 46
)
],
macroSpecs: testMacrosSpecs,
failureHandler: { Issue.record("\($0.message)") }
)
}
}

#endif