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
|
package com.pinterest.ktlint.ruleset.standard.rules
import com.pinterest.ktlint.test.KtLintAssertThat.Companion.assertThatRule
import com.pinterest.ktlint.test.LintViolation
import org.junit.jupiter.api.Nested
import org.junit.jupiter.api.Test
import org.junit.jupiter.params.ParameterizedTest
import org.junit.jupiter.params.provider.ValueSource
@Suppress("RemoveCurlyBracesFromTemplate")
class SpacingAroundOperatorsRuleTest {
private val spacingAroundOperatorsRuleAssertThat = assertThatRule { SpacingAroundOperatorsRule() }
@ParameterizedTest(name = "Operator: {0}")
@ValueSource(
strings = [
"+",
"-",
"/",
"*",
"<",
"<=",
">",
">=",
"==",
"===",
"!=",
"!==",
],
)
fun `Given a simple operator`(operator: String) {
val code =
"""
val foo1 = 1${operator}2
val foo2 = 1${operator} 2
val foo3 = 1 ${operator}2
val foo4 = 1 ${operator} 2
""".trimIndent()
val formattedCode =
"""
val foo1 = 1 ${operator} 2
val foo2 = 1 ${operator} 2
val foo3 = 1 ${operator} 2
val foo4 = 1 ${operator} 2
""".trimIndent()
spacingAroundOperatorsRuleAssertThat(code)
.hasLintViolations(
LintViolation(1, 13, "Missing spacing around \"${operator}\""),
LintViolation(2, 13, "Missing spacing before \"${operator}\""),
LintViolation(3, 14 + operator.length, "Missing spacing after \"${operator}\""),
).isFormattedAs(formattedCode)
}
@ParameterizedTest(name = "Operator: {0}")
@ValueSource(
strings = [
"+",
"++",
"-",
"--",
"!",
],
)
fun `Given a unary prefix operator`(operator: String) {
val code =
"""
val foo = ${operator}1
""".trimIndent()
spacingAroundOperatorsRuleAssertThat(code).hasNoLintViolations()
}
@ParameterizedTest(name = "Operator: {0}")
@ValueSource(
strings = [
"++",
"--",
],
)
fun `Given a unary postfix operator`(operator: String) {
val code =
"""
val foo = 1${operator}
""".trimIndent()
spacingAroundOperatorsRuleAssertThat(code).hasNoLintViolations()
}
@Test
fun `Given a unary operator`() {
val code =
"""
val foo1 = +1
val foo2 = -1
""".trimIndent()
spacingAroundOperatorsRuleAssertThat(code).hasNoLintViolations()
}
@Test
fun `Given the in operator`() {
val code =
"""
var x = 1 in 3..4
""".trimIndent()
spacingAroundOperatorsRuleAssertThat(code).hasNoLintViolations()
}
@Test
fun `Given a function with default parameter value`() {
val code =
"""
fun foo1(a=true)
fun foo2(a= true)
fun foo3(a =true)
fun foo4(a = true)
""".trimIndent()
val formattedCode =
"""
fun foo1(a = true)
fun foo2(a = true)
fun foo3(a = true)
fun foo4(a = true)
""".trimIndent()
spacingAroundOperatorsRuleAssertThat(code)
.hasLintViolations(
LintViolation(1, 11, "Missing spacing around \"=\""),
LintViolation(2, 11, "Missing spacing before \"=\""),
LintViolation(3, 13, "Missing spacing after \"=\""),
).isFormattedAs(formattedCode)
}
@Test
fun `Given some generic type then do not handle angle brackets as comparator operator`() {
val code =
"""
val foo = fn(arrayOfNulls<Any>(0))
""".trimIndent()
spacingAroundOperatorsRuleAssertThat(code).hasNoLintViolations()
}
@Test
fun `Given some assignment operators missing spaces around the operator`() {
val code =
"""
val foo1="foo"
val foo2= "foo"
val foo3 ="foo"
val foo4 = "foo"
""".trimIndent()
val formattedCode =
"""
val foo1 = "foo"
val foo2 = "foo"
val foo3 = "foo"
val foo4 = "foo"
""".trimIndent()
spacingAroundOperatorsRuleAssertThat(code)
.hasLintViolations(
LintViolation(1, 9, "Missing spacing around \"=\""),
LintViolation(2, 9, "Missing spacing before \"=\""),
LintViolation(3, 11, "Missing spacing after \"=\""),
).isFormattedAs(formattedCode)
}
@Nested
inner class `Given an augmented assignment operator` {
@Test
fun `Given some augmented assignment operators missing spaces around the operator`() {
val code =
"""
fun main() {
var i = 1
i+=1
i-=1
i/=1
i*=1
}
""".trimIndent()
val formattedCode =
"""
fun main() {
var i = 1
i += 1
i -= 1
i /= 1
i *= 1
}
""".trimIndent()
spacingAroundOperatorsRuleAssertThat(code)
.hasLintViolations(
LintViolation(3, 6, "Missing spacing around \"+=\""),
LintViolation(4, 6, "Missing spacing around \"-=\""),
LintViolation(5, 6, "Missing spacing around \"/=\""),
LintViolation(6, 6, "Missing spacing around \"*=\""),
).isFormattedAs(formattedCode)
}
@Test
fun `Given some augmented assignment operators missing spaces before the operator`() {
val code =
"""
fun main() {
var i = 1
i+= 1
i-= 1
i/= 1
i*= 1
}
""".trimIndent()
val formattedCode =
"""
fun main() {
var i = 1
i += 1
i -= 1
i /= 1
i *= 1
}
""".trimIndent()
spacingAroundOperatorsRuleAssertThat(code)
.hasLintViolations(
LintViolation(3, 6, "Missing spacing before \"+=\""),
LintViolation(4, 6, "Missing spacing before \"-=\""),
LintViolation(5, 6, "Missing spacing before \"/=\""),
LintViolation(6, 6, "Missing spacing before \"*=\""),
).isFormattedAs(formattedCode)
}
@Test
fun `Given some augmented assignment operators missing spaces after the operator`() {
val code =
"""
fun main() {
var i = 1
i +=1
i -=1
i /=1
i *=1
}
""".trimIndent()
val formattedCode =
"""
fun main() {
var i = 1
i += 1
i -= 1
i /= 1
i *= 1
}
""".trimIndent()
spacingAroundOperatorsRuleAssertThat(code)
.hasLintViolations(
LintViolation(3, 9, "Missing spacing after \"+=\""),
LintViolation(4, 9, "Missing spacing after \"-=\""),
LintViolation(5, 9, "Missing spacing after \"/=\""),
LintViolation(6, 9, "Missing spacing after \"*=\""),
).isFormattedAs(formattedCode)
}
}
@Test
fun `Given a wildcard import then do no require spacing around the wildcard`() {
val code =
"""
import a.b.*
""".trimIndent()
spacingAroundOperatorsRuleAssertThat(code).hasNoLintViolations()
}
@Test
fun `Given a spread operator as function parameter value then do no require spacing around the spread operator`() {
val code =
"""
fun main() {
call(*v)
call(1, *v, 2)
}
""".trimIndent()
spacingAroundOperatorsRuleAssertThat(code).hasNoLintViolations()
}
@Test
fun `Given a type argument list, containing a wildcard type then do not require space around the wildcard`() {
val code =
"""
val foo = Map<PropertyType<*>>
""".trimIndent()
spacingAroundOperatorsRuleAssertThat(code).hasNoLintViolations()
}
@Test
fun `Given a custom DSL`() {
val code =
"""
fun foo() {
every { foo() }returns(bar)andThen(baz)
every { foo() }returns (bar)andThen (baz)
every { foo() } returns(bar) andThen(baz)
}
""".trimIndent()
val formattedCode =
"""
fun foo() {
every { foo() } returns (bar) andThen (baz)
every { foo() } returns (bar) andThen (baz)
every { foo() } returns (bar) andThen (baz)
}
""".trimIndent()
spacingAroundOperatorsRuleAssertThat(code)
.hasLintViolations(
LintViolation(2, 20, "Missing spacing around \"returns\""),
LintViolation(2, 32, "Missing spacing around \"andThen\""),
LintViolation(3, 20, "Missing spacing before \"returns\""),
LintViolation(3, 33, "Missing spacing before \"andThen\""),
LintViolation(4, 28, "Missing spacing after \"returns\""),
LintViolation(4, 41, "Missing spacing after \"andThen\""),
).isFormattedAs(formattedCode)
}
}
|
