TouchInstinct
/
checkstyle
306
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix for issues #31 and #33

This commit is contained in:
Ivan Sopov 2013-11-28 22:05:52 +02:00
parent 1116ce8c8c
commit cd7d040b4d
5 changed files with 74 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/metrics/AbstractClassCouplingCheck.java
View File

@ -18,6 +18,7 @@
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks.metrics;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Sets;
import com.puppycrawl.tools.checkstyle.api.Check;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
@ -25,6 +26,7 @@ import com.puppycrawl.tools.checkstyle.api.FastStack;
import com.puppycrawl.tools.checkstyle.api.FullIdent;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.checks.CheckUtils;
import java.util.Set;
/**
@ -36,7 +38,30 @@ import java.util.Set;
public abstract class AbstractClassCouplingCheck extends Check
{
/** Class names to ignore. */
private final Set<String> mIgnoredClassNames = Sets.newHashSet();
private static final Set<String> DEFAULT_EXCLUDED_CLASSES =
ImmutableSet.<String>builder()
// primitives
.add("boolean", "byte", "char", "double", "float", "int")
.add("long", "short", "void")
// wrappers
.add("Boolean", "Byte", "Character", "Double", "Float")
.add("Integer", "Long", "Short", "Void")
// java.lang.*
.add("Object", "Class")
.add("String", "StringBuffer", "StringBuilder")
// Exceptions
.add("ArrayIndexOutOfBoundsException", "Exception")
.add("RuntimeException", "IllegalArgumentException")
.add("IllegalStateException", "IndexOutOfBoundsException")
.add("NullPointerException", "Throwable", "SecurityException")
.add("UnsupportedOperationException")
// java.util.*
.add("List", "ArrayList", "Deque", "Queue", "LinkedList")
.add("Set", "HashSet", "SortedSet", "TreeSet")
.add("Map", "HashMap", "SortedMap", "TreeMap")
.build();
/** User-configured class names to ignore. */
private Set<String> mExcludedClasses = DEFAULT_EXCLUDED_CLASSES;
/** Allowed complexity. */
private int mMax;
/** package of the file we check. */
@ -54,38 +79,6 @@ public abstract class AbstractClassCouplingCheck extends Check
protected AbstractClassCouplingCheck(int aDefaultMax)
{
setMax(aDefaultMax);
mIgnoredClassNames.add("boolean");
mIgnoredClassNames.add("byte");
mIgnoredClassNames.add("char");
mIgnoredClassNames.add("double");
mIgnoredClassNames.add("float");
mIgnoredClassNames.add("int");
mIgnoredClassNames.add("long");
mIgnoredClassNames.add("short");
mIgnoredClassNames.add("void");
mIgnoredClassNames.add("Boolean");
mIgnoredClassNames.add("Byte");
mIgnoredClassNames.add("Character");
mIgnoredClassNames.add("Double");
mIgnoredClassNames.add("Float");
mIgnoredClassNames.add("Integer");
mIgnoredClassNames.add("Long");
mIgnoredClassNames.add("Object");
mIgnoredClassNames.add("Short");
mIgnoredClassNames.add("String");
mIgnoredClassNames.add("StringBuffer");
mIgnoredClassNames.add("Void");
mIgnoredClassNames.add("ArrayIndexOutOfBoundsException");
mIgnoredClassNames.add("Exception");
mIgnoredClassNames.add("RuntimeException");
mIgnoredClassNames.add("IllegalArgumentException");
mIgnoredClassNames.add("IllegalStateException");
mIgnoredClassNames.add("IndexOutOfBoundsException");
mIgnoredClassNames.add("NullPointerException");
mIgnoredClassNames.add("Throwable");
mIgnoredClassNames.add("SecurityException");
mIgnoredClassNames.add("UnsupportedOperationException");
}
@Override
@ -109,6 +102,15 @@ public abstract class AbstractClassCouplingCheck extends Check
mMax = aMax;
}
/**
* Sets user-excluded classes to ignore.
* @param aExcludedClasses the list of classes to ignore.
*/
public final void setExcludedClasses(String[] aExcludedClasses)
{
mExcludedClasses = ImmutableSet.copyOf(aExcludedClasses);
}
@Override
public final void beginTree(DetailAST aAST)
{
@ -303,7 +305,7 @@ public abstract class AbstractClassCouplingCheck extends Check
private boolean isSignificant(String aClassName)
{
return (aClassName.length() > 0)
&& !mIgnoredClassNames.contains(aClassName)
&& !mExcludedClasses.contains(aClassName)
&& !aClassName.startsWith("java.lang.");
}
}

