org.codenarc.rule.basic.EmptyCatchBlockRule.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.basic

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

/**
 * Rule that checks for empty catch blocks
 *
 * @author Chris Mair
 */
class EmptyCatchBlockRule extends AbstractAstVisitorRule {
    String name = 'EmptyCatchBlock'
    int priority = 2
    Class astVisitorClass = EmptyCatchBlockAstVisitor
    String ignoreRegex = 'ignore|ignored'
}

class EmptyCatchBlockAstVisitor extends AbstractAstVisitor {
    @Override
    void visitCatchStatement(CatchStatement catchStatement) {
        if (isFirstVisit(catchStatement) && isExceptionIgnored(catchStatement)) {
            addViolation(catchStatement, 'The catch block is empty')
        }
        super.visitCatchStatement(catchStatement)
    }

    private boolean isExceptionIgnored(CatchStatement catchStatement) {
        AstUtil.isEmptyBlock(catchStatement.code) && !doesContainIgnoreWord(catchStatement.variable?.name)
    }

    private boolean doesContainIgnoreWord(String name) {
        name ==~ rule.ignoreRegex
    }
}