Skip to content
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

Added correct detection of conformance scopes when inside a public extension #132

Merged
merged 1 commit into from
Dec 13, 2024
Merged

Added correct detection of conformance scopes when inside a public extension #132

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
24 changes: 18 additions & 6 deletions Sources/VexilMacros/FlagContainerMacro.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,13 @@ extension FlagContainerMacro: MemberMacro {
providingMembersOf declaration: some DeclGroupSyntax,
in context: some MacroExpansionContext
) throws -> [DeclSyntax] {
try [
// If the declaration doesn't have any scopes attached we might be inheriting scopes from a public extension
var scopes = declaration.modifiers.scopeSyntax
if scopes.isEmpty, let parent = context.lexicalContext.first?.as(ExtensionDeclSyntax.self) {
scopes = parent.modifiers.scopeSyntax
}

return try [

// Properties

Expand All @@ -43,7 +49,7 @@ extension FlagContainerMacro: MemberMacro {
ExprSyntax("self._flagKeyPath = _flagKeyPath")
ExprSyntax("self._flagLookup = _flagLookup")
}
.with(\.modifiers, declaration.modifiers.scopeSyntax)
.with(\.modifiers, scopes)
),

]
Expand Down Expand Up @@ -79,10 +85,16 @@ extension FlagContainerMacro: ExtensionMacro {

// Check that conformance doesn't already exist, or that we are inside a unit test.
// The latter is a workaround for https://github.com/apple/swift-syntax/issues/2031
guard shouldGenerateConformance.flagContainer else {
guard shouldGenerateConformance.flagContainer else {
return []
}

// If the declaration doesn't have any scopes attached we might be inheriting scopes from a public extension
var scopes = declaration.modifiers.scopeSyntax
if scopes.isEmpty, let parent = context.lexicalContext.first?.as(ExtensionDeclSyntax.self) {
scopes = parent.modifiers.scopeSyntax
}

var decls = try [
ExtensionDeclSyntax(
extendedType: type,
Expand All @@ -102,7 +114,7 @@ extension FlagContainerMacro: ExtensionMacro {
}
"visitor.endContainer(keyPath: _flagKeyPath)"
}
.with(\.modifiers, declaration.modifiers.scopeSyntax)
.with(\.modifiers, scopes)

// Flag Key Paths

Expand Down Expand Up @@ -135,7 +147,7 @@ extension FlagContainerMacro: ExtensionMacro {
"[:]"
}
}
.with(\.modifiers, declaration.modifiers.scopeSyntax)
.with(\.modifiers, scopes)

},
]
Expand All @@ -161,7 +173,7 @@ extension FlagContainerMacro: ExtensionMacro {
ExprSyntax("lhs.\(lastBinding) == rhs.\(lastBinding)")
}
}
.with(\.modifiers, Array(declaration.modifiers.scopeSyntax) + [ DeclModifierSyntax(name: .keyword(.static)) ])
.with(\.modifiers, Array(scopes) + [ DeclModifierSyntax(name: .keyword(.static)) ])
}
},
]
Expand Down
78 changes: 78 additions & 0 deletions Tests/VexilMacroTests/EquatableFlagContainerMacroTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,84 @@ final class EquatableFlagContainerMacroTests: XCTestCase {
)
}

func testExpandsPublicExtension() throws {
assertMacroExpansion(
"""
public extension SomeContainer {
@FlagContainer
struct TestFlags {
@Flag(default: false, description: "Some Flag")
var someFlag: Bool
}
}
""",
expandedSource:
"""
public extension SomeContainer {
struct TestFlags {
var someFlag: Bool {
get {
_flagLookup.value(for: _flagKeyPath.append(.automatic("some-flag"))) ?? false
}
}

var $someFlag: FlagWigwag<Bool> {
FlagWigwag(
keyPath: _flagKeyPath.append(.automatic("some-flag")),
name: nil,
defaultValue: false,
description: "Some Flag",
displayOption: .default,
lookup: _flagLookup
)
}

fileprivate let _flagKeyPath: FlagKeyPath

fileprivate let _flagLookup: any FlagLookup

public init(_flagKeyPath: FlagKeyPath, _flagLookup: any FlagLookup) {
self._flagKeyPath = _flagKeyPath
self._flagLookup = _flagLookup
}
}
}

extension SomeContainer.TestFlags: FlagContainer {
public func walk(visitor: any FlagVisitor) {
visitor.beginContainer(keyPath: _flagKeyPath, containerType: SomeContainer.TestFlags.self)
visitor.visitFlag(
keyPath: _flagKeyPath.append(.automatic("some-flag")),
value: { [self] in
_flagLookup.value(for: _flagKeyPath.append(.automatic("some-flag")))
},
defaultValue: false,
wigwag: { [self] in
$someFlag
}
)
visitor.endContainer(keyPath: _flagKeyPath)
}
public var _allFlagKeyPaths: [PartialKeyPath<SomeContainer.TestFlags>: FlagKeyPath] {
[
\\SomeContainer.TestFlags.someFlag: _flagKeyPath.append(.automatic("some-flag")),
]
}
}

extension SomeContainer.TestFlags: Equatable {
public static func ==(lhs: SomeContainer.TestFlags, rhs: SomeContainer.TestFlags) -> Bool {
lhs.someFlag == rhs.someFlag
}
}
""",
macros: [
"FlagContainer": FlagContainerMacro.self,
"Flag": FlagMacro.self,
]
)
}

func testExpandsButAlreadyConforming() throws {
assertMacroExpansion(
"""
Expand Down
Loading