Skip to content

Commit 9546f4e

Browse files
jmewesjmewes
committed
GH-153: Upgrade linter version
Due to version dependencies in the used plugins, we'll need to upgrade the Kotlin version to 1.4.20 and Gradle to version 6. This this the currently used linter version doesn't work anymore: ``` $ ./gradlew formatKotlin lintKotlin Starting a Gradle Daemon, 2 incompatible and 5 stopped Daemons could not be reused, use --status for details > Task :restdocs-api-spec:formatKotlinMain FAILED FAILURE: Build failed with an exception. * What went wrong: Execution failed for task ':restdocs-api-spec:formatKotlinMain'. > There was a failure while executing work items > A failure occurred while executing org.jmailen.gradle.kotlinter.tasks.format.FormatWorkerRunnable > org/jetbrains/kotlin/lexer/KtTokens.FUN_KEYWORD * Try: Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights. ``` After application of the auto fix after the version upgrade, there will be a lot of changed lines. That's why this is coming as a separate pull request.
1 parent e4e3751 commit 9546f4e

File tree

39 files changed

+1287
-1156
lines changed

39 files changed

+1287
-1156
lines changed

‎build.gradle.kts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ plugins {
1515
id("pl.allegro.tech.build.axion-release") version "1.9.2"
1616
jacoco
1717
`maven-publish`
18-
id("org.jmailen.kotlinter") version "1.25.2" apply false
18+
id("org.jmailen.kotlinter") version "3.3.0" apply false
1919
id("com.github.kt3k.coveralls") version "2.8.2"
2020
id("com.jfrog.bintray") version "1.8.4" apply false
2121
}

‎restdocs-api-spec-gradle-plugin/src/main/kotlin/com/epages/restdocs/apispec/gradle/PostmanExtension.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ open class PostmanExtension(project: Project) : ApiSpecExtension(project) {
1414
companion object {
1515
const val name = "postman"
1616
}
17-
}
17+
}

‎restdocs-api-spec-gradle-plugin/src/main/kotlin/com/epages/restdocs/apispec/gradle/PostmanTask.kt‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ open class PostmanTask : ApiSpecTask() {
2525

2626
override fun generateSpecification(resourceModels: List<ResourceModel>): String =
2727
jacksonObjectMapper().enable(SerializationFeature.INDENT_OUTPUT).writeValueAsString(
28-
PostmanCollectionGenerator.generate(
29-
resources = resourceModels,
30-
title = title,
31-
version = apiVersion,
32-
baseUrl = baseUrl
33-
)
28+
PostmanCollectionGenerator.generate(
29+
resources = resourceModels,
30+
title = title,
31+
version = apiVersion,
32+
baseUrl = baseUrl
33+
)
3434
)
3535

3636
fun applyExtension(extension: PostmanExtension) {
@@ -39,4 +39,4 @@ open class PostmanTask : ApiSpecTask() {
3939
apiVersion = extension.version
4040
baseUrl = extension.baseUrl
4141
}
42-
}
42+
}

