CodableKit/Tests/CodableKitTests/CodableMacroTests+class_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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
//
//  CodableMacroTests+class_hooks.swift
//  CodableKit
//
//  Created by AI on 2025/10/02.
//

import SwiftSyntax
import SwiftSyntaxBuilder
import SwiftSyntaxMacros
import SwiftSyntaxMacrosTestSupport
import Testing

@Suite struct CodableHooksExpansionTestsForClass {
  @Test func combinedAnnotatedHooksRunInOrder() throws {
    assertMacro(
      """
      @Codable
      public class User {
        let id: UUID
        let name: String

        @CodableHook(.willDecode)
        class func preA() throws {}
        @CodableHook(.willDecode)
        static func preB(from decoder: any Decoder) throws {}

        @CodableHook(.didDecode)
        func postA() throws {}
        @CodableHook(.didDecode)
        func postB(from decoder: any Decoder) throws {}

        @CodableHook(.willEncode)
        func start() throws {}
        @CodableHook(.willEncode)
        func ready(to encoder: any Encoder) throws {}

        @CodableHook(.didEncode)
        func finish() throws {}
        @CodableHook(.didEncode)
        func end(to encoder: any Encoder) throws {}
      }
      """,
      expandedSource: """
        public class User {
          let id: UUID
          let name: String

          @CodableHook(.willDecode)
          class func preA() throws {}
          @CodableHook(.willDecode)
          static func preB(from decoder: any Decoder) throws {}

          @CodableHook(.didDecode)
          func postA() throws {}
          @CodableHook(.didDecode)
          func postB(from decoder: any Decoder) throws {}

          @CodableHook(.willEncode)
          func start() throws {}
          @CodableHook(.willEncode)
          func ready(to encoder: any Encoder) throws {}

          @CodableHook(.didEncode)
          func finish() throws {}
          @CodableHook(.didEncode)
          func end(to encoder: any Encoder) throws {}

          public required init(from decoder: any Decoder) throws {
            try Self.preA()
            try Self.preB(from: decoder)
            let container = try decoder.container(keyedBy: CodingKeys.self)
            id = try container.decode(UUID.self, forKey: .id)
            name = try container.decode(String.self, forKey: .name)
            try postA()
            try postB(from: decoder)
          }

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

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

  @Test func annotatedOverridesConventionalForClass() throws {
    assertMacro(
      """
      @Codable
      public class User {
        let id: UUID
        let name: String

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

        @CodableHook(.willEncode)
        func start() throws {}
        @CodableHook(.didEncode)
        func finish() throws {}
        @CodableHook(.didDecode)
        func post() throws {}
      }
      """,
      expandedSource: """
        public class User {
          let id: UUID
          let name: String

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

          @CodableHook(.willEncode)
          func start() throws {}
          @CodableHook(.didEncode)
          func finish() throws {}
          @CodableHook(.didDecode)
          func post() throws {}

          public required init(from decoder: any Decoder) throws {
            let container = try decoder.container(keyedBy: CodingKeys.self)
            id = try container.decode(UUID.self, forKey: .id)
            name = try container.decode(String.self, forKey: .name)
            try post()
          }

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

        extension User: Codable {
          enum CodingKeys: String, CodingKey {
            case id
            case name
          }
        }
        """
      ,
      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
        ),
        .init(
          message: "Hook method 'didDecode' will not be invoked unless annotated with @CodableHook(.didDecode)",
          line: 1,
          column: 1,
          severity: .error
        ),
      ]
    )
  }
}