org.codenarc.rule.unnecessary.UnnecessaryDotClassRule.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 2011 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.unnecessary

import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.PropertyExpression
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil

/**
 * To make a reference to a class, it is unnecessary to specify the '.class' identifier. For instance String.class can be shortened to String.
 *
 * @author 'Dean Del Ponte'
 * @author Chris Mair
  */
class UnnecessaryDotClassRule extends AbstractAstVisitorRule {
    String name = 'UnnecessaryDotClass'
    int priority = 3
    Class astVisitorClass = UnnecessaryDotClassAstVisitor
}

class UnnecessaryDotClassAstVisitor extends AbstractAstVisitor {

    @Override
    void visitPropertyExpression(PropertyExpression expression) {
        if (isFirstVisit(expression) && AstUtil.isConstant(expression.property, 'class')) {
            def object = expression.objectExpression
            boolean isClassPropertyExpression = object instanceof PropertyExpression &&
                object.property instanceof ConstantExpression &&
                Character.isUpperCase(object.property.value.toCharacter())

            if (isClassPropertyExpression || AstUtil.isVariable(object, /[A-Z].*/)) {
                def exprText = object.text
                addViolation(expression, "${exprText}.class can be rewritten as $exprText")
            }
        }
        super.visitPropertyExpression(expression)
    }

}