File: ConvertComputedPropertyToZeroParameterFunctionTests.swift

package info (click to toggle)
swiftlang 6.1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 2,791,532 kB
  • sloc: cpp: 9,901,743; ansic: 2,201,431; asm: 1,091,827; python: 308,252; objc: 82,166; f90: 80,126; lisp: 38,358; pascal: 25,559; sh: 20,429; ml: 5,058; perl: 4,745; makefile: 4,484; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (318 lines) | stat: -rw-r--r-- 8,235 bytes parent folder | download | duplicates (2)
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
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2024 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

import SwiftRefactor
import SwiftSyntax
import SwiftSyntaxBuilder
import XCTest
import _SwiftSyntaxTestSupport

final class ConvertComputedPropertyToZeroParameterFunctionTests: XCTestCase {
  func testRefactoringComputedPropertyToFunction() throws {
    let baseline: DeclSyntax = """
      var asJSON: String { "" }
      """

    let expected: DeclSyntax = """
      func asJSON() -> String { "" }
      """

    try assertRefactorConvert(baseline, expected: expected)
  }

  func testRefactoringComputedPropertyWithVoidToFunction() throws {
    let baseline: DeclSyntax = """
      var asJSON: Void { () }
      """

    let expected: DeclSyntax = """
      func asJSON() { () }
      """

    try assertRefactorConvert(baseline, expected: expected)
  }

  func testRefactoringComputedPropertyWithTupleToFunction() throws {
    let baseline: DeclSyntax = """
      var asJSON: (String, String) { ("", "") }
      """

    let expected: DeclSyntax = """
      func asJSON() -> (String, String) { ("", "") }
      """

    try assertRefactorConvert(baseline, expected: expected)
  }

  func testRefactoringComputedPropertyWithClosureToFunction() throws {
    let baseline: DeclSyntax = """
      var asJSON: () -> Void { {} }
      """

    let expected: DeclSyntax = """
      func asJSON() -> () -> Void { {} }
      """

    try assertRefactorConvert(baseline, expected: expected)
  }

  func testRefactoringComputedPropertyWithClosureToFunction2() throws {
    let baseline: DeclSyntax = """
      var asJSON: () -> () { {} }
      """

    let expected: DeclSyntax = """
      func asJSON() -> () -> () { {} }
      """

    try assertRefactorConvert(baseline, expected: expected)
  }

  func testRefactoringComputedPropertyWithVoidToFunctionWithSeparatingComment() throws {
    let baseline: DeclSyntax = """
      var  asJSON  :  /*comment*/ Void {  ()  }
      """

    let expected: DeclSyntax = """
      func  asJSON()    /*comment*/ {  ()  }
      """

    try assertRefactorConvert(baseline, expected: expected)
  }

  func testRefactoringComputedPropertyToFunctionWithReturnStmt() throws {
    let baseline: DeclSyntax = """
      var asJSON: String { return "" }
      """

    let expected: DeclSyntax = """
      func asJSON() -> String { return "" }
      """

    try assertRefactorConvert(baseline, expected: expected)
  }

  func testRefactoringComputedPropertyToFunctionWithModifiers() throws {
    let baseline: DeclSyntax = """
      static var  asJSON: String { "" }
      """

    let expected: DeclSyntax = """
      static func  asJSON() -> String { "" }
      """

    try assertRefactorConvert(baseline, expected: expected)
  }

  func testRefactoringComputedPropertyToFunctionWithMultipleStms() throws {
    let baseline: DeclSyntax = """
      var  asJSON: String {
        let builder = JSONBuilder()
        return builder.convert()
      }
      """

    let expected: DeclSyntax = """
      func  asJSON() -> String {
        let builder = JSONBuilder()
        return builder.convert()
      }
      """

    try assertRefactorConvert(baseline, expected: expected)
  }

  func testRefactoringComputedPropertyToFunctionWithCommentsAndIndentations() throws {
    let baseline: DeclSyntax = """
        static  var  asJSON  :  String  {  /*comment*/ ""  /*comment*/  }
      """

    let expected: DeclSyntax = """
        static  func  asJSON()   ->  String  {  /*comment*/ ""  /*comment*/  }
      """

    try assertRefactorConvert(baseline, expected: expected)
  }

