org.cqfn.diktat.ruleset.rules.chapter3.LongNumericalValuesSeparatedRule.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of diktat-rules Show documentation
The main diktat ruleset
There is a newer version: 1.2.5
package org.cqfn.diktat.ruleset.rules.chapter3

import org.cqfn.diktat.common.config.rules.RuleConfiguration
import org.cqfn.diktat.common.config.rules.RulesConfig
import org.cqfn.diktat.common.config.rules.getRuleConfig
import org.cqfn.diktat.ruleset.constants.Warnings.LONG_NUMERICAL_VALUES_SEPARATED
import org.cqfn.diktat.ruleset.rules.DiktatRule

import com.pinterest.ktlint.core.ast.ElementType.FLOAT_LITERAL
import com.pinterest.ktlint.core.ast.ElementType.INTEGER_LITERAL
import org.jetbrains.kotlin.com.intellij.lang.ASTNode
import org.jetbrains.kotlin.com.intellij.psi.impl.source.tree.LeafPsiElement

import java.lang.StringBuilder

/**
 * Rule that checks if numerical separators (`_`) are used for long numerical literals
 */
class LongNumericalValuesSeparatedRule(configRules: List) : DiktatRule(
    NAME_ID,
    configRules,
    listOf(LONG_NUMERICAL_VALUES_SEPARATED)
) {
    override fun logic(node: ASTNode) {
        val configuration = LongNumericalValuesConfiguration(
            configRules.getRuleConfig(LONG_NUMERICAL_VALUES_SEPARATED)?.configuration ?: emptyMap())

        if (node.elementType == INTEGER_LITERAL && !isValidConstant(node.text, configuration, node)) {
            LONG_NUMERICAL_VALUES_SEPARATED.warnAndFix(configRules, emitWarn, isFixMode, node.text, node.startOffset, node) {
                fixIntegerConstant(node, configuration.maxBlockLength)
            }
        }

        if (node.elementType == FLOAT_LITERAL && !isValidConstant(node.text, configuration, node)) {
            val parts = node.text.split(".")
            LONG_NUMERICAL_VALUES_SEPARATED.warnAndFix(configRules, emitWarn, isFixMode, node.text, node.startOffset, node) {
                fixFloatConstantPart(parts[0], parts[1], configuration, node)
            }
        }
    }

    private fun fixIntegerConstant(node: ASTNode, maxBlockLength: Int) {
        val resultRealPart = StringBuilder(nodePrefix(node.text))

        val chunks = removePrefixSuffix(node.text)
            .reversed()
            .chunked(maxBlockLength)
            .reversed()
        resultRealPart.append(chunks.joinToString(separator = "_") { it.reversed() })

        resultRealPart.append(nodeSuffix(node.text))
        (node as LeafPsiElement).rawReplaceWithText(resultRealPart.toString())
    }

    private fun fixFloatConstantPart(
        realPart: String,
        fractionalPart: String,
        configuration: LongNumericalValuesConfiguration,
        node: ASTNode
    ) {
        val resultRealPart = StringBuilder(nodePrefix(realPart))
        val resultFractionalPart = StringBuilder()

        val realNumber = removePrefixSuffix(realPart)
        if (realNumber.length > configuration.maxLength) {
            val chunks = realNumber
                .reversed()
                .chunked(configuration.maxBlockLength)
                .reversed()
            resultRealPart.append(chunks.joinToString(separator = "_") { it.reversed() })

            resultRealPart.append(nodeSuffix(realPart)).append(".")
        } else {
            resultRealPart.append(realNumber).append(".")
        }

        val fractionalNumber = removePrefixSuffix(fractionalPart)
        if (fractionalNumber.length > configuration.maxLength) {
            val chunks = fractionalNumber.chunked(configuration.maxBlockLength)
            resultFractionalPart.append(chunks.joinToString(separator = "_", postfix = nodeSuffix(fractionalPart)) { it })

            resultFractionalPart.append(nodeSuffix(fractionalPart))
        } else {
            resultFractionalPart.append(fractionalNumber).append(nodeSuffix(fractionalPart))
        }

        (node as LeafPsiElement).rawReplaceWithText(resultRealPart.append(resultFractionalPart).toString())
    }

    private fun nodePrefix(nodeText: String) = when {
        nodeText.startsWith("0b") -> "0b"
        nodeText.startsWith("0x") -> "0x"
        else -> ""
    }

    private fun nodeSuffix(nodeText: String) = when {
        nodeText.endsWith("L") -> "L"
        nodeText.endsWith("f", true) -> "f"
        else -> ""
    }

    private fun isValidConstant(
        text: String,
        configuration: LongNumericalValuesConfiguration,
        node: ASTNode
    ): Boolean {
        if (text.contains("_")) {
            checkBlocks(removePrefixSuffix(text), configuration, node)
            return true
        }

        return text
            .split(".")
            .map { removePrefixSuffix(it) }
            .all { it.length <= configuration.maxLength }
    }

    private fun checkBlocks(
        text: String,
        configuration: LongNumericalValuesConfiguration,
        node: ASTNode
    ) {
        val blocks = text.split("_", ".")

        blocks.forEach {
            if (it.length > configuration.maxBlockLength) {
                LONG_NUMERICAL_VALUES_SEPARATED.warn(configRules, emitWarn, false, "this block is too long $it", node.startOffset, node)
            }
        }
    }

    private fun removePrefixSuffix(text: String): String {
        if (text.startsWith("0x")) {
            return text.removePrefix("0x")
        }

        return text.removePrefix("0b")
            .removeSuffix("L")
            .removeSuffix("f")
            .removeSuffix("F")
    }

    /**
     * [RuleConfiguration] for numerical literals separation
     */
    class LongNumericalValuesConfiguration(config: Map) : RuleConfiguration(config) {
        /**
         * Maximum number of digits which are not split
         */
        val maxLength = config["maxNumberLength"]?.toIntOrNull() ?: MAX_NUMBER_LENGTH

        /**
         * Maximum number of digits between separators
         */
        val maxBlockLength = config["maxBlockLength"]?.toIntOrNull() ?: DELIMITER_LENGTH
    }

    companion object {
        private const val DELIMITER_LENGTH: Int = 3
        private const val MAX_NUMBER_LENGTH: Int = 3
        const val NAME_ID = "abm-long-numerical-values"
    }
}