include source comments in generated output (#86)

marcoferrer · Nov 15, 2019 · b978f5f · b978f5f
1 parent 891b87c
commit b978f5f
Show file tree

Hide file tree

Showing 10 changed files with 109 additions and 19 deletions.
diff --git a/...us/src/main/kotlin/com/github/marcoferrer/krotoplus/generators/GrpcCoroutinesGenerator.kt b/...us/src/main/kotlin/com/github/marcoferrer/krotoplus/generators/GrpcCoroutinesGenerator.kt
@@ -92,6 +92,7 @@ object GrpcCoroutinesGenerator : Generator {
 
     private fun ProtoService.buildOuterObject(): TypeSpec =
         TypeSpec.objectBuilder(outerObjectName)
+            .addKdoc(attachedComments)
             .addAnnotation(protoFile.getGeneratedAnnotationSpec())
             .addFunction(
                 FunSpec.builder("newStub")

diff --git a/...plus/src/main/kotlin/com/github/marcoferrer/krotoplus/generators/GrpcStubExtsGenerator.kt b/...plus/src/main/kotlin/com/github/marcoferrer/krotoplus/generators/GrpcStubExtsGenerator.kt
@@ -105,6 +105,7 @@ object GrpcStubExtsGenerator : Generator {
 
         private fun ProtoMethod.buildStubClientStreamingMethod(): FunSpec =
             FunSpec.builder(functionName)
+                .addKdoc(attachedComments)
                 .receiver(protoService.asyncStubClassName)
                 .returns(
                     CommonClassNames.ClientChannels.clientStreamingCallChannel.parameterizedBy(
@@ -122,6 +123,7 @@ object GrpcStubExtsGenerator : Generator {
 
         private fun ProtoMethod.buildStubCoroutineBidiStreamingMethod(): FunSpec =
             FunSpec.builder(functionName)
+                .addKdoc(attachedComments)
                 .receiver(protoService.asyncStubClassName)
                 .returns(
                     CommonClassNames.ClientChannels.clientBidiCallChannel.parameterizedBy(

diff --git a/...kotlin/com/github/marcoferrer/krotoplus/generators/builders/GrpcServiceBaseImplBuilder.kt b/...kotlin/com/github/marcoferrer/krotoplus/generators/builders/GrpcServiceBaseImplBuilder.kt
@@ -41,6 +41,7 @@ class GrpcServiceBaseImplBuilder(val context: GeneratorContext){
         val delegateValName = "delegate"
 
         TypeSpec.classBuilder(baseImplName)
+            .addKdoc(attachedComments)
             .addModifiers(KModifier.ABSTRACT)
             .addSuperinterface(CommonClassNames.bindableService)
             .addSuperinterface(CommonClassNames.serviceScope)
@@ -115,6 +116,7 @@ class GrpcServiceBaseImplBuilder(val context: GeneratorContext){
 
     private fun buildUnaryBaseImpl(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .addModifiers(KModifier.SUSPEND, KModifier.OPEN)
             .addParameter("request", requestClassName)
             .returns(responseClassName)
@@ -132,6 +134,7 @@ class GrpcServiceBaseImplBuilder(val context: GeneratorContext){
 
     private fun buildServerStreamingBaseImpl(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .addModifiers(KModifier.SUSPEND, KModifier.OPEN)
             .addParameter("request", requestClassName)
             .addParameter(
@@ -157,6 +160,7 @@ class GrpcServiceBaseImplBuilder(val context: GeneratorContext){
 
     private fun buildClientStreamingBaseImpl(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .addModifiers(KModifier.SUSPEND, KModifier.OPEN)
             .addParameter(
                 name = "requestChannel",
@@ -177,6 +181,7 @@ class GrpcServiceBaseImplBuilder(val context: GeneratorContext){
 
     private fun buildBidiStreamingBaseImpl(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .addModifiers(KModifier.SUSPEND, KModifier.OPEN)
             .addParameter(
                 name = "requestChannel",

diff --git a/...s/src/main/kotlin/com/github/marcoferrer/krotoplus/generators/builders/GrpcStubBuilder.kt b/...s/src/main/kotlin/com/github/marcoferrer/krotoplus/generators/builders/GrpcStubBuilder.kt
@@ -19,14 +19,11 @@ package com.github.marcoferrer.krotoplus.generators.builders
 import com.github.marcoferrer.krotoplus.generators.GeneratorContext
 import com.github.marcoferrer.krotoplus.proto.ProtoMethod
 import com.github.marcoferrer.krotoplus.proto.ProtoService
-import com.github.marcoferrer.krotoplus.proto.getFieldClassName
 import com.github.marcoferrer.krotoplus.utils.CommonClassNames
-import com.github.marcoferrer.krotoplus.utils.addForEach
 import com.github.marcoferrer.krotoplus.utils.builderLambdaTypeName
 import com.github.marcoferrer.krotoplus.utils.requestParamSpec
 import com.github.marcoferrer.krotoplus.utils.requestValueBuilderCodeBlock
 import com.github.marcoferrer.krotoplus.utils.requestValueMethodSigCodeBlock
-import com.github.marcoferrer.krotoplus.utils.toUpperCamelCase
 import com.squareup.kotlinpoet.FunSpec
 import com.squareup.kotlinpoet.KModifier
 import com.squareup.kotlinpoet.ParameterSpec
@@ -39,13 +36,13 @@ import io.grpc.MethodDescriptor
 
 class GrpcStubBuilder(val context: GeneratorContext){
 
-
     fun buildStub(protoService: ProtoService): TypeSpec = with(protoService) {
 
         val paramNameChannel = "channel"
         val paramNameCallOptions = "callOptions"
 
         TypeSpec.classBuilder(stubName)
+            .addKdoc(attachedComments)
             .superclass(CommonClassNames.grpcAbstractStub.parameterizedBy(stubClassName))
             .addSuperclassConstructorParameter(paramNameChannel)
             .addSuperclassConstructorParameter(paramNameCallOptions)
@@ -77,7 +74,7 @@ class GrpcStubBuilder(val context: GeneratorContext){
             .build()
     }
 
-    fun TypeSpec.Builder.addRpcMethods(service: ProtoService): TypeSpec.Builder = apply {
+    private fun TypeSpec.Builder.addRpcMethods(service: ProtoService): TypeSpec.Builder = apply {
 
         for(method in service.methodDefinitions) when(method.type){
             MethodDescriptor.MethodType.UNARY -> {
@@ -102,11 +99,10 @@ class GrpcStubBuilder(val context: GeneratorContext){
         }
     }
 
-    // Default method
-
     private fun buildUnaryMethod(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
             .addModifiers(KModifier.SUSPEND)
+            .addKdoc(attachedComments)
             .returns(responseClassName)
             .addParameter(requestClassName.requestParamSpec)
             .addStatement(
@@ -120,6 +116,7 @@ class GrpcStubBuilder(val context: GeneratorContext){
 
     private fun buildServerStreamingMethod(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .returns(CommonClassNames.receiveChannel.parameterizedBy(responseClassName))
             .addParameter(requestClassName.requestParamSpec)
             .addStatement(
@@ -133,6 +130,7 @@ class GrpcStubBuilder(val context: GeneratorContext){
 
     private fun buildClientStreamingMethod(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .returns(
                 CommonClassNames.ClientChannels.clientStreamingCallChannel.parameterizedBy(
                     requestClassName,
@@ -150,6 +148,7 @@ class GrpcStubBuilder(val context: GeneratorContext){
 
     private fun buildBidiStreamingMethod(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .returns(
                 CommonClassNames.ClientChannels.clientBidiCallChannel.parameterizedBy(
                     requestClassName,
@@ -169,6 +168,7 @@ class GrpcStubBuilder(val context: GeneratorContext){
 
     private fun buildUnaryLambdaOverload(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .addModifiers(KModifier.SUSPEND, KModifier.INLINE)
             .returns(responseClassName)
             .addParameter("block", requestClassName.builderLambdaTypeName)
@@ -179,6 +179,7 @@ class GrpcStubBuilder(val context: GeneratorContext){
 
     private fun buildServerStreamingLambdaOverload(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .addModifiers(KModifier.INLINE)
             .returns(CommonClassNames.receiveChannel.parameterizedBy(responseClassName))
             .addParameter("block", requestClassName.builderLambdaTypeName)
@@ -192,6 +193,7 @@ class GrpcStubBuilder(val context: GeneratorContext){
     private fun buildUnaryMethodSigOverload(protoMethod: ProtoMethod): FunSpec? = with(protoMethod){
         if(methodSignatureFields.isEmpty())
             null else FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .addModifiers(KModifier.SUSPEND)
             .returns(responseClassName)
             .addMethodSignatureParameter(methodSignatureFields,context.schema)
@@ -203,6 +205,7 @@ class GrpcStubBuilder(val context: GeneratorContext){
     private fun buildServerStreamingMethodSigOverload(protoMethod: ProtoMethod): FunSpec? = with(protoMethod){
         if(methodSignatureFields.isEmpty())
             null else FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .returns(CommonClassNames.receiveChannel.parameterizedBy(responseClassName))
             .addMethodSignatureParameter(methodSignatureFields,context.schema)
             .addCode(requestClassName.requestValueMethodSigCodeBlock(methodSignatureFields))

diff --git a/...in/com/github/marcoferrer/krotoplus/generators/builders/ServerStreamingStubExtsBuilder.kt b/...in/com/github/marcoferrer/krotoplus/generators/builders/ServerStreamingStubExtsBuilder.kt
@@ -69,6 +69,7 @@ class ServerStreamingStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildCoroutineExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .returns(CommonClassNames.receiveChannel.parameterizedBy(responseClassName))
             .receiver(protoService.asyncStubClassName)
             .addParameter(requestClassName.requestParamSpec)
@@ -85,6 +86,7 @@ class ServerStreamingStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildAsyncMethodSigExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .receiver(protoService.asyncStubClassName)
             .returns(UNIT)
             .addMethodSignatureParameter(methodSignatureFields, context.schema)
@@ -96,6 +98,7 @@ class ServerStreamingStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildCoroutineMethodSigExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .receiver(protoService.asyncStubClassName)
             .addMethodSignatureParameter(methodSignatureFields, context.schema)
             .returns(CommonClassNames.receiveChannel.parameterizedBy(responseClassName))
@@ -106,6 +109,7 @@ class ServerStreamingStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildBlockingMethodSigExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .receiver(protoService.blockingStubClassName)
             .addMethodSignatureParameter(methodSignatureFields, context.schema)
             .returns(Iterator::class.asClassName().parameterizedBy(responseClassName))
@@ -118,6 +122,7 @@ class ServerStreamingStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildAsyncLambdaBuilderExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .addModifiers(KModifier.INLINE)
             .receiver(protoService.asyncStubClassName)
             .addResponseObserverParameter(responseClassName)
@@ -130,6 +135,7 @@ class ServerStreamingStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildCoroutineLambdaBuilderExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .receiver(protoService.asyncStubClassName)
             .returns(CommonClassNames.receiveChannel.parameterizedBy(responseClassName))
             .addModifiers(KModifier.INLINE)
@@ -141,6 +147,7 @@ class ServerStreamingStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildBlockingLambdaBuilderExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .addModifiers(KModifier.INLINE)
             .receiver(protoService.blockingStubClassName)
             .addParameter("block", requestClassName.builderLambdaTypeName)
@@ -154,6 +161,7 @@ class ServerStreamingStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildAsyncDefaultArgExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .receiver(protoService.asyncStubClassName)
             .addResponseObserverParameter(responseClassName)
             .returns(UNIT)
@@ -163,6 +171,7 @@ class ServerStreamingStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildBlockingDefaultArgExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .receiver(protoService.blockingStubClassName)
             .returns(Iterator::class.asClassName().parameterizedBy(responseClassName))
             .addStatement("return %N(%T.getDefaultInstance())", functionName, requestClassName)

diff --git a/.../main/kotlin/com/github/marcoferrer/krotoplus/generators/builders/UnaryStubExtsBuilder.kt b/.../main/kotlin/com/github/marcoferrer/krotoplus/generators/builders/UnaryStubExtsBuilder.kt
@@ -71,6 +71,7 @@ class UnaryStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildCoroutineExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .addModifiers(KModifier.SUSPEND)
             .receiver(protoService.asyncStubClassName)
             .addParameter(requestClassName.requestParamSpec)
@@ -88,6 +89,7 @@ class UnaryStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildAsyncMethodSigExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .receiver(protoService.asyncStubClassName)
             .addMethodSignatureParameter(methodSignatureFields, context.schema)
             .addResponseObserverParameter(responseClassName)
@@ -99,6 +101,7 @@ class UnaryStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildCoroutineMethodSigExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .addModifiers(KModifier.SUSPEND)
             .receiver(protoService.asyncStubClassName)
             .returns(responseClassName)
@@ -110,6 +113,7 @@ class UnaryStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildFutureMethodSigExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .receiver(protoService.futureStubClassName)
             .addMethodSignatureParameter(methodSignatureFields, context.schema)
             .returns(CommonClassNames.listenableFuture.parameterizedBy(responseClassName))
@@ -120,6 +124,7 @@ class UnaryStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildBlockingMethodSigExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .receiver(protoService.blockingStubClassName)
             .returns(responseClassName)
             .addMethodSignatureParameter(methodSignatureFields, context.schema)
@@ -132,6 +137,7 @@ class UnaryStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildAsyncLambdaBuilderExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .receiver(protoService.asyncStubClassName)
             .addModifiers(KModifier.INLINE)
             .addResponseObserverParameter(responseClassName)
@@ -144,6 +150,7 @@ class UnaryStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildCoroutineLambdaBuilderExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .receiver(protoService.asyncStubClassName)
             .addModifiers(KModifier.INLINE, KModifier.SUSPEND)
             .addParameter("block", requestClassName.builderLambdaTypeName)
@@ -155,6 +162,7 @@ class UnaryStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildFutureLambdaBuilderExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .addModifiers(KModifier.INLINE)
             .receiver(protoService.futureStubClassName)
             .addParameter("block", requestClassName.builderLambdaTypeName)
@@ -166,6 +174,7 @@ class UnaryStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildBlockingLambdaBuilderExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .addModifiers(KModifier.INLINE)
             .addCode(requestClassName.requestValueBuilderCodeBlock)
             .addParameter("block", requestClassName.builderLambdaTypeName)
@@ -179,6 +188,7 @@ class UnaryStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildAsyncDefaultArgExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .receiver(protoService.asyncStubClassName)
             .addResponseObserverParameter(responseClassName)
             .addStatement("%N(%T.getDefaultInstance(),responseObserver)", functionName, requestClassName)
@@ -188,6 +198,7 @@ class UnaryStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildFutureDefaultArgExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .addStatement("return %N(%T.getDefaultInstance())", functionName, requestClassName)
             .receiver(protoService.futureStubClassName)
             .returns(CommonClassNames.listenableFuture.parameterizedBy(responseClassName))
@@ -196,6 +207,7 @@ class UnaryStubExtsBuilder(val context: GeneratorContext){
 
     private fun buildBlockingDefaultArgExt(protoMethod: ProtoMethod): FunSpec = with(protoMethod){
         FunSpec.builder(functionName)
+            .addKdoc(attachedComments)
             .addStatement("return %N(%T.getDefaultInstance())", functionName, requestClassName)
             .receiver(protoService.blockingStubClassName)
             .returns(responseClassName)