org.codenarc.rule.basic.RemoveAllOnSelfRule.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
Show all versions of CodeNarc Show documentation
The CodeNarc project provides a static analysis tool for Groovy code.
/*
* 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.basic
import org.codehaus.groovy.ast.expr.MethodCallExpression
import org.codehaus.groovy.ast.expr.TupleExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractMethodCallExpressionVisitor
/**
* This rule catches calling the method removeAll with yourself as a parameter.
*
* @author Hamlet D'Arcy
*/
class RemoveAllOnSelfRule extends AbstractAstVisitorRule {
String name = 'RemoveAllOnSelf'
int priority = 2
Class astVisitorClass = RemoveAllOnSelfAstVisitor
}
class RemoveAllOnSelfAstVisitor extends AbstractMethodCallExpressionVisitor {
@Override
void visitMethodCallExpression(MethodCallExpression call) {
if (isMethodNamed(call, 'removeAll') && getArity(call) == 1) {
String variableName = call.objectExpression.text
def argumentName = call.arguments.expressions[0].text
if (argumentName == variableName) {
addViolation call, "A call to $call.text can be replaced with ${call.objectExpression.text}.clear()"
}
}
}
private static boolean isMethodNamed(MethodCallExpression call, String target) {
call?.method?.text == target
}
private static int getArity(MethodCallExpression call) {
if (call?.arguments instanceof TupleExpression) {
return call?.arguments?.expressions?.size()
}
0
}
}