org.codenarc.rule.size.CyclomaticComplexityRule.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 2010 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.size

import org.codenarc.rule.AbstractAstVisitorRule
import org.gmetrics.metric.Metric
import org.gmetrics.metric.cyclomatic.CyclomaticComplexityMetric

/**
 * Rule that calculates the Cyclomatic Complexity for methods/classes and checks against
 * configured threshold values.
 * 
 * The maxMethodComplexity property holds the threshold value for the cyclomatic complexity
 * value for each method. If this value is non-zero, a method with a cyclomatic complexity value greater than
 * this value is considered a violation. The maxMethodComplexity property defaults to 20.
 * 

 * The maxClassAverageMethodComplexity property holds the threshold value for the average cyclomatic
 * complexity value for each class. If this value is non-zero, a class with an average cyclomatic complexity
 * value greater than this value is considered a violation. The maxClassAverageMethodComplexity property
 * defaults to 20.
 * 

 * The maxClassComplexity property holds the threshold value for the total cyclomatic
 * complexity value for each class. If this value is non-zero, a class with a total cyclomatic complexity
 * value greater than this value is considered a violation. The maxClassComplexity property
 * defaults to 0.
 * 

 * The ignoreMethodNames property optionally specifies one or more (comma-separated) method
 * names that should be ignored (i.e., that should not cause a rule violation). The name(s) may optionally
 * include wildcard characters ('*' or '?'). Note that the ignored methods still contribute to the class
 * complexity value.
 * 
 * This rule treats "closure fields" as methods. If a class field is initialized to a Closure (ClosureExpression),
 * then that Closure is analyzed and checked just like a method.
 *
 * @see Cyclomatic Complexity Wikipedia entry.
 * @see The original paper describing Cyclomatic Complexity.
 * @see GMetrics Cyclomatic Complexity metric.
 *
 * @author Chris Mair
  */
class CyclomaticComplexityRule extends AbstractAstVisitorRule {
    String name = 'CyclomaticComplexity'
    int priority = 2
    Class astVisitorClass = CyclomaticComplexityAstVisitor
    int maxMethodComplexity = 20
    int maxClassComplexity = 0
    int maxClassAverageMethodComplexity = 20
    String ignoreMethodNames
}

class CyclomaticComplexityAstVisitor extends AbstractMethodMetricAstVisitor  {

    final String metricShortDescription = 'cyclomatic complexity'

    @Override
    protected Metric createMetric() {
        new CyclomaticComplexityMetric()
    }

    @Override
    protected Object getMaxMethodMetricValue() {
        rule.maxMethodComplexity
    }

    @Override
    protected Object getMaxClassAverageMethodMetricValue() {
        rule.maxClassAverageMethodComplexity
    }

    @Override
    protected Object getMaxClassMetricValue() {
        rule.maxClassComplexity
    }
}