Merge pull request #20 from SimplyDanny/attirbutes-on-top

Add option to place attributes on top of declarations

README.md

@@ -105,12 +105,13 @@ Download `swift-testing-revolutionary.artifactbundle.zip` from [Releases](https:
 
 You can pass some options to the command.  
 
-| Option                             | Description                                                  | Default |
-|------------------------------------|--------------------------------------------------------------|---------|
-| --dry-run                          | Run as a dry run mode. All test files are not overwritten    |         |
-| --enable/disable-struct-conversion | Whether converting test classes to structs or not            | Enabled |
-| --enable/disable-strip-test-prefix | Whether stripping `test` prefix from each test method or not | Enabled |
-| --enable/disable-adding-suite      | Whether adding `@Suite` annotation to each test class or not | Enabled |
+| Option                                   | Description                                                                       | Default |
+|------------------------------------------|-----------------------------------------------------------------------------------|---------|
+| --dry-run                                | Run as a dry run mode. All test files are not overwritten                         |         |
+| --enable/disable-struct-conversion       | Whether converting test classes to structs or not                                 | Enabled |
+| --enable/disable-strip-test-prefix       | Whether stripping `test` prefix from each test method or not                      | Enabled |
+| --enable/disable-adding-suite            | Whether adding `@Suite` annotation to each test class or not                      | Enabled |
+| --enable/disable-attributes-on-same-line | Whether attributes are placed on the same line as the declaration or on top of it | Enabled |
 
 ### Struct Conversion
 

Sources/RevolutionKit/GlobalOptions.swift

@@ -14,6 +14,9 @@ package struct GlobalOptions: Sendable {
     /// Whether to add `@Suite` to each test class
     var enableAddingSuite: Bool
 
+    /// Whether to put attributes on the same line as the declaration or on top of it
+    var attributesOnSameLine: Bool
+
     package enum BackUpMode {
         case disabled
         case enabled(URL)
@@ -23,12 +26,14 @@ package struct GlobalOptions: Sendable {
         isDryRunMode: Bool = false,
         enableStructConversion: Bool = true,
         enableStrippingTestPrefix: Bool = true,
-        enableAddingSuite: Bool = true
+        enableAddingSuite: Bool = true,
+        attributesOnSameLine: Bool = true
     ) {
         self.isDryRunMode = isDryRunMode
         self.enableStructConversion = enableStructConversion
         self.enableStrippingTestPrefix = enableStrippingTestPrefix
         self.enableAddingSuite = enableAddingSuite
+        self.attributesOnSameLine = attributesOnSameLine
     }
 }
 

Sources/RevolutionKit/Rewriter/XCTestRewriter+ClassVisitor.swift

@@ -14,7 +14,7 @@ extension XCTestRewriter {
                 attributeName: IdentifierTypeSyntax(
                     name: .identifier("Suite")
                 ),
-                trailingTrivia: .space
+                trailingTrivia: globalOptions.attributesOnSameLine ? .space : .newlines(1)
             )
 
             let newAttributes = {

Sources/RevolutionKit/Rewriter/XCTestRewriter+MethodVisitor.swift

@@ -35,15 +35,14 @@ extension XCTestRewriter {
             attributeName: IdentifierTypeSyntax(
                 name: .identifier("Test")
             ),
-            trailingTrivia: .space
+            trailingTrivia: globalOptions.attributesOnSameLine ? .space : .newlines(1)
         )
 
         let attributes = {
             var attributes = node.attributes
             attributes.insert(.attribute(testMacroAttribute), at: attributes.startIndex)
             return attributes
                 .with(\.leadingTrivia, node.leadingTrivia)
-                .with(\.trailingTrivia, .space)
         }()
 
         let newSigniture = node

Sources/swift-testing-revolutionary/Command.swift

@@ -19,6 +19,11 @@ struct SwiftTestingRevolutionaryCommand: AsyncParsableCommand {
     @Flag(inversion: .prefixedEnableDisable, help: "Whether adding `@Suite` to each test class")
     var addingSuite: Bool = true
 
+    @Flag(inversion: .prefixedEnableDisable, help: """
+        Whether to put attributes on the same line as the declaration or on top of it
+        """)
+    var attributesOnSameLine: Bool = true
+
     func run() async throws {
         let options = buildRunnerOptions()
 
@@ -33,7 +38,8 @@ struct SwiftTestingRevolutionaryCommand: AsyncParsableCommand {
             isDryRunMode: dryRun,
             enableStructConversion: structConversion,
             enableStrippingTestPrefix: stripTestPrefix,
-            enableAddingSuite: addingSuite
+            enableAddingSuite: addingSuite,
+            attributesOnSameLine: attributesOnSameLine
         )
     }
 }

Tests/RevolutionKitTests/TestMethodsTests.swift

@@ -184,6 +184,33 @@ private let tearDownConversionFixtures: [ConversionTestFixture] = [
     },
 ]
 
+private let attributesOnTopOfDeclaration: [ConversionTestFixture] = [
+    Fixture {
+        """
+        func testExample() {
+        }
+        """
+        """
+        @Test
+        func example() {
+        }
+        """
+    },
+    Fixture {
+        """
+        @ExistingAttribute
+        func testExample() {
+        }
+        """
+        """
+        @Test
+        @ExistingAttribute
+        func example() {
+        }
+        """
+    },
+]
+
 @Suite struct TestMethodsTests {
     private let emitter = StringEmitter()
 
@@ -210,4 +237,12 @@ private let tearDownConversionFixtures: [ConversionTestFixture] = [
         let result = try runner.run(for: fixture.source, emitter: StringEmitter())
         #expect(result == fixture.expected, sourceLocation: fixture.sourceLocation)
     }
+
+    @Test("TestMethodsRewriter can put attributes on top of declaration", arguments: attributesOnTopOfDeclaration)
+    private func rewriteTestCasesWithAttributesOnTopOfDeclaration(_ fixture: ConversionTestFixture) async throws {
+        let runner = Runner(globalOptions: .init(attributesOnSameLine: false))
+
+        let result = try runner.run(for: fixture.source, emitter: StringEmitter())
+        #expect(result == fixture.expected, sourceLocation: fixture.sourceLocation)
+    }
 }

Tests/RevolutionKitTests/TestSuiteClassTests.swift

@@ -131,6 +131,33 @@ private let structConversionFixturesWithoutSuite: [ConversionTestFixture] = [
     },
 ]
 
+private let attributesOnTopOfDeclaration: [ConversionTestFixture] = [
+    Fixture {
+        """
+        class HogeTests: XCTestCase {
+        }
+        """
+        """
+        @Suite
+        struct HogeTests {
+        }
+        """
+    },
+    Fixture {
+        """
+        @ExistingAttribute
+        class HogeTests: XCTestCase {
+        }
+        """
+        """
+        @Suite
+        @ExistingAttribute
+        struct HogeTests {
+        }
+        """
+    },
+]
+
 @Suite struct TestSuiteClassTests {
     private let emitter = StringEmitter()
 
@@ -157,4 +184,12 @@ private let structConversionFixturesWithoutSuite: [ConversionTestFixture] = [
         let result = try runner.run(for: fixture.source, emitter: StringEmitter())
         #expect(result == fixture.expected, sourceLocation: fixture.sourceLocation)
     }
+
+    @Test("TestClassRewriter can put attributes on top of the declaration", arguments: attributesOnTopOfDeclaration)
+    private func rewriterCanPutAttributesOnTopOfDeclaration(_ fixture: ConversionTestFixture) async throws {
+        let runner = Runner(globalOptions: .init(attributesOnSameLine: false))
+
+        let result = try runner.run(for: fixture.source, emitter: StringEmitter())
+        #expect(result == fixture.expected, sourceLocation: fixture.sourceLocation)
+    }
 }