net.sourceforge.pmd.lang.test.ast.NodeExtensions.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of pmd-lang-test Show documentation

Module containing utilities to test language implementations, including parsers and ASTs. This module uses Kotlin.

There is a newer version: 7.5.0

/*
 * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
 */

package net.sourceforge.pmd.lang.test.ast

import io.kotest.matchers.string.shouldContain
import io.kotest.matchers.shouldNotBe
import net.sourceforge.pmd.lang.ast.Node
import net.sourceforge.pmd.lang.ast.TextAvailableNode


/**
 * Returns the text as a string. This is to allow
 * comparing the text to another string
 */
val TextAvailableNode.textStr: String
    get() = text.toString()

infix fun TextAvailableNode.shouldHaveText(str: String) {
    this::textStr shouldBe str
}

fun Node.textOfReportLocation(): String? =
        reportLocation.regionInFile?.let(textDocument::sliceOriginalText)?.toString()


fun Node.assertTextRangeIsOk() {

    reportLocation shouldNotBe null

    val parent = parent ?: return

    if (this is TextAvailableNode && parent is TextAvailableNode) {
        parent.text.toString().shouldContain(this.text.toString())
    }
}


fun Node.assertBounds(bline: Int, bcol: Int, eline: Int, ecol: Int) {
    reportLocation.apply {
        this::getStartLine shouldBe bline
        this::getStartColumn shouldBe bcol
        this::getEndLine shouldBe eline
        this::getEndColumn shouldBe ecol
    }
}