GrailsDomainHasEqualsAstVisitor

gistfile1.groovy

/*
 * 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.grails

import org.codehaus.groovy.ast.ClassNode
import org.codenarc.rule.AbstractAstVisitor
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.util.AstUtil

/**
 * Checks that Grails domain classes redefine equals().
 *
 * @author <a href="mailto:[email protected]">Geli Crick</a>
 * @author Hamlet D'Arcy
  */
class GrailsDomainHasEqualsRule extends AbstractAstVisitorRule {
    String name = 'GrailsDomainHasEquals'
    int priority = 2
    Class astVisitorClass = GrailsDomainHasEqualsAstVisitor
    String applyToFilesMatching = GrailsUtil.DOMAIN_FILES
}

class GrailsDomainHasEqualsAstVisitor extends AbstractAstVisitor {
    void visitClassComplete(ClassNode classNode) {
        if (isFirstVisit(classNode)) {
            if (!AstUtil.getAnnotation(classNode, 'EqualsAndHashCode') && !classNode.methods.any { AstUtil.isMethodNode(it, 'equals', 1) }) {
                addViolation(classNode, "The domain class $classNode.name should define an equals(Object) method")
            }
        }
    }
}