‎restdocs-api-spec-gradle-plugin/src/test/kotlin/com/epages/restdocs/apispec/gradle/ApiSpecTaskTest.kt‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -63,33 +63,33 @@ abstract class ApiSpecTaskTest {
6363
private fun Path.initializeGradleProperties() {
6464
// jacoco agent configuration
6565
resolve("gradle.properties").toFile()
66-
.writeText(File("build/testkit/testkit-gradle.properties").readText())
66+
.writeText(File("build/testkit/testkit-gradle.properties").readText())
6767
}
6868

6969
protected fun whenPluginExecuted() {
7070
result = GradleRunner.create()
71-
.withProjectDir(testProjectDir.toFile())
72-
.withArguments("--info", "--stacktrace", taskName)
73-
.withPluginClasspath()
74-
.withDebug(true)
75-
.build()
71+
.withProjectDir(testProjectDir.toFile())
72+
.withArguments("--info", "--stacktrace", taskName)
73+
.withPluginClasspath()
74+
.withDebug(true)
75+
.build()
7676
}
7777

7878
protected fun outputFileContext(): DocumentContext =
79-
JsonPath.parse(outputFolder.resolve("$outputFileNamePrefix.$format").readText().also { println(it) })
79+
JsonPath.parse(outputFolder.resolve("$outputFileNamePrefix.$format").readText().also { println(it) })
8080

8181
fun baseBuildFile() = """
8282
plugins {
8383
id 'java'
8484
id 'com.epages.restdocs-api-spec'
8585
}
8686
87-
""".trimIndent()
87+
""".trimIndent()
8888

8989
protected fun givenResourceSnippet() {
9090
val operationDir = File(snippetsFolder, "some-operation").apply { mkdir() }
9191
File(operationDir, "resource.json").writeText(
92-
"""
92+
"""
9393
{
9494
"operationId" : "product-get",
9595
"summary" : null,
@@ -125,7 +125,7 @@ abstract class ApiSpecTaskTest {
125125
protected fun givenPrivateResourceSnippet() {
126126
val operationDir = File(snippetsFolder, "some-private-operation").apply { mkdir() }
127127
File(operationDir, "resource.json").writeText(
128-
"""
128+
"""
129129
{
130130
"operationId" : "product-get-some",
131131
"summary" : null,
@@ -176,13 +176,15 @@ abstract class ApiSpecTaskTest {
176176

177177
protected fun thenExpectedFileFound(expectedFile: String) {
178178
BDDAssertions.then(outputFolder.resolve(expectedFile))
179-
.describedAs("Output file not found '$expectedFile' - output dir contains ${Files.list(outputFolder.toPath()).map {
179+
.describedAs(
180+
"Output file not found '$expectedFile' - output dir contains ${Files.list(outputFolder.toPath()).map {
180181
it.toFile().path
181-
}.toList()}")
182-
.exists()
182+
}.toList()}"
183+
)
184+
.exists()
183185
}
184186

185187
protected fun givenBuildFileWithoutApiSpecClosure() {
186188
buildFile.writeText(baseBuildFile())
187189
}
188-
}
190+
}

‎restdocs-api-spec-gradle-plugin/src/test/kotlin/com/epages/restdocs/apispec/gradle/PostmanTaskTest.kt‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,14 +64,16 @@ class PostmanTaskTest : ApiSpecTaskTest() {
6464
}
6565

6666
private fun givenBuildFileWithPostmanClosure() {
67-
buildFile.writeText(baseBuildFile() + """
67+
buildFile.writeText(
68+
baseBuildFile() + """
6869
postman {
6970
title = '$title'
7071
version = '$version'
7172
baseUrl = '$baseUrl'
7273
separatePublicApi = $separatePublicApi
7374
outputFileNamePrefix = '$outputFileNamePrefix'
7475
}
75-
""".trimIndent())
76+
""".trimIndent()
77+
)
7678
}
77-
}
79+
}

‎restdocs-api-spec-gradle-plugin/src/test/kotlin/com/epages/restdocs/apispec/gradle/RestdocsOpenApi3TaskTest.kt‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,8 @@ class RestdocsOpenApi3TaskTest : RestdocsOpenApiTaskTestBase() {
6363
}
6464

6565
override fun givenBuildFileWithOpenApiClosure() {
66-
givenBuildFileWithOpenApiClosure("servers",
66+
givenBuildFileWithOpenApiClosure(
67+
"servers",
6768
"""[ {
6869
url = 'http://some.api/api/{id}'
6970
variables = [
@@ -87,11 +88,13 @@ class RestdocsOpenApi3TaskTest : RestdocsOpenApiTaskTestBase() {
8788
]
8889
]
8990
}
90-
]""".trimMargin())
91+
]""".trimMargin()
92+
)
9193
}
9294

