Skip to content

Transform nested structs in UseEnumForNamespacing. #138

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.

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

Merged
merged 1 commit into from
Feb 3, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 15 additions & 5 deletions Sources/SwiftFormatRules/UseEnumForNamespacing.swift
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,18 @@ import SwiftSyntax
public final class UseEnumForNamespacing: SyntaxFormatRule {

public override func visit(_ node: StructDeclSyntax) -> DeclSyntax {
let rewrittenMembers = node.members.members.compactMap {
super.visit($0).as(MemberDeclListItemSyntax.self)
}
guard rewrittenMembers.count == node.members.members.count else {
// No members should be deleted - exit early instead of breaking the source.
return DeclSyntax(node)
}
let rewrittenMemberDeclList = SyntaxFactory.makeMemberDeclList(rewrittenMembers)
guard node.genericParameterClause == nil, node.inheritanceClause == nil,
let memberDecls = membersToKeepIfUsedAsNamespace(node.members.members)
let memberDecls = membersToKeepIfUsedAsNamespace(rewrittenMemberDeclList)
else {
return DeclSyntax(node)
return DeclSyntax(node.withMembers(node.members.withMembers(rewrittenMemberDeclList)))
}

diagnose(.convertToEnum(kind: "struct", name: node.identifier), on: node)
Expand Down Expand Up @@ -76,9 +84,11 @@ public final class UseEnumForNamespacing: SyntaxFormatRule {
// Do not append private initializer.

case .ifConfigDecl(let decl):
let membersToKeep: [MemberDeclListSyntax] = decl.clauses
.compactMap { clause in
(clause.elements.as(MemberDeclListSyntax.self)).flatMap(membersToKeepIfUsedAsNamespace(_:))
// Note that the child nodes have already been rewritten, so any nested structs that should
// become enums have already been transformed.
let membersToKeep: [MemberDeclListSyntax] =
decl.clauses.compactMap {
($0.elements.as(MemberDeclListSyntax.self)).flatMap(membersToKeepIfUsedAsNamespace(_:))
}

if membersToKeep.count < decl.clauses.count {
Expand Down
1 change: 1 addition & 0 deletions Tests/SwiftFormatPrettyPrintTests/XCTestManifests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ extension ClosureExprTests {
("testClosureArgumentsWithTrailingClosure", testClosureArgumentsWithTrailingClosure),
("testClosureCapture", testClosureCapture),
("testClosureCaptureWithoutArguments", testClosureCaptureWithoutArguments),
("testClosureOutputGrouping", testClosureOutputGrouping),
("testClosuresWithIfs", testClosuresWithIfs),
("testClosureVariables", testClosureVariables),
("testTrailingClosure", testTrailingClosure),
Expand Down
61 changes: 61 additions & 0 deletions Tests/SwiftFormatRulesTests/UseEnumForNamespacingTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -164,4 +164,65 @@ public class UseEnumForNamespacingTests: DiagnosingTestCase {
}
""")
}

public func testNestedEnumsForNameSpaces() {
XCTAssertFormatting(
UseEnumForNamespacing.self,
input: """
struct A {
static func fooA() {}
struct B {
static func fooB() {}
}
}
struct C {
func fooC() {}
struct D {
static func fooB() {}
}
}
struct E {
static func fooE() {}
struct F {
func fooF() {}
}
}
struct G {
func fooG() {}
#if useH
struct H {
static func fooH() {}
}
#endif
}
""",
expected: """
enum A {
static func fooA() {}
enum B {
static func fooB() {}
}
}
struct C {
func fooC() {}
enum D {
static func fooB() {}
}
}
enum E {
static func fooE() {}
struct F {
func fooF() {}
}
}
struct G {
func fooG() {}
#if useH
enum H {
static func fooH() {}
}
#endif
}
""")
}
}
1 change: 1 addition & 0 deletions Tests/SwiftFormatRulesTests/XCTestManifests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,7 @@ extension UseEnumForNamespacingTests {
// `swift test --generate-linuxmain`
// to regenerate.
static let __allTests__UseEnumForNamespacingTests = [
("testNestedEnumsForNameSpaces", testNestedEnumsForNameSpaces),
("testNonEnumsUsedAsNamespaces", testNonEnumsUsedAsNamespaces),
]
}
Expand Down