org.codenarc.rule.unused.ReferenceCollector.groovy Maven / Gradle / Ivy

Go to download
/*
 * 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.unused

import org.codehaus.groovy.ast.ClassCodeVisitorSupport
import org.codehaus.groovy.ast.expr.ConstantExpression
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.VariableExpression
import org.codehaus.groovy.control.SourceUnit
import org.codenarc.util.AstUtil

/**
 * Class visitor that collects the names of all method call and variable references
 *
 * @author Hamlet D'Arcy
 */
class ReferenceCollector extends ClassCodeVisitorSupport {

    Set references = [] as Set

    @Override
    void visitVariableExpression(VariableExpression expression) {
        references.add(expression.name)
    }

    @Override
    void visitMethodCallExpression(MethodCallExpression call) {
        // Check for method call on a method with the same name as the parameter.
        // This handles the case of a parameter being a closure that is then invoked within the method, e.g.:
        //      private myMethod1(Closure closure) {
        //          println closure()
        //      }
        if (AstUtil.isMethodCallOnObject(call, 'this') && call.method instanceof ConstantExpression) {
            references.add(call.method.value)
        }
        super.visitMethodCallExpression(call)
    }

    @Override
    SourceUnit getSourceUnit() {
        throw new UnsupportedOperationException()
    }
}