-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
CyclomaticComplexityRule.java
128 lines (97 loc) · 4.91 KB
/
CyclomaticComplexityRule.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
/**
* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
*/
package net.sourceforge.pmd.lang.java.rule.design;
import static net.sourceforge.pmd.properties.NumericConstraints.positive;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import net.sourceforge.pmd.lang.java.ast.ASTConstructorDeclaration;
import net.sourceforge.pmd.lang.java.ast.ASTExecutableDeclaration;
import net.sourceforge.pmd.lang.java.ast.ASTMethodDeclaration;
import net.sourceforge.pmd.lang.java.ast.ASTTypeDeclaration;
import net.sourceforge.pmd.lang.java.ast.JavaNode;
import net.sourceforge.pmd.lang.java.ast.internal.PrettyPrintingUtil;
import net.sourceforge.pmd.lang.java.metrics.JavaMetrics;
import net.sourceforge.pmd.lang.java.metrics.JavaMetrics.CycloOption;
import net.sourceforge.pmd.lang.java.rule.AbstractJavaRulechainRule;
import net.sourceforge.pmd.lang.metrics.MetricOptions;
import net.sourceforge.pmd.lang.metrics.MetricsUtil;
import net.sourceforge.pmd.properties.PropertyDescriptor;
import net.sourceforge.pmd.properties.PropertyFactory;
/**
* Cyclomatic complexity rule using metrics.
*
* @author Clément Fournier, based on work by Alan Hohn and Donald A. Leckie
* @version 6.0.0
*/
public class CyclomaticComplexityRule extends AbstractJavaRulechainRule {
private static final PropertyDescriptor<Integer> CLASS_LEVEL_DESCRIPTOR
= PropertyFactory.intProperty("classReportLevel")
.desc("Total class complexity reporting threshold")
.require(positive()).defaultValue(80).build();
private static final PropertyDescriptor<Integer> METHOD_LEVEL_DESCRIPTOR
= PropertyFactory.intProperty("methodReportLevel")
.desc("Cyclomatic complexity reporting threshold")
.require(positive()).defaultValue(10).build();
private static final Map<String, CycloOption> OPTION_MAP;
static {
OPTION_MAP = new HashMap<>();
OPTION_MAP.put(CycloOption.IGNORE_BOOLEAN_PATHS.valueName(), CycloOption.IGNORE_BOOLEAN_PATHS);
OPTION_MAP.put(CycloOption.CONSIDER_ASSERT.valueName(), CycloOption.CONSIDER_ASSERT);
}
private static final PropertyDescriptor<List<CycloOption>> CYCLO_OPTIONS_DESCRIPTOR
= PropertyFactory.enumListProperty("cycloOptions", OPTION_MAP)
.desc("Choose options for the computation of Cyclo")
.emptyDefaultValue()
.build();
public CyclomaticComplexityRule() {
super(ASTExecutableDeclaration.class, ASTTypeDeclaration.class);
definePropertyDescriptor(CLASS_LEVEL_DESCRIPTOR);
definePropertyDescriptor(METHOD_LEVEL_DESCRIPTOR);
definePropertyDescriptor(CYCLO_OPTIONS_DESCRIPTOR);
}
@Override
public Object visitJavaNode(JavaNode node, Object param) {
if (node instanceof ASTTypeDeclaration) {
visitTypeDecl((ASTTypeDeclaration) node, param);
}
return null;
}
public Object visitTypeDecl(ASTTypeDeclaration node, Object data) {
MetricOptions cycloOptions = MetricOptions.ofOptions(getProperty(CYCLO_OPTIONS_DESCRIPTOR));
if (JavaMetrics.WEIGHED_METHOD_COUNT.supports(node)) {
int classWmc = MetricsUtil.computeMetric(JavaMetrics.WEIGHED_METHOD_COUNT, node, cycloOptions);
if (classWmc >= getProperty(CLASS_LEVEL_DESCRIPTOR)) {
int classHighest = (int) MetricsUtil.computeStatistics(JavaMetrics.CYCLO, node.getOperations(), cycloOptions).getMax();
String[] messageParams = {PrettyPrintingUtil.getPrintableNodeKind(node),
node.getSimpleName(),
" total",
classWmc + " (highest " + classHighest + ")", };
asCtx(data).addViolation(node, (Object[]) messageParams);
}
}
return data;
}
@Override
public final Object visit(ASTMethodDeclaration node, Object data) {
visitMethodLike(node, data);
return data;
}
@Override
public final Object visit(ASTConstructorDeclaration node, Object data) {
visitMethodLike(node, data);
return data;
}
private void visitMethodLike(ASTExecutableDeclaration node, Object data) {
MetricOptions cycloOptions = MetricOptions.ofOptions(getProperty(CYCLO_OPTIONS_DESCRIPTOR));
if (JavaMetrics.CYCLO.supports(node)) {
int cyclo = MetricsUtil.computeMetric(JavaMetrics.CYCLO, node, cycloOptions);
if (cyclo >= getProperty(METHOD_LEVEL_DESCRIPTOR)) {
String opname = PrettyPrintingUtil.displaySignature(node);
String kindname = node instanceof ASTConstructorDeclaration ? "constructor" : "method";
asCtx(data).addViolation(node, kindname, opname, "", "" + cyclo);
}
}
}
}