  func testRefactoringComputedPropertyToFunctionWithComments() throws {
    let baseline: DeclSyntax = """
      // Comment
        public static  var  asJSON  :  String  { /*comment*/
        /*comment*/ return "String"
      // Some documentation
      } // Comment
      """

    let expected: DeclSyntax = """
      // Comment
        public static  func  asJSON()   ->  String  { /*comment*/
        /*comment*/ return "String"
      // Some documentation
      } // Comment
      """

    try assertRefactorConvert(baseline, expected: expected)
  }

  func testRefactoringComputedPropertyToNothing() throws {
    let baseline: DeclSyntax = """
      var x: Int {
          get { 5 }
          set { /*anything */ }
      }
      """
    try assertRefactorConvert(baseline, expected: nil)
  }

  func testRefactoringComputedPropertyWithGetAccessorToFunction() throws {
    let baseline: DeclSyntax = """
      var x: Int {
        get { 5 }
      }
      """

    let expected: DeclSyntax = """
      func x() -> Int {
        5
      }
      """

    try assertRefactorConvert(baseline, expected: expected)
  }

  func testRefactoringComputedPropertyWithGetAccessorAndAsyncEffectSpecifierToFunction() throws {
    let baseline: DeclSyntax = """
      var foo: Int {
        get async { await someAsyncValue() }
      }

      """

    let expected: DeclSyntax = """
      func foo() async -> Int {
        await someAsyncValue()
      }
      """

    try assertRefactorConvert(baseline, expected: expected)
  }

  func testRefactoringComputedPropertyWithGetAccessorAndThrowsEffectSpecifierToFunction() throws {
    let baseline: DeclSyntax = """
      var foo: Int {
        get throws { someAsyncValue() }
      }
      """

    let expected: DeclSyntax = """
      func foo() throws -> Int {
        someAsyncValue()
      }
      """

    try assertRefactorConvert(baseline, expected: expected)
  }

  func testRefactoringComputedPropertyWithGetAccessorAndAsyncThrowsEffectSpecifierToFunction() throws {
    let baseline: DeclSyntax = """
      var foo: Int {
        get async throws { someAsyncValue() }
      }
      """

    let expected: DeclSyntax = """
      func foo() async throws -> Int {
        someAsyncValue()
      }
      """

    try assertRefactorConvert(baseline, expected: expected)
  }

  func testRefactoringComputedPropertyWithLeadingTriviaInBindingToFunction() throws {
    let baseline: DeclSyntax = """
      /// Documented behavior
      var foo: Int { 0 }
      """

    let expected: DeclSyntax = """
      /// Documented behavior
      func foo() -> Int { 0 }
      """

    try assertRefactorConvert(baseline, expected: expected)
  }

  func testRefactoringComputedPropertyWithAccessorCommentsToFunction() throws {
    let baseline: DeclSyntax = """
      var foo: Int {
        get /*docs...*/ { 0 }
      }
      """

    let expected: DeclSyntax = """
      func foo() -> Int {
        /*docs...*/ 0
      }
      """

    try assertRefactorConvert(baseline, expected: expected)
  }

  func testRefactoringComputedPropertyWithCommentsInsideAccessorToFunction() throws {
    let baseline: DeclSyntax = """
      var foo: Int {
        get { /*docs*/ 0 /*documented*/ }
      }
      """

    let expected: DeclSyntax = """
      func foo() -> Int {
        /*docs*/ 0 /*documented*/
      }
      """

    try assertRefactorConvert(baseline, expected: expected)
  }

  func testRefactoringComputedPropertyWithAccessorMultipleCommentsToFunction() throws {
    let baseline: DeclSyntax = """
      var foo: Int { // Leading comments
        get /*docs...*/ { 0 } // docs
      /*Trailing Comments*/ }
      """

    let expected: DeclSyntax = """
      func foo() -> Int { // Leading comments
        /*docs...*/ 0 // docs
      /*Trailing Comments*/ }
      """

    try assertRefactorConvert(baseline, expected: expected)
  }
}

fileprivate func assertRefactorConvert(
  _ callDecl: DeclSyntax,
  expected: DeclSyntax?,
  file: StaticString = #filePath,
  line: UInt = #line
) throws {
  try assertRefactor(
    callDecl,
    context: (),
    provider: ConvertComputedPropertyToZeroParameterFunction.self,
    expected: expected,
    file: file,
    line: line
  )
}