org.codenarc.rule.groovyism.GStringExpressionWithinStringRule.groovy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of CodeNarc Show documentation
The CodeNarc project provides a static analysis tool for Groovy code.
There is a newer version: 3.5.0-groovy-4.0
/*
 * Copyright 2013 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.codenarc.rule.groovyism

import org.codehaus.groovy.ast.AnnotatedNode
import org.codehaus.groovy.ast.AnnotationNode
import org.codehaus.groovy.ast.expr.*
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule

import java.util.regex.Matcher

/**
 * Check for regular (single quote) strings containing a GString-type expression (${..}).
 *
 * @author Chris Mair
 */
class GStringExpressionWithinStringRule extends AbstractAstVisitorRule {
    String name = 'GStringExpressionWithinString'
    int priority = 2
    Class astVisitorClass = GStringExpressionWithinStringAstVisitor
}

class GStringExpressionWithinStringAstVisitor extends AbstractAstVisitor {

    private static final String GSTRING_EXPRESSION_REGEX = /\$\{.*\}/
    private AnnotatedNode currentAnnotatedNode

    @Override
    void visitConstantExpression(ConstantExpression expression) {
        if (isFirstVisit(expression) && expression.value instanceof String && expression.lineNumber > -1) {
            Matcher matcher = expression.value =~ GSTRING_EXPRESSION_REGEX
            boolean matchesGStringExpressionPattern = matcher as boolean
            if (matchesGStringExpressionPattern && isNotElementOfAnnotation(expression)) {
                addViolation(expression, "The String '$expression.value' contains a GString-type expression: '${matcher[0]}'")
            }
        }
        super.visitConstantExpression(expression)
    }

    @Override
    void visitGStringExpression(GStringExpression expression) {
        // GStrings may contain constituent "regular" strings, but we don't want to process those for this rule.
        // super.visitGStringExpression(expression)
    }

    @Override
    void visitAnnotations(AnnotatedNode node) {
        saveCurrentAnnotatedNode(node)
        super.visitAnnotations(node)
        resetCurrentAnnotatedNode()
    }

    private boolean isNotElementOfAnnotation(ConstantExpression expression) {
        return !isProcessingAnnotatedNode() || !isUsedInAnyAnnotationOnCurrentAnnotatedNode(expression)
    }

    private boolean isUsedInAnyAnnotationOnCurrentAnnotatedNode(ConstantExpression constantExpression) {
        return currentAnnotatedNode.annotations.any { AnnotationNode annotationNode ->
            isExpressionUsedInAnnotation(constantExpression, annotationNode)
        }
    }

    private static boolean isExpressionUsedInAnnotation(ConstantExpression expression, AnnotationNode annotationNode) {
        List constantExpressions = new ConstantExpressionExtractor().extractFrom(annotationNode)
        return constantExpressions.any { it.is(expression) }
    }

    private boolean isProcessingAnnotatedNode() {
        return this.currentAnnotatedNode != null
    }

    private void resetCurrentAnnotatedNode() {
        this.currentAnnotatedNode = null
    }

    private void saveCurrentAnnotatedNode(AnnotatedNode annotatedNode) {
        this.currentAnnotatedNode = annotatedNode
    }
}

class ConstantExpressionExtractor {

    List extractFrom(AnnotationNode annotationNode) {
        def all = annotationNode.members.values().findAll { Expression expression ->
            expression instanceof ListExpression || expression instanceof ConstantExpression || expression instanceof AnnotationConstantExpression
        }.collect { Expression expression ->
            extractFromExpression(expression)
        }
        // Has nested collections, so cannot use collectMany()
        return all.flatten()
    }

    private List extractFromExpression(ListExpression listExpression) {
        return listExpression.expressions.collect { Expression expression ->
            extractFromExpression(expression)
        }
    }

    private List extractFromExpression(ConstantExpression expression) {
        return [expression]
    }

    private List extractFromExpression(AnnotationConstantExpression expression) {
        AnnotationNode annotationNode = expression.value as AnnotationNode
        return extractFrom(annotationNode)
    }
}