CodableKit/Tests/EncodableKitTests/CodableMacroTests+hooks.swift at 4a08b171209cc13e6b66e0e7c6c8c556fc68993d · WendellXY/CodableKit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
//
//  CodableMacroTests+hooks.swift
//  CodableKit
//
//  Created by AI on 2025/10/02.
//

import SwiftSyntax
import SwiftSyntaxBuilder
import SwiftSyntaxMacros
import SwiftSyntaxMacrosTestSupport
import Testing

@Suite struct EncodableHooksExpansionTests {
  @Test func classWillAndDidEncodeHooksIncludedWhenPresent() throws {
    assertMacro(
      """
      @Encodable
      public class User {
        let id: UUID
        let name: String
        let age: Int

        @CodableHook(.willEncode)
        func prepare() throws {}

        @CodableHook(.didEncode)
        func finish() throws {}
      }
      """,
      expandedSource: """
        public class User {
          let id: UUID
          let name: String
          let age: Int

          @CodableHook(.willEncode)
          func prepare() throws {}

          @CodableHook(.didEncode)
          func finish() throws {}

          public func encode(to encoder: any Encoder) throws {
            try prepare()
            var container = encoder.container(keyedBy: CodingKeys.self)
            try container.encode(id, forKey: .id)
            try container.encode(name, forKey: .name)
            try container.encode(age, forKey: .age)
            try finish()
          }
        }

        extension User: Encodable {
          enum CodingKeys: String, CodingKey {
            case id
            case name
            case age
          }
        }
        """
    )
  }

  @Test func conventionalWillAndDidEncodeWithoutAnnotationsParameterless() throws {
    assertMacro(
      """
      @Encodable
      public class User {
        let id: UUID
        let name: String
        let age: Int

        func willEncode() throws {}
        func didEncode() throws {}
      }
      """,
      expandedSource: """
        public class User {
          let id: UUID
          let name: String
          let age: Int

          func willEncode() throws {}
          func didEncode() throws {}

          public func encode(to encoder: any Encoder) throws {
            var container = encoder.container(keyedBy: CodingKeys.self)
            try container.encode(id, forKey: .id)
            try container.encode(name, forKey: .name)
            try container.encode(age, forKey: .age)
          }
        }

        extension User: Encodable {
          enum CodingKeys: String, CodingKey {
            case id
            case name
            case age
          }
        }
        """
      ,
      diagnostics: [
        .init(
          message: "Hook method 'willEncode' will not be invoked unless annotated with @CodableHook(.willEncode)",
          line: 1,
          column: 1,
          severity: .error
        ),
        .init(
          message: "Hook method 'didEncode' will not be invoked unless annotated with @CodableHook(.didEncode)",
          line: 1,
          column: 1,
          severity: .error
        ),
      ]
    )
  }
}