9395
private fun givenBuildFileWithOpenApiClosure(serverConfigurationFieldName: String, serversSection: String) {
94-
buildFile.writeText(baseBuildFile() + """
96+
buildFile.writeText(
97+
baseBuildFile() + """
9598
openapi3 {
9699
$serverConfigurationFieldName = $serversSection
97100
title = '$title'
@@ -100,11 +103,13 @@ class RestdocsOpenApi3TaskTest : RestdocsOpenApiTaskTestBase() {
100103
separatePublicApi = $separatePublicApi
101104
outputFileNamePrefix = '$outputFileNamePrefix'
102105
}
103-
""".trimIndent())
106+
""".trimIndent()
107+
)
104108
}
105109

106110
override fun givenBuildFileWithOpenApiClosureAndSecurityDefinitions() {
107-
buildFile.writeText(baseBuildFile() + """
111+
buildFile.writeText(
112+
baseBuildFile() + """
108113
openapi3 {
109114
servers = [ { url = "http://some.api" } ]
110115
title = '$title'
@@ -121,7 +126,8 @@ class RestdocsOpenApi3TaskTest : RestdocsOpenApiTaskTestBase() {
121126
scopeDescriptionsPropertiesFile = "scopeDescriptions.yaml"
122127
}
123128
}
124-
""".trimIndent())
129+
""".trimIndent()
130+
)
125131
}
126132

127133
override fun thenSecurityDefinitionsFoundInOutputFile() {

‎restdocs-api-spec-gradle-plugin/src/test/kotlin/com/epages/restdocs/apispec/gradle/RestdocsOpenApiTaskTest.kt‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ class RestdocsOpenApiTaskTest : RestdocsOpenApiTaskTestBase() {
1111
override val taskName = "openapi"
1212

1313
override fun givenBuildFileWithOpenApiClosure() {
14-
buildFile.writeText(baseBuildFile() + """
14+
buildFile.writeText(
15+
baseBuildFile() + """
1516
openapi {
1617
host = '$host'
1718
basePath = '$basePath'
@@ -24,11 +25,13 @@ class RestdocsOpenApiTaskTest : RestdocsOpenApiTaskTestBase() {
2425
separatePublicApi = $separatePublicApi
2526
outputFileNamePrefix = '$outputFileNamePrefix'
2627
}
27-
""".trimIndent())
28+
""".trimIndent()
29+
)
2830
}
2931

3032
override fun givenBuildFileWithOpenApiClosureAndSecurityDefinitions() {
31-
buildFile.writeText(baseBuildFile() + """
33+
buildFile.writeText(
34+
baseBuildFile() + """
3235
openapi {
3336
host = '$host'
3437
basePath = '$basePath'
@@ -45,7 +48,8 @@ class RestdocsOpenApiTaskTest : RestdocsOpenApiTaskTestBase() {
4548
scopeDescriptionsPropertiesFile = "scopeDescriptions.yaml"
4649
}
4750
}
48-
""".trimIndent())
51+
""".trimIndent()
52+
)
4953
}
5054

5155
override fun thenSecurityDefinitionsFoundInOutputFile() {

‎restdocs-api-spec-gradle-plugin/src/test/kotlin/com/epages/restdocs/apispec/gradle/RestdocsOpenApiTaskTestBase.kt‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,17 +71,17 @@ abstract class RestdocsOpenApiTaskTestBase : ApiSpecTaskTest() {
7171

7272
private fun givenScopeTextFile() {
7373
testProjectDir.resolve("scopeDescriptions.yaml").toFile().writeText(
74-
"""
74+
"""
7575
"prod:r": "Some text"
76-
""".trimIndent()
77-
)
76+
""".trimIndent()
77+
)
7878
}
7979
private fun givenTagsTextFile() {
8080
testProjectDir.resolve("tagDescriptions.yaml").toFile().writeText(
81-
"""
81+
"""
8282
"tag1": "tag1 description"
8383
"tag2": "tag2 description"
84-
""".trimIndent()
84+
""".trimIndent()
8585
)
8686
}
8787

‎restdocs-api-spec-jsonschema/src/main/kotlin/com/epages/restdocs/apispec/jsonschema/ConstraintResolver.kt‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,11 @@ internal object ConstraintResolver {
2525
internal fun minLengthString(fieldDescriptor: FieldDescriptor): Int? {
2626
return findConstraints(fieldDescriptor)
2727
.firstOrNull { constraint ->
28-
(NOT_EMPTY_CONSTRAINTS.contains(constraint.name) ||
29-
NOT_BLANK_CONSTRAINTS.contains(constraint.name) ||
30-
LENGTH_CONSTRAINT == constraint.name)
28+
(
29+
NOT_EMPTY_CONSTRAINTS.contains(constraint.name) ||
30+
NOT_BLANK_CONSTRAINTS.contains(constraint.name) ||
31+
LENGTH_CONSTRAINT == constraint.name
32+
)
3133
}
3234
?.let { constraint -> if (LENGTH_CONSTRAINT == constraint.name) constraint.configuration["min"] as Int else 1 }
3335
}

‎restdocs-api-spec-jsonschema/src/main/kotlin/com/epages/restdocs/apispec/jsonschema/JsonSchemaFromFieldDescriptorsGenerator.kt‎

Lines changed: 34 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ import org.everit.json.schema.ArraySchema
1111
import org.everit.json.schema.BooleanSchema
1212
import org.everit.json.schema.CombinedSchema
1313
import org.everit.json.schema.EmptySchema
14+
import org.everit.json.schema.EnumSchema
1415
import org.everit.json.schema.NullSchema
1516
import org.everit.json.schema.NumberSchema
1617
import org.everit.json.schema.ObjectSchema
17-
import org.everit.json.schema.EnumSchema
1818
import org.everit.json.schema.Schema
1919
import org.everit.json.schema.StringSchema
2020
import org.everit.json.schema.internal.JSONPrinter
@@ -46,11 +46,12 @@ class JsonSchemaFromFieldDescriptorsGenerator {
4646
it
4747
)
4848
}
49-
.foldRight(listOf()) { fieldDescriptor, groups -> groups
50-
.firstOrNull { it.equalsOnPathAndType(fieldDescriptor) }
51-
?.let { groups } // omit the descriptor it is considered equal and can be omitted
52-
?: groups.firstOrNull { it.path == fieldDescriptor.path }
53-
?.let { groups - it + it.merge(fieldDescriptor) } // merge the type with the descriptor with the same name
49+
.foldRight(listOf()) { fieldDescriptor, groups ->
50+
groups
51+
.firstOrNull { it.equalsOnPathAndType(fieldDescriptor) }
52+
?.let { groups } // omit the descriptor it is considered equal and can be omitted
53+
?: groups.firstOrNull { it.path == fieldDescriptor.path }
54+
?.let { groups - it + it.merge(fieldDescriptor) } // merge the type with the descriptor with the same name
5455
?: groups + fieldDescriptor // it is new just add it
5556
}
5657
}
@@ -140,7 +141,8 @@ class JsonSchemaFromFieldDescriptorsGenerator {
140141
) {
141142
traversedSegments.add(remainingSegments[0])
142143
builder.addPropertySchema(
143-
propertyName, ArraySchema.builder()
144+
propertyName,
145+
ArraySchema.builder()
144146
.allItemSchema(traverse(traversedSegments, fields, ObjectSchema.builder()))
145147
.description(propertyField?.fieldDescriptor?.description)
146148
.build()
@@ -150,8 +152,10 @@ class JsonSchemaFromFieldDescriptorsGenerator {
150152
builder.addRequiredProperty(propertyName)
151153
}
152154
builder.addPropertySchema(
153-
propertyName, traverse(
154-
traversedSegments, fields, ObjectSchema.builder()
155+
propertyName,
156+
traverse(
157+
traversedSegments, fields,
158+
ObjectSchema.builder()
155159
.description(propertyField?.fieldDescriptor?.description) as ObjectSchema.Builder
156160
)
157161
)
@@ -167,8 +171,10 @@ class JsonSchemaFromFieldDescriptorsGenerator {
167171
builder.addRequiredProperty(propertyName)
168172
}
169173
if (propertyName == "[]") {
170-
builder.addPropertySchema(propertyName,
171-
createSchemaWithArrayContent(ObjectSchema.builder().build(), depthOfArrayPath(fieldDescriptor.path)))
174+
builder.addPropertySchema(
175+
propertyName,
176+
createSchemaWithArrayContent(ObjectSchema.builder().build(), depthOfArrayPath(fieldDescriptor.path))
177+
)
172178
} else {
173179
builder.addPropertySchema(propertyName, fieldDescriptor.jsonSchemaType())
174180
}
@@ -233,30 +239,35 @@ class JsonSchemaFromFieldDescriptorsGenerator {
233239
"null" -> NullSchema.builder()
234240
"empty" -> EmptySchema.builder()
235241
"object" -> ObjectSchema.builder()
236-
"array" -> ArraySchema.builder().allItemSchema(CombinedSchema.oneOf(
242+
"array" -> ArraySchema.builder().allItemSchema(
243+
CombinedSchema.oneOf(
237244
listOf(
238-
ObjectSchema.builder().build(),
239-
BooleanSchema.builder().build(),
240-
StringSchema.builder().build(),
241-
NumberSchema.builder().build()
245+
ObjectSchema.builder().build(),
246+
BooleanSchema.builder().build(),
247+
StringSchema.builder().build(),
248+
NumberSchema.builder().build()
242249
)
243-
).build())
250+
).build()
251+
)
244252
"boolean" -> BooleanSchema.builder()
245253
"number" -> NumberSchema.builder()
246254
"string" -> StringSchema.builder()
247255
.minLength(minLengthString(this))
248256
.maxLength(maxLengthString(this))
249257
"enum" -> CombinedSchema.oneOf(
250-
listOf(
251-
StringSchema.builder().build(),
252-
EnumSchema.builder().possibleValues(this.attributes.enumValues).build())
253-
).isSynthetic(true)
258+
listOf(
259+
StringSchema.builder().build(),
260+
EnumSchema.builder().possibleValues(this.attributes.enumValues).build()
261+
)
262+
).isSynthetic(true)
254263
else -> throw IllegalArgumentException("unknown field type $type")
255264
}
256265

257266
fun equalsOnPathAndType(f: FieldDescriptorWithSchemaType): Boolean =
258-
(this.path == f.path &&
259-
this.type == f.type)
267+
(
268+
this.path == f.path &&
269+
this.type == f.type
270+
)
260271

261272
companion object {
262273
fun fromFieldDescriptor(fieldDescriptor: FieldDescriptor) =

0 commit comments

Comments
 (0)