Rename deepSearch() to findFirstByText()

Author: yevhenii-nadtochii

java/src/main/kotlin/io/spine/validation/java/MessageValidationCode.kt

@@ -53,7 +53,7 @@ import io.spine.validation.CompilationMessage
 import io.spine.validation.Rule
 import io.spine.validation.java.psi.addBefore
 import io.spine.validation.java.psi.createStatementsFromText
-import io.spine.validation.java.psi.deepSearch
+import io.spine.validation.java.psi.findFirstByText
 import io.spine.validation.java.psi.nested
 
 private typealias MessagePsiClass = PsiClass
@@ -201,7 +201,7 @@ internal class MessageValidationCode(
      * If one or more constraints are violated, the injected snippet will throw.
      */
     private fun BuilderPsiClass.injectValidationIntoBuildMethod() = method("build").run {
-        val returningResult = deepSearch("return result;")
+        val returningResult = findFirstByText("return result;")
         val runValidation = elementFactory.createStatementsFromText(
             """
             java.util.Optional<io.spine.validate.ValidationError> error = result.validate();

java/src/main/kotlin/io/spine/validation/java/protodata/PsiElementExts.kt

@@ -27,6 +27,8 @@
 package io.spine.validation.java.psi
 
 import com.intellij.psi.PsiClass
+import com.intellij.psi.PsiMethod
+import io.spine.tools.psi.java.Environment.elementFactory
 
 /**
  * Returns a nested class declared in this [PsiClass].
@@ -40,3 +42,40 @@ public fun PsiClass.nested(simpleName: String): PsiClass {
     }
     return found
 }
+
+/**
+ * Looks for a method in this [PsiClass] matching the given signature
+ * specified as [text].
+ *
+ * An example usage:
+ *
+ * ```
+ * val method = psiClass.findMethodBySignature("public Builder setName(Name value)")
+ * ```
+ *
+ * @param text The method signature as text.
+ */
+public fun PsiClass.findMethodBySignature(text: String): PsiMethod? {
+    val reference = elementFactory.createMethodFromText(text, null)
+    return findMethodBySignature(reference, false)
+}
+
+/**
+ * Returns a method from this [PsiClass] matching the given signature
+ * specified as [text].
+ *
+ * An example usage:
+ *
+ * ```
+ * val method = psiClass.getMethodBySignature("public Builder setName(Name value)")
+ * ```
+ *
+ * @param text The method signature as text.
+ * @throws IllegalStateException if this class does not have such a method.
+ */
+public fun PsiClass.methodWithSignature(text: String): PsiMethod =
+    findMethodBySignature(text)
+        ?: error(
+            "Could not find the method with the signature `$text` " +
+                    "in the `$qualifiedName` class."
+        )

java/src/main/kotlin/io/spine/validation/java/psi/PsiClassExts.kt

@@ -36,14 +36,14 @@ import com.intellij.psi.PsiElement
  * child of this [PsiElement] is checked only when the first child and all its descendants
  * are checked.
  */
-internal fun PsiElement.deepSearch(
+internal fun PsiElement.findFirstByText(
     startsWith: String,
     contains: String = startsWith
 ): PsiElement = children.firstNotNullOf { element ->
     val text = element.text
     when {
         !text.contains(contains) -> null
         text.startsWith(startsWith) -> element
-        else -> element.deepSearch(startsWith, contains)
+        else -> element.findFirstByText(startsWith, contains)
     }
 }

java/src/main/kotlin/io/spine/validation/java/psi/PsiElementExts.kt

@@ -30,7 +30,6 @@ import com.intellij.psi.PsiClass
 import io.spine.protodata.ast.Field
 import io.spine.protodata.ast.PrimitiveType
 import io.spine.protodata.java.Expression
-import io.spine.protodata.java.AnElement
 import io.spine.protodata.java.ClassName
 import io.spine.protodata.java.call
 import io.spine.protodata.type.TypeSystem
@@ -65,7 +64,7 @@ internal class SetOnceBooleanField(
         alterSetter()
         alterBytesMerge(
             currentValue = Expression(fieldGetter),
-            readerStartsWith = AnElement("${fieldName}_ = input.readBool();")
+            readerStartsWith = "${fieldName}_ = input.readBool();"
         )
     }
 

java/src/main/kotlin/io/spine/validation/java/setonce/PsiClassExts.kt

@@ -30,7 +30,6 @@ import com.google.protobuf.ByteString
 import com.intellij.psi.PsiClass
 import io.spine.protodata.ast.Field
 import io.spine.protodata.ast.PrimitiveType
-import io.spine.protodata.java.AnElement
 import io.spine.protodata.java.Expression
 import io.spine.protodata.java.MethodCall
 import io.spine.protodata.type.TypeSystem
@@ -70,7 +69,7 @@ internal class SetOnceBytesField(
         alterSetter()
         alterBytesMerge(
             currentValue = Expression(fieldGetter),
-            readerStartsWith = AnElement("${fieldName}_ = input.readBytes();")
+            readerStartsWith = "${fieldName}_ = input.readBytes();"
         )
     }
 

java/src/main/kotlin/io/spine/validation/java/setonce/SetOnceBooleanField.kt

@@ -31,7 +31,6 @@ import com.google.protobuf.ProtocolMessageEnum
 import com.intellij.psi.PsiClass
 import io.spine.protodata.ast.Field
 import io.spine.protodata.type.TypeSystem
-import io.spine.protodata.java.AnElement
 import io.spine.protodata.java.Expression
 import io.spine.protodata.java.call
 import io.spine.protodata.java.javaClassName
@@ -72,7 +71,7 @@ internal class SetOnceEnumField(
         alterEnumValueSetter()
         alterBytesMerge(
             currentValue = Expression("${fieldName}_"),
-            readerStartsWith = AnElement("${fieldName}_ = input.readEnum();")
+            readerStartsWith = "${fieldName}_ = input.readEnum();"
         )
     }
 

java/src/main/kotlin/io/spine/validation/java/setonce/SetOnceBytesField.kt

@@ -34,7 +34,6 @@ import io.spine.protodata.ast.Field
 import io.spine.protodata.ast.TypeName
 import io.spine.protodata.java.Expression
 import io.spine.protodata.java.InitVar
-import io.spine.protodata.java.JavaElement
 import io.spine.protodata.java.javaCase
 import io.spine.protodata.java.javaClassName
 import io.spine.protodata.java.render.findClass
@@ -45,7 +44,8 @@ import io.spine.string.camelCase
 import io.spine.tools.code.Java
 import io.spine.tools.psi.java.Environment.elementFactory
 import io.spine.tools.psi.java.execute
-import io.spine.validation.java.protodata.deepSearch
+import io.spine.validation.java.psi.findFirstByText
+import io.spine.validation.java.psi.methodWithSignature
 
 /**
  * Renders Java code to support `(set_once)` option for the given [field].
@@ -151,12 +151,12 @@ internal sealed class SetOnceJavaConstraints<T>(
      */
     protected fun PsiClass.alterBytesMerge(
         currentValue: Expression<T>,
-        readerStartsWith: JavaElement,
-        readerContains: JavaElement = readerStartsWith,
+        readerStartsWith: String,
+        readerContains: String = readerStartsWith,
     ) {
 
         val mergeFromBytes = methodWithSignature(MergeFromBytesSignature).body!!
-        val fieldReading = mergeFromBytes.deepSearch(readerStartsWith, readerContains)
+        val fieldReading = mergeFromBytes.findFirstByText(readerStartsWith, readerContains)
         val fieldCaseBlock = fieldReading.parent
 
         val previousValue = InitVar("previous", currentValue)

java/src/main/kotlin/io/spine/validation/java/setonce/SetOnceEnumField.kt

@@ -29,12 +29,12 @@ package io.spine.validation.java.setonce
 import com.google.protobuf.Message
 import com.intellij.psi.PsiClass
 import io.spine.protodata.ast.Field
-import io.spine.protodata.java.AnElement
 import io.spine.protodata.java.Expression
 import io.spine.protodata.java.MethodCall
 import io.spine.protodata.java.javaClassName
 import io.spine.protodata.type.TypeSystem
 import io.spine.tools.psi.java.method
+import io.spine.validation.java.psi.methodWithSignature
 
 /**
  * Renders Java code to support `(set_once)` option for the given message [field].
@@ -72,8 +72,8 @@ internal class SetOnceMessageField(
         alterFieldMerge()
         alterBytesMerge(
             currentValue = Expression(fieldGetter),
-            readerStartsWith = AnElement("input.readMessage"),
-            readerContains = AnElement("${fieldGetterName}FieldBuilder().getBuilder()"),
+            readerStartsWith = "input.readMessage",
+            readerContains = "${fieldGetterName}FieldBuilder().getBuilder()"
         )
     }
 

java/src/main/kotlin/io/spine/validation/java/setonce/SetOnceJavaConstraints.kt

@@ -91,7 +91,7 @@ internal class SetOnceNumberField(
         alterSetter()
         alterBytesMerge(
             currentValue = Expression(fieldGetter),
-            readerStartsWith = AnElement("${fieldName}_ = input.$fieldReader();")
+            readerStartsWith = "${fieldName}_ = input.$fieldReader();"
         )
     }
 

java/src/main/kotlin/io/spine/validation/java/setonce/SetOnceMessageField.kt

@@ -32,12 +32,12 @@ import com.intellij.psi.PsiClass
 import com.intellij.psi.PsiIfStatement
 import io.spine.protodata.ast.Field
 import io.spine.protodata.ast.PrimitiveType
-import io.spine.protodata.java.AnElement
 import io.spine.protodata.java.Expression
 import io.spine.protodata.java.MethodCall
 import io.spine.protodata.type.TypeSystem
 import io.spine.tools.psi.java.method
-import io.spine.validation.java.psi.deepSearch
+import io.spine.validation.java.psi.findFirstByText
+import io.spine.validation.java.psi.methodWithSignature
 
 /**
  * A type that can be either [String] or [ByteString].
@@ -86,7 +86,7 @@ internal class SetOnceStringField(
         alterMessageMerge()
         alterBytesMerge(
             currentValue = Expression(fieldGetter),
-            readerStartsWith = AnElement("${fieldName}_ = input.readStringRequireUtf8();")
+            readerStartsWith = "${fieldName}_ = input.readStringRequireUtf8();"
         )
     }
 
@@ -141,7 +141,7 @@ internal class SetOnceStringField(
         val mergeFromMessage = methodWithSignature(
             "public Builder mergeFrom(${declaringMessageClass.canonical} other)"
         ).body!!
-        val fieldCheck = mergeFromMessage.deepSearch(
+        val fieldCheck = mergeFromMessage.findFirstByText(
             "if (!other.$fieldGetter.isEmpty())"
         ) as PsiIfStatement
         val fieldProcessing = (fieldCheck.thenBranch!! as PsiBlockStatement).codeBlock