CodeNarc Report: Sample Project

Report timestamp: May 10, 2010 10:04:27 PM

Summary by Package

Package	Total Files	Files with Violations	Priority 2	Priority 3
All Packages	7	4	11	5
org/codenarc/sample/domain	2	1	3	3
org/codenarc/sample/other	1	0	0	0
org/codenarc/sample/service	4	3	8	2

org/codenarc/sample/domain

org/codenarc/sample/domain/SampleDomain.groovy

Rule Name	Priority	Line #	Source Line / Message
EmptyElseBlock	2	24	[SRC]else {
EmptyIfStatement	2	21	[SRC]if (name) {
StringInstantiation	2	17	[SRC]def title = new String('Sample Domain')
DuplicateImport	3	5	[SRC]import org.codenarc.sample.other.Other
ImportFromSamePackage	3	4	[SRC]import org.codenarc.sample.domain.OtherDomain
UnnecessaryGroovyImport	3	3	[SRC]import java.util.Map

org/codenarc/sample/service

org/codenarc/sample/service/NewService.groovy

Rule Name	Priority	Line #	Source Line / Message
EmptyForStatement	2	12	[SRC]for(int i=0; i < values.size(); i++) {
EmptyWhileStatement	2	18	[SRC]while (!values.empty) {

org/codenarc/sample/service/OtherService.groovy

Rule Name	Priority	Line #	Source Line / Message
EmptyFinallyBlock	2	13	[SRC]finally {
EmptyTryBlock	2	10	[SRC]try {
ReturnFromFinallyBlock	2	24	[SRC]return

org/codenarc/sample/service/SampleService.groovy

Rule Name	Priority	Line #	Source Line / Message
BooleanInstantiation	2	17	[SRC]def shouldRun = new Boolean(true)
EmptyCatchBlock	2	20	[SRC]} catch(Throwable t) {
ThrowExceptionFromFinallyBlock	2	31	[SRC]throw new Exception('bad stuff')
UnnecessaryGroovyImport	3	3	[SRC]import java.util.Map
UnusedImport	3	4	[SRC]import org.codenarc.sample.domain.SampleDomain

Rule Descriptions

#	Rule Name	Description
1	BooleanInstantiation	Use Boolean.valueOf() for variable values or Boolean.TRUE and Boolean.FALSE for constant values instead of calling the Boolean() constructor directly or calling Boolean.valueOf(true) or Boolean.valueOf(false).
2	CloneableWithoutClone	A class that implements java.lang.Cloneable should define a clone() method.
3	ConstantIfExpression	Checks for if statements with a constant value for the if expression, such as true, false, null, or a literal constant value.
4	ConstantTernaryExpression	Checks for ternary expressions with a constant value for the boolean expression, such as true, false, null, or a literal constant value.
5	DuplicateImport	Duplicate import statements are unnecessary.
6	EmptyCatchBlock	In most cases, exceptions should not be caught and ignored (swallowed).
7	EmptyElseBlock	Empty else blocks are confusing and serve no purpose.
8	EmptyFinallyBlock	Empty finally blocks are confusing and serve no purpose.
9	EmptyForStatement	Empty for statements are confusing and serve no purpose.
10	EmptyIfStatement	Empty if statements are confusing and serve no purpose.
11	EmptySwitchStatement	Empty switch statements are confusing and serve no purpose.
12	EmptySynchronizedStatement	Empty synchronized statements are confusing and serve no purpose.
13	EmptyTryBlock	Empty try blocks are confusing and serve no purpose.
14	EmptyWhileStatement	Empty while statements are confusing and serve no purpose.
15	EqualsAndHashCode	If either the boolean equals(Object) or the int hashCode() methods are overridden within a class, then both must be overridden.
16	ImportFromSamePackage	An import of a class that is within the same package is unnecessary.
17	ReturnFromFinallyBlock	Returning from a finally block is confusing and can hide the original exception.
18	StringInstantiation	Use a String literal (e.g., "...") instead of calling the corresponding String constructor (new String("..")) directly.
19	ThrowExceptionFromFinallyBlock	Throwing an exception from a finally block is confusing and can hide the original exception.
20	UnnecessaryGroovyImport	A Groovy file does not need to include an import for classes from java.lang, java.util, java.io, java.net, groovy.lang and groovy.util, as well as the classes java.math.BigDecimal and java.math.BigInteger.
21	UnnecessaryTernaryExpression	Checks for ternary expressions where the conditional expression always evaluates to a boolean and the true and false expressions are merely returning true and false constants. Also checks for ternary expressions where both expressions are the same constant or variable.
22	UnusedImport	Imports for a class that is never referenced within the source file is unnecessary.

CodeNarc v0.9