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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
|
import _SwiftFormatTestSupport
@_spi(Rules) import SwiftFormat
final class UseSynthesizedInitializerTests: LintOrFormatRuleTestCase {
func testMemberwiseInitializerIsDiagnosed() {
assertLint(
UseSynthesizedInitializer.self,
"""
public struct Person {
public var name: String
let phoneNumber: String
internal let address: String
1️⃣init(name: String, phoneNumber: String, address: String) {
self.name = name
self.address = address
self.phoneNumber = phoneNumber
}
}
""",
findings: [
FindingSpec("1️⃣", message: "remove this explicit initializer, which is identical to the compiler-synthesized initializer"),
]
)
}
func testInternalMemberwiseInitializerIsDiagnosed() {
assertLint(
UseSynthesizedInitializer.self,
"""
public struct Person {
public var name: String
let phoneNumber: String
internal let address: String
1️⃣internal init(name: String, phoneNumber: String, address: String) {
self.name = name
self.address = address
self.phoneNumber = phoneNumber
}
}
""",
findings: [
FindingSpec("1️⃣", message: "remove this explicit initializer, which is identical to the compiler-synthesized initializer"),
]
)
}
func testMemberwiseInitializerWithDefaultArgumentIsDiagnosed() {
assertLint(
UseSynthesizedInitializer.self,
"""
public struct Person {
public var name: String = "John Doe"
let phoneNumber: String
internal let address: String
1️⃣init(name: String = "John Doe", phoneNumber: String, address: String) {
self.name = name
self.address = address
self.phoneNumber = phoneNumber
}
}
""",
findings: [
FindingSpec("1️⃣", message: "remove this explicit initializer, which is identical to the compiler-synthesized initializer"),
]
)
}
func testCustomInitializerVoidsSynthesizedInitializerWarning() {
// The compiler won't create a memberwise initializer when there are any other initializers.
// It's valid to have a memberwise initializer when there are any custom initializers.
assertLint(
UseSynthesizedInitializer.self,
"""
public struct Person {
public var name: String
let phoneNumber: String
private let address: String
init(name: String, phoneNumber: String, address: String) {
self.name = name
self.address = address
self.phoneNumber = phoneNumber
}
init(name: String, address: String) {
self.name = name
self.phoneNumber = "1234578910"
self.address = address
}
}
""",
findings: []
)
}
func testMemberwiseInitializerWithDefaultArgument() {
assertLint(
UseSynthesizedInitializer.self,
"""
public struct Person {
public var name: String
let phoneNumber: String
let address: String
init(name: String = "Jane Doe", phoneNumber: String, address: String) {
self.name = name
self.address = address
self.phoneNumber = phoneNumber
}
}
""",
findings: []
)
}
func testMemberwiseInitializerWithNonMatchingDefaultValues() {
assertLint(
UseSynthesizedInitializer.self,
"""
public struct Person {
public var name: String = "John Doe"
let phoneNumber: String
let address: String
init(name: String = "Jane Doe", phoneNumber: String, address: String) {
self.name = name
self.address = address
self.phoneNumber = phoneNumber
}
}
""",
findings: []
)
}
func testMemberwiseInitializerMissingDefaultValues() {
// When the initializer doesn't contain a matching default argument, then it isn't equivalent to
// the synthesized memberwise initializer.
assertLint(
UseSynthesizedInitializer.self,
"""
public struct Person {
public var name: String
var phoneNumber: String = "+15555550101"
let address: String
init(name: String, phoneNumber: String, address: String) {
self.name = name
self.address = address
self.phoneNumber = phoneNumber
}
}
""",
findings: []
)
}
func testCustomInitializerWithMismatchedTypes() {
assertLint(
UseSynthesizedInitializer.self,
"""
public struct Person {
public var name: String
var phoneNumber: String?
let address: String
init(name: String, phoneNumber: String, address: String) {
self.name = name
self.address = address
self.phoneNumber = phoneNumber
}
}
""",
findings: []
)
}
func testCustomInitializerWithExtraParameters() {
assertLint(
UseSynthesizedInitializer.self,
"""
public struct Person {
public var name: String
var phoneNumber: String?
let address: String
init(name: String, phoneNumber: String?, address: String, anotherArg: Int) {
self.name = name
self.address = address
self.phoneNumber = phoneNumber
}
}
""",
findings: []
)
}
func testCustomInitializerWithExtraStatements() {
assertLint(
UseSynthesizedInitializer.self,
#"""
public struct Person {
public var name: String
var phoneNumber: String?
let address: String
init(name: String, phoneNumber: String?, address: String) {
self.name = name
self.address = address
self.phoneNumber = phoneNumber
print("phoneNumber: \(self.phoneNumber)")
}
}
"""#,
findings: []
)
}
func testFailableMemberwiseInitializerIsNotDiagnosed() {
assertLint(
UseSynthesizedInitializer.self,
"""
public struct Person {
public var name: String
let phoneNumber: String
let address: String
init?(name: String, phoneNumber: String, address: String) {
self.name = name
self.address = address
self.phoneNumber = phoneNumber
}
}
""",
findings: []
)
}
func testThrowingMemberwiseInitializerIsNotDiagnosed() {
assertLint(
UseSynthesizedInitializer.self,
"""
public struct Person {
public var name: String
let phoneNumber: String
let address: String
init(name: String, phoneNumber: String, address: String) throws {
self.name = name
self.address = address
self.phoneNumber = phoneNumber
}
}
""",
findings: []
)
}
func testPublicMemberwiseInitializerIsNotDiagnosed() {
assertLint(
UseSynthesizedInitializer.self,
"""
public struct Person {
public var name: String
let phoneNumber: String
let address: String
public init(name: String, phoneNumber: String, address: String) {
self.name = name
self.address = address
self.phoneNumber = phoneNumber
}
}
""",
findings: []
)
}
func testDefaultMemberwiseInitializerIsNotDiagnosed() {
// The synthesized initializer is private when any member is private, so an initializer with
// default access control (i.e. internal) is not equivalent to the synthesized initializer.
assertLint(
UseSynthesizedInitializer.self,
"""
public struct Person {
let phoneNumber: String
private let address: String
init(phoneNumber: String, address: String) {
self.address = address
self.phoneNumber = phoneNumber
}
}
""",
findings: []
)
}
func testPrivateMemberwiseInitializerWithPrivateMemberIsDiagnosed() {
// The synthesized initializer is private when any member is private, so a private initializer
// is equivalent to the synthesized initializer.
assertLint(
UseSynthesizedInitializer.self,
"""
public struct Person {
let phoneNumber: String
private let address: String
1️⃣private init(phoneNumber: String, address: String) {
self.address = address
self.phoneNumber = phoneNumber
}
}
""",
findings: [
FindingSpec("1️⃣", message: "remove this explicit initializer, which is identical to the compiler-synthesized initializer"),
]
)
}
func testFileprivateMemberwiseInitializerWithFileprivateMemberIsDiagnosed() {
// The synthesized initializer is fileprivate when any member is fileprivate, so a fileprivate
// initializer is equivalent to the synthesized initializer.
assertLint(
UseSynthesizedInitializer.self,
"""
public struct Person {
let phoneNumber: String
fileprivate let address: String
1️⃣fileprivate init(phoneNumber: String, address: String) {
self.address = address
self.phoneNumber = phoneNumber
}
}
""",
findings: [
FindingSpec("1️⃣", message: "remove this explicit initializer, which is identical to the compiler-synthesized initializer"),
]
)
}
func testCustomSetterAccessLevel() {
// When a property has a different access level for its setter, the setter's access level
// doesn't change the access level of the synthesized initializer.
assertLint(
UseSynthesizedInitializer.self,
"""
public struct Person {
let phoneNumber: String
private(set) let address: String
1️⃣init(phoneNumber: String, address: String) {
self.address = address
self.phoneNumber = phoneNumber
}
}
public struct Person2 {
fileprivate let phoneNumber: String
private(set) let address: String
2️⃣fileprivate init(phoneNumber: String, address: String) {
self.address = address
self.phoneNumber = phoneNumber
}
}
public struct Person3 {
fileprivate(set) let phoneNumber: String
private(set) let address: String
3️⃣init(phoneNumber: String, address: String) {
self.address = address
self.phoneNumber = phoneNumber
}
}
public struct Person4 {
private fileprivate(set) let phoneNumber: String
private(set) let address: String
init(phoneNumber: String, address: String) {
self.address = address
self.phoneNumber = phoneNumber
}
}
""",
findings: [
FindingSpec("1️⃣", message: "remove this explicit initializer, which is identical to the compiler-synthesized initializer"),
FindingSpec("2️⃣", message: "remove this explicit initializer, which is identical to the compiler-synthesized initializer"),
FindingSpec("3️⃣", message: "remove this explicit initializer, which is identical to the compiler-synthesized initializer"),
]
)
}
func testMemberwiseInitializerWithAttributeIsNotDiagnosed() {
assertLint(
UseSynthesizedInitializer.self,
"""
public struct Person {
let phoneNumber: String
let address: String
@inlinable init(phoneNumber: String, address: String) {
self.address = address
self.phoneNumber = phoneNumber
}
}
""",
findings: []
)
}
}
|
