org.codenarc.rule.groovyism.ExplicitCallToEqualsMethodRule.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 2009 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.expr.MethodCallExpression
import org.codenarc.rule.AbstractAstVisitorRule

/**
 * This rule detects when the equals(Object) method is called directly in code instead of using the == or != operator. A groovier way to express this: a.equals(b) is this: a == b and a groovier way to express : !a.equals(b) is : a != b
 *
 * @author Hamlet D'Arcy
 */
class ExplicitCallToEqualsMethodRule extends AbstractAstVisitorRule {
    String name = 'ExplicitCallToEqualsMethod'
    int priority = 2
    Class astVisitorClass = ExplicitCallToEqualsMethodAstVisitor
    boolean ignoreThisReference = false
}

class ExplicitCallToEqualsMethodAstVisitor extends ExplicitCallToMethodAstVisitor {
    ExplicitCallToEqualsMethodAstVisitor() {
        super('equals')
    }

    @Override
    protected String getViolationMessage(MethodCallExpression exp) {
        "Explicit call to ${exp.text} method can be rewritten as (${exp.objectExpression.text} == ${exp.arguments.text})"
    }
}