Skip to content

Commit 43bebec

Browse files
committed
better name
1 parent 1125f2d commit 43bebec

File tree

10 files changed

+21
-40
lines changed

10 files changed

+21
-40
lines changed
Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,10 @@ package io.openapiprocessor.core.writer.java
77

88
import io.openapiprocessor.core.model.Endpoint
99
import io.openapiprocessor.core.model.EndpointResponse
10-
import java.io.Writer
1110

1211
/**
13-
* mapping annotation writer interface.
12+
* mapping annotation factory.
1413
*/
15-
// TODO rename to factory
16-
interface MappingAnnotationWriter {
17-
@Deprecated("remove, use create()")
18-
fun write (target: Writer, endpoint: Endpoint, endpointResponse: EndpointResponse)
19-
14+
interface MappingAnnotationFactory {
2015
fun create(endpoint: Endpoint, endpointResponse: EndpointResponse): List<String>
2116
}

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/MethodWriter.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import io.openapiprocessor.core.support.LF
1818
import io.openapiprocessor.core.support.capitalizeFirstChar
1919
import io.openapiprocessor.core.support.indent
2020
import io.openapiprocessor.core.writer.Identifier
21-
import io.openapiprocessor.core.writer.java.MappingAnnotationWriter as CoreMappingAnnotationWriter
21+
import io.openapiprocessor.core.writer.java.MappingAnnotationFactory as CoreMappingAnnotationFactory
2222
import io.openapiprocessor.core.writer.java.ParameterAnnotationWriter as CoreParameterAnnotationWriter
2323
import io.openapiprocessor.core.writer.java.StatusAnnotationWriter as CoreStatusAnnotationWriter
2424
import java.io.StringWriter
@@ -31,7 +31,7 @@ open class MethodWriter(
3131
private val apiOptions: ApiOptions,
3232
private val identifier: Identifier,
3333
private val statusAnnotationWriter: CoreStatusAnnotationWriter,
34-
private val mappingAnnotationWriter: CoreMappingAnnotationWriter,
34+
private val mappingAnnotationFactory: CoreMappingAnnotationFactory,
3535
private val parameterAnnotationWriter: CoreParameterAnnotationWriter,
3636
private val beanValidationFactory: BeanValidationFactory,
3737
private val javadocFactory: JavaDocFactory = JavaDocFactory(identifier)
@@ -113,7 +113,7 @@ open class MethodWriter(
113113
}
114114

115115
private fun createMappingAnnotations(endpoint: Endpoint, endpointResponse: EndpointResponse): List<String> {
116-
return mappingAnnotationWriter.create(endpoint, endpointResponse)
116+
return mappingAnnotationFactory.create(endpoint, endpointResponse)
117117
}
118118

119119
private fun createResult(endpoint: Endpoint, endpointResponse: EndpointResponse): String {

openapi-processor-core/src/test/groovy/io/openapiprocessor/core/converter/ApiConverterGSpec.groovy

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ paths:
128128
options,
129129
identifier,
130130
Stub(StatusAnnotationWriter),
131-
Stub (MappingAnnotationWriter),
131+
Stub (MappingAnnotationFactory),
132132
Stub (ParameterAnnotationWriter),
133133
Stub (BeanValidationFactory),
134134
Stub (JavaDocFactory)),

openapi-processor-core/src/test/groovy/io/openapiprocessor/core/writer/java/MethodWriterGSpec.groovy

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
package io.openapiprocessor.core.writer.java
77

8-
import io.openapiprocessor.core.support.TestMappingAnnotationWriter
8+
import io.openapiprocessor.core.support.TestMappingAnnotationFactory
99
import io.openapiprocessor.core.converter.ApiOptions
1010
import io.openapiprocessor.core.converter.mapping.SimpleParameterValue
1111
import io.openapiprocessor.core.parser.HttpMethod
@@ -28,7 +28,7 @@ class MethodWriterGSpec extends Specification {
2828
apiOptions,
2929
identifier,
3030
new TestStatusAnnotationWriter(),
31-
new TestMappingAnnotationWriter(),
31+
new TestMappingAnnotationFactory(),
3232
new TestParameterAnnotationWriter(),
3333
Stub (BeanValidationFactory),
3434
Stub (JavaDocFactory))
@@ -181,7 +181,7 @@ class MethodWriterGSpec extends Specification {
181181
apiOptions,
182182
identifier,
183183
new TestStatusAnnotationWriter(),
184-
new TestMappingAnnotationWriter(),
184+
new TestMappingAnnotationFactory(),
185185
Stub (ParameterAnnotationWriter) {},
186186
Stub (BeanValidationFactory),
187187
Stub (JavaDocFactory))
Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,9 @@ package io.openapiprocessor.core.support
77

88
import io.openapiprocessor.core.model.Endpoint
99
import io.openapiprocessor.core.model.EndpointResponse
10-
import io.openapiprocessor.core.writer.java.MappingAnnotationWriter
11-
import java.io.Writer
10+
import io.openapiprocessor.core.writer.java.MappingAnnotationFactory
1211

13-
// todo rename to Factory
14-
class TestMappingAnnotationWriter: MappingAnnotationWriter {
15-
16-
@Deprecated("remove, use create()")
17-
override fun write(target: Writer, endpoint: Endpoint, endpointResponse: EndpointResponse) {
18-
target.write ("@CoreMapping")
19-
}
12+
class TestMappingAnnotationFactory: MappingAnnotationFactory {
2013

2114
override fun create(endpoint: Endpoint, endpointResponse: EndpointResponse): List<String> {
2215
return listOf("@CoreMapping")

openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/writer/java/MethodWriterAnnotationSpec.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import io.openapiprocessor.core.model.datatypes.MappedDataType
1515
import io.openapiprocessor.core.model.datatypes.ObjectDataType
1616
import io.openapiprocessor.core.model.parameters.ParameterBase
1717
import io.openapiprocessor.core.support.TestStatusAnnotationWriter
18-
import io.openapiprocessor.core.support.TestMappingAnnotationWriter
18+
import io.openapiprocessor.core.support.TestMappingAnnotationFactory
1919
import io.openapiprocessor.core.support.TestParameterAnnotationWriter
2020
import io.openapiprocessor.core.support.parseOptions
2121
import java.io.StringWriter
@@ -28,7 +28,7 @@ class MethodWriterAnnotationSpec: StringSpec ({
2828
options,
2929
JavaIdentifier(),
3030
TestStatusAnnotationWriter(),
31-
TestMappingAnnotationWriter(),
31+
TestMappingAnnotationFactory(),
3232
TestParameterAnnotationWriter(),
3333
BeanValidationFactory(options)
3434
)

openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/writer/java/MethodWriterResponseStyleSpec.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import io.openapiprocessor.core.model.datatypes.ResultDataType
1515
import io.openapiprocessor.core.model.datatypes.StringDataType
1616
import io.openapiprocessor.core.parser.HttpMethod
1717
import io.openapiprocessor.core.support.TestStatusAnnotationWriter
18-
import io.openapiprocessor.core.support.TestMappingAnnotationWriter
18+
import io.openapiprocessor.core.support.TestMappingAnnotationFactory
1919
import io.openapiprocessor.core.support.TestParameterAnnotationWriter
2020
import io.openapiprocessor.core.support.parseOptions
2121
import java.io.StringWriter
@@ -27,7 +27,7 @@ class MethodWriterResponseStyleSpec: FreeSpec() {
2727
options,
2828
JavaIdentifier(),
2929
TestStatusAnnotationWriter(),
30-
TestMappingAnnotationWriter(),
30+
TestMappingAnnotationFactory(),
3131
TestParameterAnnotationWriter(),
3232
mockk<BeanValidationFactory>(),
3333
mockk<JavaDocFactory>()

openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/writer/java/MethodWriterSpec.kt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import io.openapiprocessor.core.model.datatypes.*
1515
import io.openapiprocessor.core.model.parameters.ParameterBase
1616
import io.openapiprocessor.core.processor.mapping.v2.ResultStyle
1717
import io.openapiprocessor.core.support.TestStatusAnnotationWriter
18-
import io.openapiprocessor.core.support.TestMappingAnnotationWriter
18+
import io.openapiprocessor.core.support.TestMappingAnnotationFactory
1919
import io.openapiprocessor.core.support.TestParameterAnnotationWriter
2020
import io.openapiprocessor.core.support.datatypes.CollectionDataType
2121
import java.io.StringWriter
@@ -30,7 +30,7 @@ class MethodWriterSpec: StringSpec({
3030
apiOptions,
3131
identifier,
3232
TestStatusAnnotationWriter(),
33-
TestMappingAnnotationWriter(),
33+
TestMappingAnnotationFactory(),
3434
TestParameterAnnotationWriter(),
3535
BeanValidationFactory(apiOptions))
3636

openapi-processor-core/src/testInt/kotlin/io/openapiprocessor/core/TestProcessor.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ class TestProcessor:
6565
options,
6666
identifier,
6767
TestProcessorStatusAnnotationWriter(),
68-
TestProcessorMappingAnnotationWriter(),
68+
TestProcessorMappingAnnotationFactory(),
6969
TestProcessorParameterAnnotationWriter(),
7070
beanValidation,
7171
javaDocFactory
Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,12 @@ package io.openapiprocessor.core
77

88
import io.openapiprocessor.core.model.Endpoint
99
import io.openapiprocessor.core.model.EndpointResponse
10-
import io.openapiprocessor.core.writer.java.MappingAnnotationWriter
11-
import java.io.Writer
10+
import io.openapiprocessor.core.writer.java.MappingAnnotationFactory
1211

1312
/**
14-
* simple [io.openapiprocessor.core.writer.java.MappingAnnotationWriter] implementation for testing.
13+
* simple [io.openapiprocessor.core.writer.java.MappingAnnotationFactory] implementation for testing.
1514
*/
16-
// todo rename to factory
17-
class TestProcessorMappingAnnotationWriter: MappingAnnotationWriter {
18-
19-
@Deprecated("remove, use create()")
20-
override fun write(target: Writer, endpoint: Endpoint, endpointResponse: EndpointResponse) {
21-
target.write ("""${MAPPING.annotationName}("${endpoint.path}")""")
22-
}
15+
class TestProcessorMappingAnnotationFactory: MappingAnnotationFactory {
2316

2417
override fun create(endpoint: Endpoint, endpointResponse: EndpointResponse): List<String> {
2518
return listOf("""${MAPPING.annotationName}("${endpoint.path}")""")

0 commit comments

Comments
 (0)