File: NoAccessLevelOnExtensionDeclarationTests.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (347 lines) | stat: -rw-r--r-- 12,139 bytes parent folder | download
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
import _SwiftFormatTestSupport

@_spi(Rules) import SwiftFormat

final class NoAccessLevelOnExtensionDeclarationTests: LintOrFormatRuleTestCase {
  func testExtensionDeclarationAccessLevel() {
    assertFormatting(
      NoAccessLevelOnExtensionDeclaration.self,
      input: """
        1️⃣public extension Foo {
          2️⃣var x: Bool
          // Comment 1
          internal var y: Bool
          // Comment 2
          3️⃣static var z: Bool
          // Comment 3
          4️⃣static func someFunc() {}
          5️⃣init() {}
          6️⃣subscript(index: Int) -> Element {}
          7️⃣class SomeClass {}
          8️⃣struct SomeStruct {}
          9️⃣enum SomeEnum {}
          🔟typealias Foo = Bar
        }
        """,
      expected: """
        extension Foo {
          public var x: Bool
          // Comment 1
          internal var y: Bool
          // Comment 2
          public static var z: Bool
          // Comment 3
          public static func someFunc() {}
          public init() {}
          public subscript(index: Int) -> Element {}
          public class SomeClass {}
          public struct SomeStruct {}
          public enum SomeEnum {}
          public typealias Foo = Bar
        }
        """,
      findings: [
        FindingSpec(
          "1️⃣",
          message: "move this 'public' access modifier to precede each member inside this extension",
          notes: [
            NoteSpec("2️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("3️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("4️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("5️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("6️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("7️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("8️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("9️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("🔟", message: "add 'public' access modifier to this declaration"),
          ]
        ),
      ]
    )
  }

  func testRemoveRedundantInternal() {
    assertFormatting(
      NoAccessLevelOnExtensionDeclaration.self,
      input: """
        1️⃣internal extension Bar {
          var a: Int
          var b: Int
        }
        """,
      expected: """
        extension Bar {
          var a: Int
          var b: Int
        }
        """,
      findings: [
        FindingSpec("1️⃣", message: "remove this redundant 'internal' access modifier from this extension"),
      ]
    )
  }

  func testPreservesCommentOnRemovedModifier() {
    assertFormatting(
      NoAccessLevelOnExtensionDeclaration.self,
      input: """
        /// This doc comment should stick around.
        1️⃣public extension Foo {
          3️⃣func f() {}
          // This should not change.
          4️⃣func g() {}
        }

        /// So should this one.
        2️⃣internal extension Foo {
          func f() {}
          // This should not change.
          func g() {}
        }
        """,
      expected: """
        /// This doc comment should stick around.
        extension Foo {
          public func f() {}
          // This should not change.
          public func g() {}
        }

        /// So should this one.
        extension Foo {
          func f() {}
          // This should not change.
          func g() {}
        }
        """,
      findings: [
        FindingSpec(
          "1️⃣",
          message: "move this 'public' access modifier to precede each member inside this extension",
          notes: [
            NoteSpec("3️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("4️⃣", message: "add 'public' access modifier to this declaration"),
          ]
        ),
        FindingSpec("2️⃣", message: "remove this redundant 'internal' access modifier from this extension"),
      ]
    )
  }

  func testPackageAccessLevel() {
    assertFormatting(
      NoAccessLevelOnExtensionDeclaration.self,
      input: """
        1️⃣package extension Foo {
          2️⃣func f() {}
        }
        """,
      expected: """
        extension Foo {
          package func f() {}
        }
        """,
      findings: [
        FindingSpec(
          "1️⃣",
          message: "move this 'package' access modifier to precede each member inside this extension",
          notes: [
            NoteSpec("2️⃣", message: "add 'package' access modifier to this declaration"),
          ]
        ),
      ]
    )
  }

  func testPrivateIsEffectivelyFileprivate() {
    assertFormatting(
      NoAccessLevelOnExtensionDeclaration.self,
      input: """
        1️⃣private extension Foo {
          2️⃣func f() {}
        }
        """,
      expected: """
        extension Foo {
          fileprivate func f() {}
        }
        """,
      findings: [
        FindingSpec(
          "1️⃣",
          message: "remove this 'private' access modifier and declare each member inside this extension as 'fileprivate'",
          notes: [
            NoteSpec("2️⃣", message: "add 'fileprivate' access modifier to this declaration"),
          ]
        ),
      ]
    )
  }

  func testExtensionWithAnnotation() {
    assertFormatting(
      NoAccessLevelOnExtensionDeclaration.self,
      input: """
        /// This extension has a comment.
        @objc 1️⃣public extension Foo {
        }
        """,
      expected: """
        /// This extension has a comment.
        @objc extension Foo {
        }
        """,
      findings: [
        FindingSpec("1️⃣", message: "move this 'public' access modifier to precede each member inside this extension"),
      ]
    )
  }

  func testPreservesInlineAnnotationsBeforeAddedAccessLevelModifiers() {
    assertFormatting(
      NoAccessLevelOnExtensionDeclaration.self,
      input: """
        /// This extension has a comment.
        1️⃣public extension Foo {
          /// This property has a doc comment.
          2️⃣@objc var x: Bool { get { return true }}
          // This property has a developer comment.
          3️⃣@objc static var z: Bool { get { return false }}
          /// This static function has a doc comment.
          4️⃣@objc static func someStaticFunc() {}
          5️⃣@objc init(with foo: Foo) {}
          6️⃣@objc func someOtherFunc() {}
          7️⃣@objc class SomeClass : NSObject {}
          8️⃣@objc typealias SomeType = SomeOtherType
          9️⃣@objc enum SomeEnum : Int {
            case SomeInt = 32
          }
        }
        """,
      expected: """
        /// This extension has a comment.
        extension Foo {
          /// This property has a doc comment.
          @objc public var x: Bool { get { return true }}
          // This property has a developer comment.
          @objc public static var z: Bool { get { return false }}
          /// This static function has a doc comment.
          @objc public static func someStaticFunc() {}
          @objc public init(with foo: Foo) {}
          @objc public func someOtherFunc() {}
          @objc public class SomeClass : NSObject {}
          @objc public typealias SomeType = SomeOtherType
          @objc public enum SomeEnum : Int {
            case SomeInt = 32
          }
        }
        """,
      findings: [
        FindingSpec(
          "1️⃣",
          message: "move this 'public' access modifier to precede each member inside this extension",
          notes: [
            NoteSpec("2️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("3️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("4️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("5️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("6️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("7️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("8️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("9️⃣", message: "add 'public' access modifier to this declaration"),
          ]
        ),
      ]
    )
  }

  func testPreservesMultiLineAnnotationsBeforeAddedAccessLevelModifiers() {
    assertFormatting(
      NoAccessLevelOnExtensionDeclaration.self,
      input: """
        /// This extension has a comment.
        1️⃣public extension Foo {
          /// This property has a doc comment.
          2️⃣@available(iOS 13, *)
          var x: Bool { get { return true }}
          // This property has a developer comment.
          3️⃣@available(iOS 13, *)
          static var z: Bool { get { return false }}
          // This static function has a developer comment.
          4️⃣@objc(someStaticFunction)
          static func someStaticFunc() {}
          5️⃣@objc(initWithFoo:)
          init(with foo: Foo) {}
          6️⃣@objc
          func someOtherFunc() {}
          7️⃣@objc
          class SomeClass : NSObject {}
          8️⃣@available(iOS 13, *)
          typealias SomeType = SomeOtherType
          9️⃣@objc
          enum SomeEnum : Int {
            case SomeInt = 32
          }

          // This is a doc comment for a multi-argument method.
          @objc(
            doSomethingThatIsVeryComplicatedWithThisFoo:
            forGoodMeasureUsingThisBar:
            andApplyingThisBaz:
          )
          public func doSomething(_ foo : Foo, bar : Bar, baz : Baz) {}
        }
        """,
      expected: """
        /// This extension has a comment.
        extension Foo {
          /// This property has a doc comment.
          @available(iOS 13, *)
          public var x: Bool { get { return true }}
          // This property has a developer comment.
          @available(iOS 13, *)
          public static var z: Bool { get { return false }}
          // This static function has a developer comment.
          @objc(someStaticFunction)
          public static func someStaticFunc() {}
          @objc(initWithFoo:)
          public init(with foo: Foo) {}
          @objc
          public func someOtherFunc() {}
          @objc
          public class SomeClass : NSObject {}
          @available(iOS 13, *)
          public typealias SomeType = SomeOtherType
          @objc
          public enum SomeEnum : Int {
            case SomeInt = 32
          }

          // This is a doc comment for a multi-argument method.
          @objc(
            doSomethingThatIsVeryComplicatedWithThisFoo:
            forGoodMeasureUsingThisBar:
            andApplyingThisBaz:
          )
          public func doSomething(_ foo : Foo, bar : Bar, baz : Baz) {}
        }
        """,
      findings: [
        FindingSpec(
          "1️⃣",
          message: "move this 'public' access modifier to precede each member inside this extension",
          notes: [
            NoteSpec("2️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("3️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("4️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("5️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("6️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("7️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("8️⃣", message: "add 'public' access modifier to this declaration"),
            NoteSpec("9️⃣", message: "add 'public' access modifier to this declaration"),
          ]
        ),
      ]
    )
  }
}