3
src/tests/com/puppycrawl/tools/checkstyle/checks/metrics/ClassDataAbstractionCouplingCheckTest.java
View File

@ -32,9 +32,10 @@ public class ClassDataAbstractionCouplingCheckTest extends BaseCheckTestSupport
createCheckConfig(ClassDataAbstractionCouplingCheck.class);
checkConfig.addAttribute("max", "0");
checkConfig.addAttribute("excludedClasses", "InnerClass");
String[] expected = {
"6:1: Class Data Abstraction Coupling is 4 (max allowed is 0) classes [AnotherInnerClass, HashMap, HashSet, InnerClass].",
"6:1: Class Data Abstraction Coupling is 4 (max allowed is 0) classes [AnotherInnerClass, HashMap, HashSet, int].",
"7:5: Class Data Abstraction Coupling is 1 (max allowed is 0) classes [ArrayList].",
"27:1: Class Data Abstraction Coupling is 2 (max allowed is 0) classes [HashMap, HashSet].",
};

4
src/tests/com/puppycrawl/tools/checkstyle/checks/metrics/ClassFanOutComplexityCheckTest.java
View File

@ -33,9 +33,7 @@ public class ClassFanOutComplexityCheckTest extends BaseCheckTestSupport
checkConfig.addAttribute("max", "0");
String[] expected = {
"6:1: Class Fan-Out Complexity is 7 (max allowed is 0).",
"7:5: Class Fan-Out Complexity is 2 (max allowed is 0).",
"27:1: Class Fan-Out Complexity is 4 (max allowed is 0).",
"6:1: Class Fan-Out Complexity is 3 (max allowed is 0).",
};
verify(checkConfig,

2
src/xdocs/config.xml
View File

@ -885,7 +885,7 @@
...
&lt;module name=&quot;SuppressionCommentFilter&quot;/&gt;
...
&lt;/module&gt;
&lt;/module&gt;
</source>
<p>

34
src/xdocs/config_metrics.xml
View File

@ -144,6 +144,23 @@
<td><a href="property_types.html#integer">integer</a></td>
<td><code>7</code></td>
</tr>
<tr>
<td>excludedClasses</td>
<td>User-configured class names to ignore</td>
<td><a href="property_types.html#stringSet">String Set</a></td>
<td>boolean, byte, char, double, float, int,
long, short, void, Boolean, Byte, Character, Double, Float,
Integer, Long, Short, Void,
Object, Class, String, StringBuffer, StringBuilder,
ArrayIndexOutOfBoundsException, Exception,
RuntimeException, IllegalArgumentException,
IllegalStateException, IndexOutOfBoundsException,
NullPointerException, Throwable, SecurityException,
UnsupportedOperationException,
List, ArrayList, Deque, Queue, LinkedList,
Set, HashSet, SortedSet, TreeSet,
Map, HashMap, SortedMap, TreeMap</td>
</tr>
</table>
</subsection>
@ -202,6 +219,23 @@
<td><a href="property_types.html#integer">integer</a></td>
<td><code>20</code></td>
</tr>
<tr>
<td>excludedClasses</td>
<td>User-configured class names to ignore</td>
<td><a href="property_types.html#stringSet">String Set</a></td>
<td>boolean, byte, char, double, float, int,
long, short, void, Boolean, Byte, Character, Double, Float,
Integer, Long, Short, Void,
Object, Class, String, StringBuffer, StringBuilder,
ArrayIndexOutOfBoundsException, Exception,
RuntimeException, IllegalArgumentException,
IllegalStateException, IndexOutOfBoundsException,
NullPointerException, Throwable, SecurityException,
UnsupportedOperationException,
List, ArrayList, Deque, Queue, LinkedList,
Set, HashSet, SortedSet, TreeSet,
Map, HashMap, SortedMap, TreeMap</td>
</tr>
</table>
</subsection>