Review fixes: extracted method, polished code

Author: onewhl

utbot-summary/src/main/kotlin/org/utbot/summary/comment/CustomJavaDocCommentBuilder.kt

@@ -49,6 +49,7 @@ class CustomJavaDocCommentBuilder(
             val reason = findExceptionReason(currentMethod, thrownException)
             "{@link $exceptionName} $reason"
         }
+
         if (exceptionThrow != null) {
             customJavaDocComment.throwsException = exceptionThrow
         }
@@ -64,9 +65,8 @@ class CustomJavaDocCommentBuilder(
         }
 
         // builds Invoke, Execute, Return sections
-        var currentBlock: SimpleSentenceBlock? = rootSentenceBlock
-        while (currentBlock != null) {
-            for (statement in currentBlock.stmtTexts) {
+        generateSequence(rootSentenceBlock) { it.nextBlock }.forEach {
+            for (statement in it.stmtTexts) {
                 when (statement.stmtType) {
                     StmtType.Invoke -> customJavaDocComment.invokes += "{@code ${statement.description}}"
                     StmtType.Condition -> customJavaDocComment.executesCondition += "{@code ${statement.description}}"
@@ -76,7 +76,6 @@ class CustomJavaDocCommentBuilder(
                     }
                 }
             }
-            currentBlock = currentBlock.nextBlock
         }
 
         return customJavaDocComment

utbot-summary/src/main/kotlin/org/utbot/summary/comment/CustomJavaDocTagProvider.kt

@@ -45,12 +45,16 @@ sealed class CustomJavaDocTag(
     object ThrowsException :
         CustomJavaDocTag("utbot.throwsException", "Throws exception", CustomJavaDocComment::throwsException)
 
-    fun generateDocStatement(comment: CustomJavaDocComment): DocRegularStmt? {
-        val value = valueRetriever.invoke(comment)
-        return if (value is String) {
-            if (value.isNotEmpty()) DocRegularStmt("@$name $value\n") else null
-        } else if (value is List<*>) {
-            if (value.isNotEmpty()) DocRegularStmt("@$name ${value.joinToString(separator = ",\n")}\n") else null
-        } else null
-    }
+    fun generateDocStatement(comment: CustomJavaDocComment): DocRegularStmt? =
+        when (val value = valueRetriever.invoke(comment)) {
+            is String -> value.takeIf { it.isNotEmpty() }?.let {
+                DocRegularStmt("@$name $value\n")
+            }
+            is List<*> -> value.takeIf { it.isNotEmpty() }?.let {
+                val valueToString = value.joinToString(separator = ",\n", postfix = "\n")
+
+                DocRegularStmt("@$name $valueToString")
+            }
+            else -> null
+        }
 }

utbot-summary/src/main/kotlin/org/utbot/summary/comment/SimpleCommentBuilder.kt

@@ -42,7 +42,21 @@ open class SimpleCommentBuilder(
      */
     open fun buildString(currentMethod: SootMethod): String {
         val root = SimpleSentenceBlock(stringTemplates = stringTemplates)
+        buildThrownExceptionInfo(root, currentMethod)
+        skippedIterations()
+        buildSentenceBlock(traceTag.rootStatementTag, root, currentMethod)
+        var sentence = toSentence(root)
+        if (sentence.isEmpty()) return genWarnNotification()
+        sentence = splitLongSentence(sentence)
+        sentence = lastCommaToDot(sentence)
 
+        return "<pre>\n$sentence</pre>".replace(CARRIAGE_RETURN, "")
+    }
+
+    private fun buildThrownExceptionInfo(
+        root: SimpleSentenceBlock,
+        currentMethod: SootMethod
+    ) {
         val thrownException = traceTag.result.exceptionOrNull()
         if (thrownException == null) {
             root.exceptionThrow = traceTag.result.exceptionOrNull()?.let { it::class.qualifiedName }
@@ -51,14 +65,6 @@ open class SimpleCommentBuilder(
             val reason = findExceptionReason(currentMethod, thrownException)
             root.exceptionThrow = "$exceptionName $reason"
         }
-        skippedIterations()
-        buildSentenceBlock(traceTag.rootStatementTag, root, currentMethod)
-        var sentence = toSentence(root)
-        if (sentence.isEmpty()) return genWarnNotification()
-        sentence = splitLongSentence(sentence)
-        sentence = lastCommaToDot(sentence)
-
-        return "<pre>\n$sentence</pre>".replace(CARRIAGE_RETURN, "")
     }
 
     /**
@@ -79,15 +85,7 @@ open class SimpleCommentBuilder(
 
     private fun buildSentenceBlock(currentMethod: SootMethod): SimpleSentenceBlock {
         val rootSentenceBlock = SimpleSentenceBlock(stringTemplates = stringTemplates)
-
-        val thrownException = traceTag.result.exceptionOrNull()
-        if (thrownException == null) {
-            rootSentenceBlock.exceptionThrow = traceTag.result.exceptionOrNull()?.let { it::class.qualifiedName }
-        } else {
-            val exceptionName = thrownException.javaClass.simpleName
-            val reason = findExceptionReason(currentMethod, thrownException)
-            rootSentenceBlock.exceptionThrow = "$exceptionName $reason"
-        }
+        buildThrownExceptionInfo(rootSentenceBlock, currentMethod)
         skippedIterations()
         buildSentenceBlock(traceTag.rootStatementTag, rootSentenceBlock, currentMethod)
         return rootSentenceBlock